CDRIVER-1030 document mongoc_host_list_t

Author: ajdavis

doc/mongoc_cursor_get_host.page

@@ -22,7 +22,7 @@ mongoc_cursor_get_host (mongoc_cursor_t    *cursor,
     <title>Parameters</title>
     <table>
       <tr><td><p>cursor</p></td><td><p>A <code xref="mongoc_cursor_t">mongoc_cursor_t</code>.</p></td></tr>
-      <tr><td><p>host</p></td><td><p>A mongoc_host_list_t.</p></td></tr>
+      <tr><td><p>host</p></td><td><p>A <code xref="mongoc_host_list_t">mongoc_host_list_t</code>.</p></td></tr>
     </table>
   </section>
 

doc/mongoc_host_list_t.page

@@ -0,0 +1,37 @@
+<?xml version="1.0"?>
+
+<page id="mongoc_host_list_t"
+      type="guide"
+      style="class"
+      xmlns="http://projectmallard.org/1.0/"
+      xmlns:api="http://projectmallard.org/experimental/api/"
+      xmlns:ui="http://projectmallard.org/experimental/ui/">
+  <info>
+    <link type="guide" xref="index#api-reference" />
+  </info>
+  <title>mongoc_host_list_t</title>
+  <section id="description">
+    <title>Synopsis</title>
+    <code mime="text/x-csrc"><![CDATA[typedef struct
+{
+   mongoc_host_list_t *next;
+   char                host [BSON_HOST_NAME_MAX + 1];
+   char                host_and_port [BSON_HOST_NAME_MAX + 7];
+   uint16_t            port;
+   int                 family;
+   void               *padding [4];
+} mongoc_host_list_t;
+]]></code>
+  </section>
+
+  <section id="desc">
+    <title>Description</title>
+    <p>The host and port of a MongoDB server. Can be part of a linked list: for example the return value of <code xref="mongoc_uri_get_hosts">mongoc_uri_get_hosts</code> when multiple hosts are provided in the MongoDB URI.</p>
+  </section>
+
+  <section id="seealso">
+    <title>See Also</title>
+    <p><code xref="mongoc_uri_get_hosts">mongoc_uri_get_hosts</code> and <code xref="mongoc_cursor_get_host">mongoc_cursor_get_host</code>.</p>
+  </section>
+
+</page>

doc/mongoc_server_description_host.page

@@ -33,7 +33,7 @@ mongoc_server_description_host (const mongoc_server_description_t *description);
 
   <section id="return">
     <title>Returns</title>
-    <p>A reference to the given server description's mongoc_host_list_t.</p>
+    <p>A reference to the given server description's <code xref="mongoc_host_list_t">mongoc_host_list_t</code>.</p>
   </section>
 
 </page>

doc/mongoc_uri_get_hosts.page

@@ -26,12 +26,12 @@ mongoc_uri_get_hosts (const mongoc_uri_t *uri);
 
   <section id="description">
     <title>Description</title>
-    <p>Fetches a linked list of hosts that were defined in the URI (the comman separated host section).</p>
+    <p>Fetches a linked list of hosts that were defined in the URI (the comma-separated host section).</p>
   </section>
 
   <section id="return">
     <title>Returns</title>
-    <p>A linked list of hosts that should not be modified or freed.</p>
+    <p>A linked list of <code xref="mongoc_host_list_t">mongoc_host_list_t</code> structures that should not be modified or freed.</p>
   </section>
 
 </page>