Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
thed636 committed Sep 19, 2018
1 parent 76d29d2 commit 6cebfa9
Show file tree
Hide file tree
Showing 7 changed files with 131 additions and 93 deletions.
2 changes: 1 addition & 1 deletion Doxyfile
Original file line number Diff line number Diff line change
Expand Up @@ -653,7 +653,7 @@ MAX_INITIALIZER_LINES = 30
# list will mention the files that were used to generate the documentation.
# The default value is: YES.

SHOW_USED_FILES = YES
SHOW_USED_FILES = NO

# Set the SHOW_FILES tag to NO to disable the generation of the Files page. This
# will remove the Files entry from the Quick Index and from the Folder Tree View
Expand Down
76 changes: 31 additions & 45 deletions customdoxygen.css
Original file line number Diff line number Diff line change
Expand Up @@ -58,7 +58,11 @@ h2 {
font-weight: normal;
margin: 42px 0px 20px 0px;
}

/*
h3 {
font-family: "Courier New", courier, monospace;
}
*/
h1.glow, h2.glow, h3.glow, h4.glow, h5.glow, h6.glow {
text-shadow: 0 0 15px cyan;
}
Expand Down Expand Up @@ -195,7 +199,9 @@ pre.fragment {

div.fragment {
padding: 6px 10px;
margin: 15px 0px 15px 30px;
/*margin: 15px 0px 15px 30px;*/
margin-top: 15px;
margin-bottom: 15px;
border: solid 1px rgb(221, 221, 221);
border-radius: 3px;
width: fit-content;
Expand Down Expand Up @@ -554,23 +560,35 @@ table.memberdecls {
padding: 2px;
}

.memtitle {
font-size: 0%;
padding: 0;
/*padding-top: 5px;
padding-bottom: 5px;
margin-right: 5px;*/
width: 100%;
background-image: none;
display: none;
}

.mempage {
width: 100%;
}

.memitem {
padding: 0;
margin-bottom: 10px;
margin-right: 5px;
/*margin-right: 5px;*/
-webkit-transition: box-shadow 0.5s linear;
-moz-transition: box-shadow 0.5s linear;
-ms-transition: box-shadow 0.5s linear;
-o-transition: box-shadow 0.5s linear;
transition: box-shadow 0.5s linear;
display: table !important;
width: 100%;
box-shadow: 0 0 15px silver;
border: 1px solid silver
/* box-shadow: 0 0 15px silver;
border: 1px solid silver; */
border-bottom: 1px solid silver;
}

.memitem.glow {
Expand All @@ -593,41 +611,27 @@ table.memberdecls {

.memproto, dl.reflist dt {
margin-top: 1.5em;
border-top: none;
/* border-top: none;
border-left: none;
border-right: none;
border-bottom: 1px solid rgb(172, 172, 172);
border-bottom: 1px solid rgb(172, 172, 172);*/
border: solid 1px rgb(221, 221, 221);
background-color: rgb(250, 250, 250);
padding: 2px;
color: black;
//font-family: Courier, Consolas, monospace;
font-weight: bold;
//text-shadow: 0px 1px 1px rgba(255, 255, 255, 0.9);
//text-shadow: 0px 1px 1px rgba(0, 0, 0, 0.3);
text-shadow: none;
//background-image:url('nav_f.png');
background-image: none;
//background-repeat:repeat-x;
//background-color: #E2E8F2;
//background-color: rgb(235, 238, 241);
//background-color: #ccc;
background-color: white;
/*background-color: white;*/
/* opera specific markup */
box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
//border-top-right-radius: 4px;
//border-top-left-radius: 4px;
border-top-right-radius: 0px;
border-top-left-radius: 0px;
/* firefox specific markup */
//-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
//-moz-border-radius-topright: 4px;
//-moz-border-radius-topleft: 4px;
-moz-box-shadow: none;
-moz-border-radius-topright: 0px;
-moz-border-radius-topleft: 0px;
/* webkit specific markup */
//-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
//-webkit-border-top-right-radius: 4px;
//-webkit-border-top-left-radius: 4px;
-webkit-box-shadow: none;
-webkit-border-top-right-radius: 0px;
-webkit-border-top-left-radius: 0px;
Expand All @@ -636,35 +640,17 @@ table.memberdecls {

.memdoc, dl.reflist dd {
border: none;
//border-bottom: 1px solid #A8B8D9;
//border-left: 1px solid #A8B8D9;
//border-right: 1px solid #A8B8D9;
font-weight: normal;
padding: 6px;
background-color: #FBFCFD;
border-top-width: 0;
//background-image:url('nav_g.png');
background-image: none;
//background-repeat:repeat-x;
padding: 6px;
padding-left: 24px;
background-image: none;
background-color: #FFFFFF;
/* opera specific markup */
//border-bottom-left-radius: 4px;
//border-bottom-right-radius: 4px;
//box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
border-bottom-left-radius: 0px;
border-bottom-right-radius: 0px;
box-shadow: none;
/* firefox specific markup */
//-moz-border-radius-bottomleft: 4px;
//-moz-border-radius-bottomright: 4px;
//-moz-box-shadow: rgba(0, 0, 0, 0.15) 5px 5px 5px;
-moz-border-radius-bottomleft: 0px;
-moz-border-radius-bottomright: 0px;
-moz-box-shadow: none;
/* webkit specific markup */
//-webkit-border-bottom-left-radius: 4px;
//-webkit-border-bottom-right-radius: 4px;
//-webkit-box-shadow: 5px 5px 5px rgba(0, 0, 0, 0.15);
-webkit-border-bottom-left-radius: 0px;
-webkit-border-bottom-right-radius: 0px;
-webkit-box-shadow: none;
Expand Down
2 changes: 1 addition & 1 deletion include/ozo/detail/strong_typedef.h
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ constexpr auto StrongTypedef = is_strong_typedef<std::decay_t<T>>::value;

/**
* @brief Strong typedef
* @ingroup group-type_system
* @ingroup group-core-types
*
* C++ `typedef` creates only an alias to a base type, so the both types are the same.
* To get a really new type it is necessary to make some boilerplate code.
Expand Down
24 changes: 12 additions & 12 deletions include/ozo/error.h
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
#include <boost/system/system_error.hpp>

/**
* @defgroup error-codes Error codes
* @defgroup group-errors Errors system
* @brief Errors system and codes description
*/
namespace ozo {

/**
* @ingroup error-codes
* @ingroup group-errors
* @brief Error code representation of the library.
*
* In this library the
Expand All @@ -32,36 +32,36 @@ using error_condition = boost::system::error_condition;
using error_code = boost::system::error_code;

/**
* @ingroup error-codes
* @ingroup group-errors
* @brief Error code contaning exception of the library.
* @sa error_code , error_category, error_condition
*/
using system_error = boost::system::system_error;
/**
* @ingroup error-codes
* @ingroup group-errors
* @brief Error category representation of the library.
* @sa error_code, system_error, error_condition
*/
using error_category = boost::system::error_category;
/**
* @ingroup error-codes
* @ingroup group-errors
* @brief Error condition representation of the library.
* @sa error_code, system_error, error_category
*/
using error_condition = boost::system::error_condition;

/**
* @defgroup error-codes-errors error
* @defgroup group-errors-errors error
* @brief OZO related errors
*
* @ingroup error-codes
* @ingroup group-errors
*/
namespace error {

/**
* @brief OZO related error codes
*
* @ingroup error-codes-errors
* @ingroup group-errors-errors
*
* Enumeration of error codes provided by the OZO library. Mainly it contains errors related
* to underlying libpq functions errors, data reflection and so on. In most cases the additional context
Expand Down Expand Up @@ -89,7 +89,7 @@ enum code {

/**
* @brief OZO related errors category
* @ingroup error-codes-errors
* @ingroup group-errors-errors
*
* OZO related errors category object is used to construct error_code.
*
Expand All @@ -100,17 +100,17 @@ const error_category& category() noexcept;
} // namespace error

/**
* @defgroup error-codes-sqlstate sqlstate
* @defgroup group-errors-sqlstate sqlstate
* @brief SQL state related errors and conditions
*
* @ingroup error-codes
* @ingroup group-errors
*/
namespace sqlstate {

/**
* @brief SQL state error conditions
*
* @ingroup error-codes-sqlstate
* @ingroup group-errors-sqlstate
*
* This is a set of error conditions. It may not be complete, since new versions
* of PostgreSQL may add another sql state codes and users may create new ones inside
Expand Down
6 changes: 3 additions & 3 deletions include/ozo/ozo.h
Original file line number Diff line number Diff line change
Expand Up @@ -6,19 +6,19 @@
*/

/**
* @defgroup group-core-functions Utility functions
* @defgroup group-core-functions Functions
* @ingroup group-core
* @brief Core utility functions of the library.
*/

/**
* @defgroup group-core-types Utility types
* @defgroup group-core-types Types
* @ingroup group-core
* @brief Core utility types of the library.
*/

/**
* @defgroup group-requests Requests
* @defgroup group-requests Database requests
* @brief Database requests related concepts, types and functions.
*/

Expand Down
9 changes: 1 addition & 8 deletions include/ozo/time_traits.h
Original file line number Diff line number Diff line change
Expand Up @@ -2,18 +2,11 @@

#include <chrono>

/**
* @defgroup group-core-time Time
* @ingroup group-core
* @brief Database related type system of the library.
*/
namespace ozo {

/**
* @brief Time traits of the library
*
* The structure containts time related types traits.
* @ingroup group-core-time
* @ingroup group-core-types
*/
struct time_traits {
using duration = std::chrono::steady_clock::duration; //!< Time duration type of the library
Expand Down
Loading

0 comments on commit 6cebfa9

Please sign in to comment.