Skip to content

Commit

Permalink
doc: make items _like_this_ use <code>.
Browse files Browse the repository at this point in the history
  • Loading branch information
Christian Hergert committed May 29, 2014
1 parent 4703a52 commit 632c1a0
Show file tree
Hide file tree
Showing 40 changed files with 47 additions and 47 deletions.
2 changes: 1 addition & 1 deletion doc/bson_append_binary.page
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,7 @@ bson_append_binary (bson_t *bson,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_append_binary">bson_append_binary()</link> function shall append a new element to _bson_ containing the binary data provided.</p>
<p>The <link xref="bson_append_binary">bson_append_binary()</link> function shall append a new element to <code>bson</code> containing the binary data provided.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_append_bool.page
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ bson_append_bool (bson_t *bson,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_append_binary">bson_append_binary()</link> function shall append a new element to _bson_ containing the binary data provided.</p>
<p>The <link xref="bson_append_binary">bson_append_binary()</link> function shall append a new element to <code>bson</code> containing the binary data provided.</p>
</section>

<section id="return">
Expand Down
4 changes: 2 additions & 2 deletions doc/bson_append_code.page
Original file line number Diff line number Diff line change
Expand Up @@ -25,14 +25,14 @@ bson_append_code (bson_t *bson,
<table>
<tr><td><p>bson</p></td><td><p>A <link xref="bson_t">bson_t</link>.</p></td></tr>
<tr><td><p>key</p></td><td><p>The key name.</p></td></tr>
<tr><td><p>key_length</p></td><td><p>The length of _key_ or -1 to use strlen().</p></td></tr>
<tr><td><p>key_length</p></td><td><p>The length of <code>key</code> or -1 to use strlen().</p></td></tr>
<tr><td><p>javascript</p></td><td><p>A UTF-8 encoded string containing the javascript.</p></td></tr>
</table>
</section>

<section id="description">
<title>Description</title>
<p>The <link xref="bson_append_code">bson_append_code()</link> function shall append a new element to _bson_ using the UTF-8 encoded _javascript_ provided. _javascript_ must be a NULL terminated C string.</p>
<p>The <link xref="bson_append_code">bson_append_code()</link> function shall append a new element to <code>bson</code> using the UTF-8 encoded <code>javascript</code> provided. <code>javascript</code> must be a NULL terminated C string.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_append_date_time.page
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ bson_append_date_time (bson_t *bson,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_append_date_time">bson_append_date_time()</link> function shall append a new element to a _bson_ document containing a date and time with no timezone information. _value_ is assumed to be in UTC format of milliseconds since the UNIX epoch. _value_ <em>MAY</em> be negative.</p>
<p>The <link xref="bson_append_date_time">bson_append_date_time()</link> function shall append a new element to a <code>bson</code> document containing a date and time with no timezone information. <code>value</code> is assumed to be in UTC format of milliseconds since the UNIX epoch. <code>value</code> <em>MAY</em> be negative.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_append_double.page
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ bson_append_double (bson_t *bson,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_append_double">bson_append_double()</link> function shall append a new element to a bson document of type _double_.</p>
<p>The <link xref="bson_append_double">bson_append_double()</link> function shall append a new element to a bson document of type <code>double</code>.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_append_int32.page
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ bson_append_int32 (bson_t *bson,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_append_int32">bson_append_int32()</link> function shall append a new element to _bson_ containing a 32-bit signed integer.</p>
<p>The <link xref="bson_append_int32">bson_append_int32()</link> function shall append a new element to <code>bson</code> containing a 32-bit signed integer.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_append_int64.page
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ bson_append_int64 (bson_t *bson,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_append_int64">bson_append_int64()</link> function shall append a new element to _bson_ containing a 64-bit signed integer.</p>
<p>The <link xref="bson_append_int64">bson_append_int64()</link> function shall append a new element to <code>bson</code> containing a 64-bit signed integer.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_append_now_utc.page
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ bson_append_now_utc (bson_t *bson,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_append_now_utc">bson_append_now_utc()</link> function is a helper to get the current date and time in UTC and append it to _bson_ as a BSON_TYPE_DATE_TIME element.</p>
<p>The <link xref="bson_append_now_utc">bson_append_now_utc()</link> function is a helper to get the current date and time in UTC and append it to <code>bson</code> as a BSON_TYPE_DATE_TIME element.</p>
<p>This function calls <link xref="bson_append_date_time">bson_append_date_time()</link> internally.</p>
</section>

Expand Down
2 changes: 1 addition & 1 deletion doc/bson_append_null.page
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ bson_append_null (bson_t *bson,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_append_null">bson_append_null()</link> function shall append a new element to _bson_ of type BSON_TYPE_NULL.</p>
<p>The <link xref="bson_append_null">bson_append_null()</link> function shall append a new element to <code>bson</code> of type BSON_TYPE_NULL.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_append_oid.page
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ bson_append_oid (bson_t *bson,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_append_oid">bson_append_oid()</link> function shall append a new element to _bson_ of type BSON_TYPE_OID. _oid_ *MUST* be a pointer to a <link xref="bson_oid_t">bson_oid_t</link>.</p>
<p>The <link xref="bson_append_oid">bson_append_oid()</link> function shall append a new element to <code>bson</code> of type BSON_TYPE_OID. <code>oid</code> *MUST* be a pointer to a <link xref="bson_oid_t">bson_oid_t</link>.</p>
</section>

<section id="return">
Expand Down
4 changes: 2 additions & 2 deletions doc/bson_append_regex.page
Original file line number Diff line number Diff line change
Expand Up @@ -34,9 +34,9 @@ bson_append_regex (bson_t *bson,

<section id="description">
<title>Description</title>
<p>Appends a new field to _bson_ of type BSON_TYPE_REGEX. _regex_ should be the regex string. _options_ should contain the options for the regex.</p>
<p>Appends a new field to <code>bson</code> of type BSON_TYPE_REGEX. <code>regex</code> should be the regex string. <code>options</code> should contain the options for the regex.</p>

<p>Valid characters for _options_ include:</p>
<p>Valid characters for <code>options</code> include:</p>

<list>
<item><p><code>'i'</code> for case-insensitive.</p></item>
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_append_symbol.page
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ bson_append_symbol (bson_t *bson,

<section id="description">
<title>Description</title>
<p>Appends a new field to _bson_ of type BSON_TYPE_SYMBOL. This BSON type is deprecated and should not be used in new code.</p>
<p>Appends a new field to <code>bson</code> of type BSON_TYPE_SYMBOL. This BSON type is deprecated and should not be used in new code.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_append_time_t.page
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ bson_append_time_t (bson_t *bson,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_append_time_t">bson_append_time_t()</link> function is a helper that takes a _time_t_ instead of milliseconds since the UNIX epoch.</p>
<p>The <link xref="bson_append_time_t">bson_append_time_t()</link> function is a helper that takes a <code>time_t</code> instead of milliseconds since the UNIX epoch.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_append_undefined.page
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ bson_append_undefined (bson_t *bson,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_append_undefined">bson_append_undefined()</link> function shall append a new element to _bson_ of type BSON_TYPE_UNDEFINED. Undefined is common in Javascript. However, this element type is deprecated and should not be used in new code.</p>
<p>The <link xref="bson_append_undefined">bson_append_undefined()</link> function shall append a new element to <code>bson</code> of type BSON_TYPE_UNDEFINED. Undefined is common in Javascript. However, this element type is deprecated and should not be used in new code.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_append_utf8.page
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ bson_append_utf8 (bson_t *bson,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_append_utf8">bson_append_utf8()</link> function shall append a UTF-8 encoded string to _bson_.</p>
<p>The <link xref="bson_append_utf8">bson_append_utf8()</link> function shall append a UTF-8 encoded string to <code>bson</code>.</p>
<p>_value_ *MUST* be valid UTF-8.</p>
<p>Some UTF-8 implementations allow for <code>\0</code> to be contained within the string (excluding the termination <code>\0</code>. This is allowed, but remember that it could cause issues with communicating with external systems that do not support it.</p>
<p>It is suggested to use modified UTF-8 which uses a 2 byte representation for embedded <code>\0</code> within the string. This will allow these UTF-8 encoded strings to used with many libc functions.</p>
Expand Down
4 changes: 2 additions & 2 deletions doc/bson_as_json.page
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@ bson_as_json (const bson_t *bson,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_as_json">bson_as_json()</link> function shall encode _bson_ as a JSON encoded UTF-8 string.</p>
<p>The <link xref="bson_as_json">bson_as_json()</link> function shall encode <code>bson</code> as a JSON encoded UTF-8 string.</p>
<p>The caller is responsible for freeing the resulting UTF-8 encoded string by calling <link xref="bson_free">bson_free()</link> with the result.</p>
<p>If non-NULL, _length_ will be set to the length of the result in bytes.</p>
<p>If non-NULL, <code>length</code> will be set to the length of the result in bytes.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_concat.page
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ bson_concat (bson_t *dst,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_concat">bson_concat()</link> function shall append the contents of _src_ to _dst_.</p>
<p>The <link xref="bson_concat">bson_concat()</link> function shall append the contents of <code>src</code> to <code>dst</code>.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_copy_to.page
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ bson_copy_to (const bson_t *src,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_copy_to">bson_copy_to()</link> function shall initialize _dst_ with a copy of the contents of _src_.</p>
<p>The <link xref="bson_copy_to">bson_copy_to()</link> function shall initialize <code>dst</code> with a copy of the contents of <code>src</code>.</p>
<p>_dst_ *MUST* be an uninitialized <link xref="bson_t">bson_t</link> to avoid leaking memory.</p>
</section>

Expand Down
2 changes: 1 addition & 1 deletion doc/bson_copy_to_excluding.page
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@ bson_copy_to_excluding (const bson_t *src,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_copy_to_excluding">bson_copy_to_excluding()</link> function shall copy all fields from _src_ to _dst_ except those speified by the variadic, NULL terminated list of keys starting from _first_exclude_.</p>
<p>The <link xref="bson_copy_to_excluding">bson_copy_to_excluding()</link> function shall copy all fields from <code>src</code> to <code>dst</code> except those speified by the variadic, NULL terminated list of keys starting from <code>first_exclude</code>.</p>
<note style="warning"><p>This is generally not needed except in very special situations.</p></note>
</section>

Expand Down
2 changes: 1 addition & 1 deletion doc/bson_count_keys.page
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ bson_count_keys (const bson_t *bson);

<section id="description">
<title>Description</title>
<p>The <link xref="bson_count_keys">bson_count_keys()</link> function shall count the number of elements within _bson_.</p>
<p>The <link xref="bson_count_keys">bson_count_keys()</link> function shall count the number of elements within <code>bson</code>.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_destroy_with_steal.page
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,6 @@ bson_destroy_with_steal (bson_t *bson,

<section id="return">
<title>Returns</title>
<p><link xref="bson_destroy_with_steal">bson_destroy_with_steal()</link> shall return a buffer containing the contents of the <link xref="bson_t">bson_t</link> if _steal_ is non-zero. This should be freed with <link xref="bson_free">bson_free()</link> when no longer in use. _length_ will be set to the length of the bson document if non-NULL.</p>
<p><link xref="bson_destroy_with_steal">bson_destroy_with_steal()</link> shall return a buffer containing the contents of the <link xref="bson_t">bson_t</link> if <code>steal</code> is non-zero. This should be freed with <link xref="bson_free">bson_free()</link> when no longer in use. <code>length</code> will be set to the length of the bson document if non-NULL.</p>
</section>
</page>
2 changes: 1 addition & 1 deletion doc/bson_get_data.page
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ bson_get_data (const bson_t *bson);

<section id="description">
<title>Description</title>
<p>The <link xref="bson_get_data">bson_get_data()</link> function shall return the raw buffer of a bson document. This can be used in conjunction with the _len_ property of a <link xref="bson_t">bson_t</link> if you want to copy the raw buffer around.</p>
<p>The <link xref="bson_get_data">bson_get_data()</link> function shall return the raw buffer of a bson document. This can be used in conjunction with the <code>len</code> property of a <link xref="bson_t">bson_t</link> if you want to copy the raw buffer around.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_init.page
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ bson_init (bson_t *b);

<section id="description">
<title>Description</title>
<p>The <link xref="bson_init">bson_init()</link> function shall initialize a <link xref="bson_t">bson_t</link> that is placed on the stack. This is equivalent to initializing a <link xref="bson_t">bson_t</link> to _BSON_INITIALIZER_.</p>
<p>The <link xref="bson_init">bson_init()</link> function shall initialize a <link xref="bson_t">bson_t</link> that is placed on the stack. This is equivalent to initializing a <link xref="bson_t">bson_t</link> to <code>BSON_INITIALIZER</code>.</p>
</section>

</page>
2 changes: 1 addition & 1 deletion doc/bson_init_static.page
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ bson_init_static (bson_t *b,

<section id="return">
<title>Returns</title>
<p><link xref="bson_init_static">bson_init_static()</link> will return _true_ if the <link xref="bson_t">bson_t</link> was successfully initialized.</p>
<p><link xref="bson_init_static">bson_init_static()</link> will return <code>true</code> if the <link xref="bson_t">bson_t</link> was successfully initialized.</p>
</section>

</page>
2 changes: 1 addition & 1 deletion doc/bson_iter_overwrite_double.page
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ bson_iter_overwrite_double (bson_iter_t *iter,
<title>Description</title>
<p>The <link xref="bson_iter_overwrite_double">bson_iter_overwrite_double()</link> function shall overwrite the contents of a BSON_TYPE_DOUBLE element in place.</p>
<p>This may only be done when the underlying bson document allows mutation.</p>
<p>It is a programming error to call this function when _iter_ is not obvserving an element of type BSON_TYPE_DOUBLE.</p>
<p>It is a programming error to call this function when <code>iter</code> is not obvserving an element of type BSON_TYPE_DOUBLE.</p>
</section>

</page>
2 changes: 1 addition & 1 deletion doc/bson_iter_overwrite_int32.page
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ bson_iter_overwrite_int32 (bson_iter_t *iter,
<title>Description</title>
<p>The <link xref="bson_iter_overwrite_int32">bson_iter_overwrite_int32()</link> function shall overwrite the contents of a BSON_TYPE_INT32 element in place.</p>
<p>This may only be done when the underlying bson document allows mutation.</p>
<p>It is a programming error to call this function when _iter_ is not obvserving an element of type BSON_TYPE_BOOL.</p>
<p>It is a programming error to call this function when <code>iter</code> is not obvserving an element of type BSON_TYPE_BOOL.</p>
</section>

</page>
2 changes: 1 addition & 1 deletion doc/bson_iter_overwrite_int64.page
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ bson_iter_overwrite_int64 (bson_iter_t *iter,
<title>Description</title>
<p>The <link xref="bson_iter_overwrite_int64">bson_iter_overwrite_int64()</link> function shall overwite the contents of a BSON_TYPE_INT64 element in place.</p>
<p>This may only be done when the underlying bson document allows mutation.</p>
<p>It is a programming error to call this function when _iter_ is not obvserving an element of type BSON_TYPE_INT64.</p>
<p>It is a programming error to call this function when <code>iter</code> is not obvserving an element of type BSON_TYPE_INT64.</p>
</section>

</page>
6 changes: 3 additions & 3 deletions doc/bson_iter_recurse.page
Original file line number Diff line number Diff line change
Expand Up @@ -28,13 +28,13 @@ bson_iter_recurse (const bson_iter_t *iter,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_iter_recurse">bson_iter_recurse()</link> function shall initialize _child_ using the embedded document or array currently observed by _iter_.</p>
<p>If there was a failure to initialize the _iter_, false is returned and both _iter_ and _child_ should be considered invalid.</p>
<p>The <link xref="bson_iter_recurse">bson_iter_recurse()</link> function shall initialize <code>child</code> using the embedded document or array currently observed by <code>iter</code>.</p>
<p>If there was a failure to initialize the <code>iter</code>, false is returned and both <code>iter</code> and <code>child</code> should be considered invalid.</p>
<p>This should only be called when observing an element of type BSON_TYPE_ARRAY or BSON_TYPE_DOCUMENT.</p>
</section>

<section id="return">
<title>Returns</title>
<p>true if _child_ has been intialized. Otherwise, both _child_ and _iter_ should be considered invalid.</p>
<p>true if <code>child</code> has been intialized. Otherwise, both <code>child</code> and <code>iter</code> should be considered invalid.</p>
</section>
</page>
4 changes: 2 additions & 2 deletions doc/bson_iter_regex.page
Original file line number Diff line number Diff line change
Expand Up @@ -28,12 +28,12 @@ bson_iter_regex (const bson_iter_t *iter,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_iter_regex">bson_iter_regex()</link> function shall retrieve the contents of a BSON_TYPE_REGEX element currently observed by _iter_.</p>
<p>The <link xref="bson_iter_regex">bson_iter_regex()</link> function shall retrieve the contents of a BSON_TYPE_REGEX element currently observed by <code>iter</code>.</p>
<p>It is invalid to call this function when not observing an element of type BSON_TYPE_REGEX.</p>
</section>

<section id="return">
<title>Returns</title>
<p>A string containing the regex which should not be modified or freed. _options_ is set to the options provided for the regex.</p>
<p>A string containing the regex which should not be modified or freed. <code>options</code> is set to the options provided for the regex.</p>
</section>
</page>
2 changes: 1 addition & 1 deletion doc/bson_iter_symbol.page
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@ bson_iter_symbol (const bson_iter_t *iter,
<title>Description</title>
<p>The symbol element type is *deprecated* in the bson specification at http://bsonspec.org.</p>
<p>The <link xref="bson_iter_symbol">bson_iter_symbol()</link> function shall return the contents of a BSON_TYPE_SYMBOL element.</p>
<p>if non-NULL, _length_ will be set to the length of the resulting string.</p>
<p>if non-NULL, <code>length</code> will be set to the length of the resulting string.</p>
</section>

<section id="return">
Expand Down
2 changes: 1 addition & 1 deletion doc/bson_iter_timeval.page
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ bson_iter_timeval (const bson_iter_t *iter,

<section id="description">
<title>Description</title>
<p>The <link xref="bson_iter_timeval">bson_iter_timeval()</link> function shall return the number of seconds and microseconds since the UNIX epoch, as contained in the BSON_TYPE_DATE_TIME element into _tv_.</p>
<p>The <link xref="bson_iter_timeval">bson_iter_timeval()</link> function shall return the number of seconds and microseconds since the UNIX epoch, as contained in the BSON_TYPE_DATE_TIME element into <code>tv</code>.</p>
</section>

</page>
Loading

0 comments on commit 632c1a0

Please sign in to comment.