From 71068dae1e369f5cedb3b52d3b5bc4f754d100e4 Mon Sep 17 00:00:00 2001 From: David Robillard Date: Thu, 17 Mar 2011 18:57:31 +0000 Subject: Improve documentation. git-svn-id: http://svn.drobilla.net/serd/trunk@123 490d8e77-9747-427b-9fa3-0b8f29cee8a0 --- doc/reference.doxygen.in | 2 +- doc/style.css | 38 ++++++++++++++------------------ serd/serd.h | 56 +++++++++++++++++++++++++++--------------------- 3 files changed, 49 insertions(+), 47 deletions(-) diff --git a/doc/reference.doxygen.in b/doc/reference.doxygen.in index 0bdf373a..2c66ef3a 100644 --- a/doc/reference.doxygen.in +++ b/doc/reference.doxygen.in @@ -92,7 +92,7 @@ ABBREVIATE_BRIEF = # Doxygen will generate a detailed section even if there is only a brief # description. -ALWAYS_DETAILED_SEC = YES +ALWAYS_DETAILED_SEC = NO # If the INLINE_INHERITED_MEMB tag is set to YES, doxygen will show all # inherited members of a class in the documentation of that class as if those diff --git a/doc/style.css b/doc/style.css index f4d9f28d..916631b3 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/serd/serd.h b/serd/serd.h index 040054b4..c19f9f24 100644 --- a/serd/serd.h +++ b/serd/serd.h @@ -192,9 +192,14 @@ typedef enum { } SerdType; /** - @name SerdURI - @{ + A syntactic RDF node. */ +typedef struct { + SerdType type; + size_t n_bytes; /**< Size in bytes (including null) */ + size_t n_chars; /**< Length in characters */ + const uint8_t* buf; /**< Buffer */ +} SerdNode; /** An unterminated string fragment. @@ -220,6 +225,26 @@ typedef struct { SerdChunk fragment; /**< Fragment */ } SerdURI; +/** + Syntax style options. + + The style of the writer output can be controlled by ORing together + values from this enumeration. Note that some options are only supported + for some syntaxes (e.g. NTriples does not support any options except + @ref SERD_STYLE_ASCII, which is required). +*/ +typedef enum { + SERD_STYLE_ABBREVIATED = 1, /**< Abbreviate triples when possible. */ + SERD_STYLE_ASCII = 1 << 1, /**< Escape all non-ASCII characters. */ + SERD_STYLE_RESOLVED = 1 << 2, /**< Resolve relative URIs against base. */ + SERD_STYLE_CURIED = 1 << 3 /**< Shorten URIs into CURIEs. */ +} SerdStyle; + +/** + @name URI + @{ +*/ + static const SerdURI SERD_URI_NULL = {{0,0},{0,0},{0,0},{0,0},{0,0},{0,0}}; /** @@ -257,20 +282,10 @@ serd_uri_serialise(const SerdURI* uri, SerdSink sink, void* stream); /** @} - @name SerdNode + @name Node @{ */ -/** - A syntactic RDF node. -*/ -typedef struct { - SerdType type; - size_t n_bytes; /**< Size in bytes (including null) */ - size_t n_chars; /**< Length in characters */ - const uint8_t* buf; /**< Buffer */ -} SerdNode; - static const SerdNode SERD_NODE_NULL = { SERD_NOTHING, 0, 0, 0 }; /** @@ -335,7 +350,7 @@ serd_node_free(SerdNode* node); /** @} - @name Handlers + @name Event Handlers @{ */ @@ -381,7 +396,7 @@ typedef bool (*SerdEndSink)(void* handle, /** @} - @name SerdEnv + @name Environment @{ */ @@ -439,7 +454,7 @@ serd_env_foreach(const SerdEnv env, /** @} - @name SerdReader + @name Reader @{ */ @@ -545,17 +560,10 @@ serd_read_state_set_prefix(SerdReadState state, /** @} - @name SerdWriter + @name Writer @{ */ -typedef enum { - SERD_STYLE_ABBREVIATED = 1, /**< Abbreviate triples when possible. */ - SERD_STYLE_ASCII = 1 << 1, /**< Escape all non-ASCII characters. */ - SERD_STYLE_RESOLVED = 1 << 2, /**< Resolve relative URIs against base. */ - SERD_STYLE_CURIED = 1 << 3 /**< Shorten URIs into CURIEs. */ -} SerdStyle; - /** Create a new RDF writer. */ -- cgit v1.2.1