format "NULL" in monospace in docs

ajdavis · ajdavis · commit a75796f25395 · 2015-05-02T10:45:07.000-04:00
diff --git a/doc/mongoc_client_get_gridfs.page b/doc/mongoc_client_get_gridfs.page
@@ -29,7 +29,7 @@ mongoc_client_get_gridfs (mongoc_client_t *client,
     <table>
       <tr><td><p>client</p></td><td><p>A <code xref="mongoc_client_t">mongoc_client_t</code>.</p></td></tr>
       <tr><td><p>db</p></td><td><p>The database name.</p></td></tr>
-      <tr><td><p>prefix</p></td><td><p>Optional prefix for gridfs collection names or NULL.</p></td></tr>
+      <tr><td><p>prefix</p></td><td><p>Optional prefix for gridfs collection names or <code>NULL</code>.</p></td></tr>
       <tr><td><p>error</p></td><td><p>An optional location for a <code xref="bson:bson_error_t">bson_error_t</code> or <code>NULL</code>.</p></td></tr>
     </table>
   </section>
diff --git a/doc/mongoc_collection_aggregate.page b/doc/mongoc_collection_aggregate.page
@@ -31,8 +31,8 @@ mongoc_collection_aggregate (mongoc_collection_t       *collection,
       <tr><td><p>collection</p></td><td><p>A <code xref="mongoc_collection_t">mongoc_collection_t</code>.</p></td></tr>
       <tr><td><p>flags</p></td><td><p>A <code xref="mongoc_query_flags_t">mongoc_query_flags_t</code>.</p></td></tr>
       <tr><td><p>pipeline</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the pipeline array.</p></td></tr>
-      <tr><td><p>options</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing options for the pipeline, or NULL.</p></td></tr>
-      <tr><td><p>read_prefs</p></td><td><p>A <code xref="mongoc_read_prefs_t">mongoc_read_prefs_t</code> or NULL.</p></td></tr>
+      <tr><td><p>options</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing options for the pipeline, or <code>NULL</code>.</p></td></tr>
+      <tr><td><p>read_prefs</p></td><td><p>A <code xref="mongoc_read_prefs_t">mongoc_read_prefs_t</code> or <code>NULL</code>.</p></td></tr>
     </table>
   </section>
 
@@ -49,7 +49,7 @@ mongoc_collection_aggregate (mongoc_collection_t       *collection,
 
   <section id="return">
     <title>Returns</title>
-    <p>This function returns a newly allocated <code xref="mongoc_cursor_t">mongoc_cursor_t</code> that should be freed with <code xref="mongoc_cursor_destroy">mongoc_cursor_destroy()</code> when no longer in use. NULL may be returned if parameters are invalid.</p>
+    <p>This function returns a newly allocated <code xref="mongoc_cursor_t">mongoc_cursor_t</code> that should be freed with <code xref="mongoc_cursor_destroy">mongoc_cursor_destroy()</code> when no longer in use. <code>NULL</code> may be returned if parameters are invalid.</p>
     <note style="warning"><p>Failure to handle the result of this function is a programming error.</p></note>
   </section>
 
diff --git a/doc/mongoc_collection_command.page b/doc/mongoc_collection_command.page
@@ -38,8 +38,8 @@ BSON_GNUC_WARN_UNUSED_RESULT;
       <tr><td><p>limit</p></td><td><p>A uint32_t with the max number of documents to return or zero.</p></td></tr>
       <tr><td><p>batch_size</p></td><td><p>A uint32_t with the number of documents in each batch or zero. Default is 100.</p></td></tr>
       <tr><td><p>command</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the command to execute.</p></td></tr>
-      <tr><td><p>fields</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the fields to return or NULL. Not all commands support this option.</p></td></tr>
-      <tr><td><p>read_prefs</p></td><td><p>A <code xref="mongoc_read_prefs_t">mongoc_read_prefs_t</code> or NULL.</p></td></tr>
+      <tr><td><p>fields</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the fields to return or <code>NULL</code>. Not all commands support this option.</p></td></tr>
+      <tr><td><p>read_prefs</p></td><td><p>A <code xref="mongoc_read_prefs_t">mongoc_read_prefs_t</code> or <code>NULL</code>.</p></td></tr>
     </table>
   </section>
 
diff --git a/doc/mongoc_collection_command_simple.page b/doc/mongoc_collection_command_simple.page
@@ -30,7 +30,7 @@ mongoc_collection_command_simple (mongoc_collection_t       *collection,
     <table>
       <tr><td><p>collection</p></td><td><p>A <code xref="mongoc_collection_t">mongoc_collection_t</code>.</p></td></tr>
       <tr><td><p>command</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the command to execute.</p></td></tr>
-      <tr><td><p>read_prefs</p></td><td><p>A <code xref="mongoc_read_prefs_t">mongoc_read_prefs_t</code> or NULL.</p></td></tr>
+      <tr><td><p>read_prefs</p></td><td><p>A <code xref="mongoc_read_prefs_t">mongoc_read_prefs_t</code> or <code>NULL</code>.</p></td></tr>
       <tr><td><p>reply</p></td><td><p>A location to initialize a <code xref="bson:bson_t">bson_t</code>. This should be on the stack.</p></td></tr>
       <tr><td><p>error</p></td><td><p>An optional location for a <code xref="bson:bson_error_t">bson_error_t</code> or <code>NULL</code>.</p></td></tr>
     </table>
diff --git a/doc/mongoc_collection_count.page b/doc/mongoc_collection_count.page
@@ -34,7 +34,7 @@ mongoc_collection_count (mongoc_collection_t       *collection,
       <tr><td><p>query</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the query.</p></td></tr>
       <tr><td><p>skip</p></td><td><p>A int64_t, zero to ignore.</p></td></tr>
       <tr><td><p>limit</p></td><td><p>A int64_t, zero to ignore.</p></td></tr>
-      <tr><td><p>read_prefs</p></td><td><p>A <code xref="mongoc_read_prefs_t">mongoc_read_prefs_t</code> or NULL.</p></td></tr>
+      <tr><td><p>read_prefs</p></td><td><p>A <code xref="mongoc_read_prefs_t">mongoc_read_prefs_t</code> or <code>NULL</code>.</p></td></tr>
       <tr><td><p>error</p></td><td><p>An optional location for a <code xref="bson:bson_error_t">bson_error_t</code> or <code>NULL</code>.</p></td></tr>
     </table>
   </section>
diff --git a/doc/mongoc_collection_count_with_opts.page b/doc/mongoc_collection_count_with_opts.page
@@ -35,8 +35,8 @@ mongoc_collection_count_with_opts (mongoc_collection_t       *collection,
       <tr><td><p>query</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the query.</p></td></tr>
       <tr><td><p>skip</p></td><td><p>A int64_t, zero to ignore.</p></td></tr>
       <tr><td><p>limit</p></td><td><p>A int64_t, zero to ignore.</p></td></tr>
-      <tr><td><p>opts</p></td><td><p>A <code xref="bson:bson_t">bson_t</code>, NULL to ignore.</p></td></tr>
-      <tr><td><p>read_prefs</p></td><td><p>A <code xref="mongoc_read_prefs_t">mongoc_read_prefs_t</code> or NULL.</p></td></tr>
+      <tr><td><p>opts</p></td><td><p>A <code xref="bson:bson_t">bson_t</code>, <code>NULL</code> to ignore.</p></td></tr>
+      <tr><td><p>read_prefs</p></td><td><p>A <code xref="mongoc_read_prefs_t">mongoc_read_prefs_t</code> or <code>NULL</code>.</p></td></tr>
       <tr><td><p>error</p></td><td><p>An optional location for a <code xref="bson:bson_error_t">bson_error_t</code> or <code>NULL</code>.</p></td></tr>
     </table>
   </section>
diff --git a/doc/mongoc_collection_create_bulk_operation.page b/doc/mongoc_collection_create_bulk_operation.page
@@ -30,7 +30,7 @@ mongoc_collection_create_bulk_operation (
     <table>
       <tr><td><p>collection</p></td><td><p>A <code xref="mongoc_collection_t">mongoc_collection_t</code>.</p></td></tr>
       <tr><td><p>ordered</p></td><td><p>If the operations must be performed in order.</p></td></tr>
-      <tr><td><p>write_concern</p></td><td><p>An optional <code xref="mongoc_write_concern_t">mongoc_write_concern_t</code> or NULL.</p></td></tr>
+      <tr><td><p>write_concern</p></td><td><p>An optional <code xref="mongoc_write_concern_t">mongoc_write_concern_t</code> or <code>NULL</code>.</p></td></tr>
     </table>
   </section>
 
@@ -40,7 +40,7 @@ mongoc_collection_create_bulk_operation (
     <p>After calling <code xref="mongoc_bulk_operation_execute">mongoc_bulk_operation_execute()</code> the commands will be executed in as large as batches as reasonable by the client.</p>
     <p>If <code>ordered</code> is true, then processing will stop at the first error.</p>
     <p>If <code>ordered</code> is not true, then the bulk operation will attempt to continue processing even after the first failure.</p>
-    <p><code>write_concern</code> contains the write concern for all operations in the bulk operation. If NULL, the collection's write concern is used. The global default is acknowledged writes: MONGOC_WRITE_CONCERN_W_DEFAULT.</p>
+    <p><code>write_concern</code> contains the write concern for all operations in the bulk operation. If <code>NULL</code>, the collection's write concern is used. The global default is acknowledged writes: MONGOC_WRITE_CONCERN_W_DEFAULT.</p>
   </section>
 
   <section id="errors">
diff --git a/doc/mongoc_collection_delete.page b/doc/mongoc_collection_delete.page
@@ -34,7 +34,7 @@ mongoc_collection_delete (mongoc_collection_t          *collection,
       <tr><td><p>collection</p></td><td><p>A <code xref="mongoc_collection_t">mongoc_collection_t</code>.</p></td></tr>
       <tr><td><p>flags</p></td><td><p>A mongoc_delete_flags_t.</p></td></tr>
       <tr><td><p>selector</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the query to match documents.</p></td></tr>
-      <tr><td><p>write_concern</p></td><td><p>A <code xref="mongoc_write_concern_t">mongoc_write_concern_t</code> or NULL.</p></td></tr>
+      <tr><td><p>write_concern</p></td><td><p>A <code xref="mongoc_write_concern_t">mongoc_write_concern_t</code> or <code>NULL</code>.</p></td></tr>
       <tr><td><p>error</p></td><td><p>An optional location for a <code xref="bson:bson_error_t">bson_error_t</code> or <code>NULL</code>.</p></td></tr>
     </table>
   </section>
diff --git a/doc/mongoc_collection_find.page b/doc/mongoc_collection_find.page
@@ -38,8 +38,8 @@ mongoc_collection_find (mongoc_collection_t       *collection,
       <tr><td><p>limit</p></td><td><p>A uint32_t of max number of documents to return or 0.</p></td></tr>
       <tr><td><p>batch_size</p></td><td><p>A uint32_t containing batch size of document result sets or 0 for default. Default is 100.</p></td></tr>
       <tr><td><p>query</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the query and options to execute.</p></td></tr>
-      <tr><td><p>fields</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing fields to return or NULL.</p></td></tr>
-      <tr><td><p>read_prefs</p></td><td><p>A <code xref="mongoc_read_prefs_t">mongoc_read_prefs_t</code> or NULL for default read preferences.</p></td></tr>
+      <tr><td><p>fields</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing fields to return or <code>NULL</code>.</p></td></tr>
+      <tr><td><p>read_prefs</p></td><td><p>A <code xref="mongoc_read_prefs_t">mongoc_read_prefs_t</code> or <code>NULL</code> for default read preferences.</p></td></tr>
     </table>
   </section>
 
@@ -51,7 +51,7 @@ mongoc_collection_find (mongoc_collection_t       *collection,
 
   <section id="return">
     <title>Returns</title>
-    <p>A newly allocated <code xref="mongoc_cursor_t">mongoc_cursor_t</code> that should be freed with <code xref="mongoc_cursor_destroy">mongoc_cursor_destroy()</code> when no longer in use. If invalid parameters are supplied, NULL may be returned.</p>
+    <p>A newly allocated <code xref="mongoc_cursor_t">mongoc_cursor_t</code> that should be freed with <code xref="mongoc_cursor_destroy">mongoc_cursor_destroy()</code> when no longer in use. If invalid parameters are supplied, <code>NULL</code> may be returned.</p>
     <note style="warning"><p>Failure to handle the result of this function is a programming error.</p></note>
   </section>
 
diff --git a/doc/mongoc_collection_find_and_modify.page b/doc/mongoc_collection_find_and_modify.page
@@ -31,11 +31,11 @@ mongoc_collection_find_and_modify (mongoc_collection_t *collection,
       <tr><td><p>query</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the query to locate target document(s).</p></td></tr>
       <tr><td><p>sort</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the sort order for <code>query</code>.</p></td></tr>
       <tr><td><p>update</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing an update spec.</p></td></tr>
-      <tr><td><p>fields</p></td><td><p>An optional <code xref="bson:bson_t">bson_t</code> containing the fields to return or NULL.</p></td></tr>
+      <tr><td><p>fields</p></td><td><p>An optional <code xref="bson:bson_t">bson_t</code> containing the fields to return or <code>NULL</code>.</p></td></tr>
       <tr><td><p>_remove</p></td><td><p>If the matching documents should be removed.</p></td></tr>
       <tr><td><p>upsert</p></td><td><p>If an upsert should be performed.</p></td></tr>
       <tr><td><p>_new</p></td><td><p>If the new version of the document should be returned.</p></td></tr>
-      <tr><td><p>reply</p></td><td><p>An optional location for a <code xref="bson:bson_t">bson_t</code> that will be initialized with the result or NULL.</p></td></tr>
+      <tr><td><p>reply</p></td><td><p>An optional location for a <code xref="bson:bson_t">bson_t</code> that will be initialized with the result or <code>NULL</code>.</p></td></tr>
       <tr><td><p>error</p></td><td><p>An optional location for a <code xref="bson:bson_error_t">bson_error_t</code> or <code>NULL</code>.</p></td></tr>
     </table>
   </section>
diff --git a/doc/mongoc_collection_get_last_error.page b/doc/mongoc_collection_get_last_error.page
@@ -32,7 +32,7 @@ mongoc_collection_get_last_error (const mongoc_collection_t *collection);
 
   <section id="return">
     <title>Returns</title>
-    <p>A <code>bson_t</code> that should not be modified or NULL.</p>
+    <p>A <code>bson_t</code> that should not be modified or <code>NULL</code>.</p>
   </section>
 
 </page>
diff --git a/doc/mongoc_collection_insert_bulk.page b/doc/mongoc_collection_insert_bulk.page
@@ -36,7 +36,7 @@ mongoc_collection_insert_bulk (mongoc_collection_t          *collection,
       <tr><td><p>flags</p></td><td><p>A bitwise or of <code xref="mongoc_insert_flags_t">mongoc_insert_flags_t</code>.</p></td></tr>
       <tr><td><p>documents</p></td><td><p>An array of <code xref="bson:bson_t">const bson_t *</code>.</p></td></tr>
       <tr><td><p>n_documents</p></td><td><p>The number of documents in <code>documents</code>.</p></td></tr>
-      <tr><td><p>write_concern</p></td><td><p>A <code xref="mongoc_write_concern_t">mongoc_write_concern_t</code> or NULL.</p></td></tr>
+      <tr><td><p>write_concern</p></td><td><p>A <code xref="mongoc_write_concern_t">mongoc_write_concern_t</code> or <code>NULL</code>.</p></td></tr>
       <tr><td><p>error</p></td><td><p>An optional location for a <code xref="bson:bson_error_t">bson_error_t</code> or <code>NULL</code>.</p></td></tr>
     </table>
   </section>
diff --git a/doc/mongoc_collection_remove.page b/doc/mongoc_collection_remove.page
@@ -28,7 +28,7 @@ mongoc_collection_remove (mongoc_collection_t          *collection,
       <tr><td><p>collection</p></td><td><p>A <code xref="mongoc_collection_t">mongoc_collection_t</code>.</p></td></tr>
       <tr><td><p>flags</p></td><td><p>A mongoc_remove_flags_t.</p></td></tr>
       <tr><td><p>selector</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the query to match documents.</p></td></tr>
-      <tr><td><p>write_concern</p></td><td><p>A <code xref="mongoc_write_concern_t">mongoc_write_concern_t</code> or NULL.</p></td></tr>
+      <tr><td><p>write_concern</p></td><td><p>A <code xref="mongoc_write_concern_t">mongoc_write_concern_t</code> or <code>NULL</code>.</p></td></tr>
       <tr><td><p>error</p></td><td><p>An optional location for a <code xref="bson:bson_error_t">bson_error_t</code> or <code>NULL</code>.</p></td></tr>
     </table>
   </section>
diff --git a/doc/mongoc_collection_save.page b/doc/mongoc_collection_save.page
@@ -25,7 +25,7 @@ mongoc_collection_save (mongoc_collection_t          *collection,
     <table>
       <tr><td><p>collection</p></td><td><p>A <code xref="mongoc_collection_t">mongoc_collection_t</code>.</p></td></tr>
       <tr><td><p>document</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the document.</p></td></tr>
-      <tr><td><p>write_concern</p></td><td><p>A <code xref="mongoc_write_concern_t">mongoc_write_concern_t</code> or NULL for default write concern.</p></td></tr>
+      <tr><td><p>write_concern</p></td><td><p>A <code xref="mongoc_write_concern_t">mongoc_write_concern_t</code> or <code>NULL</code> for default write concern.</p></td></tr>
       <tr><td><p>error</p></td><td><p>An optional location for a <code xref="bson:bson_error_t">bson_error_t</code> or <code>NULL</code>.</p></td></tr>
     </table>
   </section>
diff --git a/doc/mongoc_cursor_current.page b/doc/mongoc_cursor_current.page
@@ -26,12 +26,12 @@ mongoc_cursor_current (const mongoc_cursor_t *cursor);
 
   <section id="description">
     <title>Description</title>
-    <p>Fetches the cursors current document or NULL if there has been an error.</p>
+    <p>Fetches the cursors current document or <code>NULL</code> if there has been an error.</p>
   </section>
 
   <section id="return">
     <title>Returns</title>
-    <p>A <code xref="bson:bson_t">bson_t</code> that should not be modified or freed or NULL.</p>
+    <p>A <code xref="bson:bson_t">bson_t</code> that should not be modified or freed or <code>NULL</code>.</p>
   </section>
 
 </page>
diff --git a/doc/mongoc_gridfs_find_one.page b/doc/mongoc_gridfs_find_one.page
@@ -39,7 +39,7 @@ mongoc_gridfs_find_one (mongoc_gridfs_t *gridfs,
 
   <section id="return">
     <title>Returns</title>
-    <p>A newly allcoated <code xref="mongoc_gridfs_file_t">mongoc_gridfs_file_t</code> or NULL if no file could be found. You must free the resulting file with <code xref="mongoc_gridfs_file_destroy">mongoc_gridfs_file_destroy()</code> if non-NULL.</p>
+    <p>A newly allcoated <code xref="mongoc_gridfs_file_t">mongoc_gridfs_file_t</code> or <code>NULL</code> if no file could be found. You must free the resulting file with <code xref="mongoc_gridfs_file_destroy">mongoc_gridfs_file_destroy()</code> if non-NULL.</p>
   </section>
 
 </page>
diff --git a/doc/mongoc_gridfs_find_one_by_filename.page b/doc/mongoc_gridfs_find_one_by_filename.page
@@ -29,7 +29,7 @@ mongoc_gridfs_find_one_by_filename (mongoc_gridfs_t *gridfs,
 
   <section id="description">
     <title>Description</title>
-    <p>Finds the first file matching the filename specified. If no file could be found, NULL is returned and error is set.</p>
+    <p>Finds the first file matching the filename specified. If no file could be found, <code>NULL</code> is returned and error is set.</p>
   </section>
 
   <section id="errors">
@@ -39,7 +39,7 @@ mongoc_gridfs_find_one_by_filename (mongoc_gridfs_t *gridfs,
 
   <section id="return">
     <title>Returns</title>
-    <p>Returns a newly allocated <code xref="mongoc_gridfs_file_t">mongoc_gridfs_file_t</code> if successful, otherwise NULL and error is set. You must free the resulting file with <code xref="mongoc_gridfs_file_destroy">mongoc_gridfs_file_destroy()</code> when no longer in use.</p>
+    <p>Returns a newly allocated <code xref="mongoc_gridfs_file_t">mongoc_gridfs_file_t</code> if successful, otherwise <code>NULL</code> and error is set. You must free the resulting file with <code xref="mongoc_gridfs_file_destroy">mongoc_gridfs_file_destroy()</code> when no longer in use.</p>
   </section>
 
 </page>
diff --git a/doc/mongoc_socket_new.page b/doc/mongoc_socket_new.page
@@ -35,7 +35,7 @@ mongoc_socket_new (int domain,
 
   <section id="return">
     <title>Returns</title>
-    <p>A new socket if successful, otherwise NULL and errno is set. The result should be freed with <code xref="mongoc_socket_destroy">mongoc_socket_destroy()</code> when no longer in use.</p>
+    <p>A new socket if successful, otherwise <code>NULL</code> and errno is set. The result should be freed with <code xref="mongoc_socket_destroy">mongoc_socket_destroy()</code> when no longer in use.</p>
   </section>
 
 </page>
diff --git a/doc/mongoc_uri_new.page b/doc/mongoc_uri_new.page
@@ -32,7 +32,7 @@ mongoc_uri_new (const char *uri_string)
 
   <section id="return">
     <title>Returns</title>
-    <p>A newly allocated <code xref="mongoc_uri_t">mongoc_uri_t</code> if successful. Otherwise NULL.</p>
+    <p>A newly allocated <code xref="mongoc_uri_t">mongoc_uri_t</code> if successful. Otherwise <code>NULL</code>.</p>
     <note style="warning"><p>Failure to handle the result of this function is a programming error.</p></note>
   </section>
 
diff --git a/doc/mongoc_write_concern_get_wtag.page b/doc/mongoc_write_concern_get_wtag.page
@@ -26,12 +26,12 @@ mongoc_write_concern_get_wtag (const mongoc_write_concern_t *write_concern);
 
   <section id="description">
     <title>Description</title>
-    <p>A string containing the wtag setting if it has been set. Otherwise returns NULL.</p>
+    <p>A string containing the wtag setting if it has been set. Otherwise returns <code>NULL</code>.</p>
   </section>
 
   <section id="return">
     <title>Returns</title>
-    <p>Returns a string which should not be modified or freed, or NULL.</p>
+    <p>Returns a string which should not be modified or freed, or <code>NULL</code>.</p>
   </section>
 
 </page>
