diff options
| -rw-r--r-- | doc/reference.doxygen.in | 4 | ||||
| -rw-r--r-- | doc/style.css | 38 | ||||
| -rw-r--r-- | sord/sord.h | 47 |
3 files changed, 51 insertions, 38 deletions
diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in index 9b08263..d19b413 100644 --- a/doc/reference.doxygen.in +++ b/doc/reference.doxygen.in @@ -74,7 +74,7 @@ BRIEF_MEMBER_DESC = NO # Note: if both HIDE_UNDOC_MEMBERS and BRIEF_MEMBER_DESC are set to NO, the # brief descriptions will be completely suppressed. -REPEAT_BRIEF = NO +REPEAT_BRIEF = YES # This tag implements a quasi-intelligent brief description abbreviator # that is used to form the text in various listings. Each string @@ -527,7 +527,7 @@ WARNINGS = YES # for undocumented members. If EXTRACT_ALL is set to YES then this flag will # automatically be disabled. -WARN_IF_UNDOCUMENTED = NO +WARN_IF_UNDOCUMENTED = YES # If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for # potential errors in the documentation, such as not documenting some diff --git a/doc/style.css b/doc/style.css index f4d9f28..916631b 100644 --- a/doc/style.css +++ b/doc/style.css @@ -3,39 +3,36 @@ body { font-family: sans-serif; } -.navigation { +#top { display: none; } +h1 h2 h3 h4 h5 h6 { + font-weight: bold; +} + h1 { - font-size: 180%; - font-weight: 900; + font-size: 164%; } h2 { - font-size: 140%; - font-weight: 650; + font-size: 132%; } h3 { - font-size: 130%; - font-weight: 600; - + font-size: 124%; } h4 { - font-size: 120%; - font-weight: 550; + font-size: 116%; } h5 { - font-size: 110%; - font-weight: 500; + font-size: 108%; } h6 { font-size: 100%; - font-weight: 450; } p { @@ -103,7 +100,6 @@ div.navtab { /* @group Link Styling */ a { color: #3D578C; - font-weight: 400; text-decoration: none; } @@ -116,18 +112,15 @@ a:hover { } a.qindex { - font-weight: 700; } a.qindexHL { - font-weight: 700; background-color: #9CAFD4; color: #FFF; border: 1px double #869DCA; } a.el { - font-weight: 700; } a.elRef { @@ -317,6 +310,7 @@ hr.footer { /* @group Member Descriptions */ table.memberdecls { border-spacing: 0; + font-size: 94%; } .mdescLeft,.mdescRight,.memItemLeft,.memItemRight,.memTemplItemLeft,.memTemplItemRight,.memTemplParams { @@ -349,7 +343,7 @@ table.memberdecls { .memtemplate { font-size: 80%; color: #4665A2; - font-weight: 400; + font-weight: bold; } .memnav { @@ -368,14 +362,14 @@ table.memberdecls { .memname { white-space: nowrap; - font-weight: 700; + font-weight: bold; } .memproto { border-top: 1px solid #DDD; padding: 0.5ex; color: #253555; - font-weight: 700; + font-weight: bold; background-color: #F3F3F3; } @@ -413,7 +407,7 @@ table.memberdecls { /* these are for tree view when used as main index */ .directory { font-size: 9pt; - font-weight: 700; + font-weight: bold; margin: 5px; } @@ -444,7 +438,7 @@ table.memberdecls { /* these are for tree view when not used as main index */ .directory-alt { font-size: 100%; - font-weight: 700; + font-weight: bold; } .directory-alt h3 { diff --git a/sord/sord.h b/sord/sord.h index 2e6059c..e107438 100644 --- a/sord/sord.h +++ b/sord/sord.h @@ -67,15 +67,38 @@ extern "C" { @{ */ -typedef struct _SordWorld* SordWorld; /**< Sord world (library state) */ -typedef struct _SordModel* SordModel; /**< Quad store */ -typedef struct _SordIter* SordIter; /**< Store iterator */ -typedef struct _SordNode* SordNode; /**< Node */ +/** + Sord World. + The World represents all library state, including interned strings. +*/ +typedef struct _SordWorld* SordWorld; + +/** + Sord Model. + + A model is an indexed set of Quads (i.e. it can contain several RDF + graphs). It may be searched using various patterns depending on which + indices are enabled. +*/ +typedef struct _SordModel* SordModel; + +/** + Model Iterator. +*/ +typedef struct _SordIter* SordIter; + +/** + RDF Node. + A Node is a component of a Quad. Nodes may be URIs, blank nodes, or + (in the case of quad objects only) string literals. Literal nodes may + have an associate language or datatype (but not both). +*/ +typedef struct _SordNode* SordNode; /** Quad of IDs (statement), or a quad pattern. - Nodes are ordered (S P O G). The ID of the default graph is 0. + Nodes are ordered (S P O G). The ID of the default graph is 0. */ typedef SordNode SordQuad[4]; @@ -112,15 +135,14 @@ typedef enum { /** @name World - The World represents all library state, including interned strings. It is - safe to use multiple worlds in one process, though no data (e.g. nodes) can - be shared between worlds, and this should be avoided if possible for - performance reasons. @{ */ /** Create a new Sord World. + It is safe to use multiple worlds in one process, though no data + (e.g. nodes) can be shared between worlds, and this should be avoided if + possible for performance reasons. */ SORD_API SordWorld @@ -135,10 +157,7 @@ sord_world_free(SordWorld world); /** @} - @name Nodes - A Node is a component of a Quad. Nodes may be URIs, blank nodes, or - (in the case of quad objects only) string literals. Literal nodes may - have an associate language or datatype (but not both). + @name Node @{ */ @@ -272,7 +291,7 @@ sord_node_equals(const SordNode a, @param world The world in which to make this store. - @param indices SordIndexOption flags (e.g. SORD_SPO|SORD_OPS). Be sure to + @param indices SordIndexOption flags (e.g. SORD_SPO|SORD_OPS). Be sure to enable an index where the most significant node(s) are not variables in your queries (e.g. to make (? P O) queries, enable either SORD_OPS or SORD_POS). |