CDRIVER-524 link from libmongoc docs to libbson

Author: ajdavis

build/libbson.xsl

@@ -0,0 +1,23 @@
+<xsl:stylesheet xmlns:xsl="http://www.w3.org/1999/XSL/Transform"
+                version="1.0">
+    <!--
+    Turn markup like this:
+
+    <code xref="bson:bson_t">bson_t</code>
+
+    ... into a link like this:
+
+    http://api.mongodb.org/libbson/current/bson_t.html
+    -->
+    <xsl:template name="mal.link.target.custom">
+        <xsl:param name="node" select="."/>
+        <xsl:param name="xref" select="$node/@xref"/>
+        <xsl:if test="starts-with($xref, 'bson:')">
+            <xsl:variable name="ref"
+                          select="substring-after($xref, 'bson:')"/>
+            <xsl:text>http://api.mongodb.org/libbson/current/</xsl:text>
+            <xsl:value-of select="$ref"/>
+            <xsl:text>.html</xsl:text>
+        </xsl:if>
+    </xsl:template>
+</xsl:stylesheet>

doc/Makefile.am

@@ -24,7 +24,7 @@ endif
 if ENABLE_HTML_DOCS
 html $(YELP_HTML_FILES):
 	@ $(MKDIR_P) doc/html
-	$(AM_V_GEN)$(YELP_BUILD) html -o doc/html $(wildcard $(top_srcdir)/doc/*.page)
+	$(AM_V_GEN)$(YELP_BUILD) html -x build/libbson.xsl -o doc/html $(wildcard $(top_srcdir)/doc/*.page)
 
 YELP_HTML_FILES = \
 	doc/html/C.css \

doc/mongoc_bulk_operation_delete.page

@@ -32,7 +32,7 @@ mongoc_bulk_operation_delete (mongoc_bulk_operation_t *bulk,
     <title>Parameters</title>
     <table>
       <tr><td><p>bulk</p></td><td><p>A <link xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</link>.</p></td></tr>
-      <tr><td><p>selector</p></td><td><p>A bson_t.</p></td></tr>
+      <tr><td><p>selector</p></td><td><p>A <code xref="bson:bson_t">bson_t</code>.</p></td></tr>
     </table>
   </section>
 

doc/mongoc_bulk_operation_delete_one.page

@@ -32,7 +32,7 @@ mongoc_bulk_operation_delete_one (mongoc_bulk_operation_t *bulk,
     <title>Parameters</title>
     <table>
       <tr><td><p>bulk</p></td><td><p>A <link xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</link>.</p></td></tr>
-      <tr><td><p>selector</p></td><td><p>A bson_t.</p></td></tr>
+      <tr><td><p>selector</p></td><td><p>A <code xref="bson:bson_t">bson_t</code>.</p></td></tr>
     </table>
   </section>
 

doc/mongoc_bulk_operation_execute.page

@@ -24,15 +24,15 @@ mongoc_bulk_operation_execute (mongoc_bulk_operation_t *bulk,
 
     <p>It is only valid to call <link xref="mongoc_bulk_operation_execute">mongoc_bulk_operation_execute()</link> once. The <code>mongoc_bulk_operation_t</code> must be destroyed afterwards.</p>
 
-    <note style="warning"><p><code>reply</code> is always initialized, even upon failure. Callers <em>must</em> call <link xref="bson_destroy">bson_destroy()</link> to release this potential allocation.</p></note>
+    <note style="warning"><p><code>reply</code> is always initialized, even upon failure. Callers <em>must</em> call <code xref="bson:bson_destroy">bson_destroy()</code> to release this potential allocation.</p></note>
   </section>
 
   <section id="parameters">
     <title>Parameters</title>
     <table>
       <tr><td><p>bulk</p></td><td><p>A <link xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</link>.</p></td></tr>
-      <tr><td><p>reply</p></td><td><p>A bson_t.</p></td></tr>
-      <tr><td><p>error</p></td><td><p>An optional location for a <link xref="bson_error_t">bson_error_t</link> or <code>NULL</code>.</p></td></tr>
+      <tr><td><p>reply</p></td><td><p>A <code xref="bson:bson_t">bson_t</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>
 

doc/mongoc_bulk_operation_insert.page

@@ -24,7 +24,7 @@ mongoc_bulk_operation_insert (mongoc_bulk_operation_t *bulk,
     <title>Parameters</title>
     <table>
       <tr><td><p>bulk</p></td><td><p>A <link xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</link>.</p></td></tr>
-      <tr><td><p>document</p></td><td><p>A bson_t.</p></td></tr>
+      <tr><td><p>document</p></td><td><p>A <code xref="bson:bson_t">bson_t</code>.</p></td></tr>
     </table>
   </section>
 

doc/mongoc_bulk_operation_remove.page

@@ -23,7 +23,7 @@ mongoc_bulk_operation_remove (mongoc_bulk_operation_t *bulk,
     <title>Parameters</title>
     <table>
       <tr><td><p>bulk</p></td><td><p>A <link xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</link>.</p></td></tr>
-      <tr><td><p>selector</p></td><td><p>A bson_t.</p></td></tr>
+      <tr><td><p>selector</p></td><td><p>A <code xref="bson:bson_t">bson_t</code>.</p></td></tr>
     </table>
   </section>
 

doc/mongoc_bulk_operation_remove_one.page

@@ -23,7 +23,7 @@ mongoc_bulk_operation_remove_one (mongoc_bulk_operation_t *bulk,
     <title>Parameters</title>
     <table>
       <tr><td><p>bulk</p></td><td><p>A <link xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</link>.</p></td></tr>
-      <tr><td><p>selector</p></td><td><p>A bson_t.</p></td></tr>
+      <tr><td><p>selector</p></td><td><p>A <code xref="bson:bson_t">bson_t</code>.</p></td></tr>
     </table>
   </section>
 

doc/mongoc_bulk_operation_replace_one.page

@@ -28,8 +28,8 @@ mongoc_bulk_operation_replace_one (mongoc_bulk_operation_t *bulk,
     <title>Parameters</title>
     <table>
       <tr><td><p>bulk</p></td><td><p>A <link xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</link>.</p></td></tr>
-      <tr><td><p>selector</p></td><td><p>A bson_t containing the selector to query.</p></td></tr>
-      <tr><td><p>document</p></td><td><p>A bson_t containing the replacement document.</p></td></tr>
+      <tr><td><p>selector</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the selector to query.</p></td></tr>
+      <tr><td><p>document</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the replacement document.</p></td></tr>
       <tr><td><p>upsert</p></td><td><p><code>true</code> if this should be an <code>upsert</code>.</p></td></tr>
     </table>
     <note style="warning"><p><code>document</code> may not contain fields with keys containing <code>.</code> or <code>$</code>.</p></note>

doc/mongoc_bulk_operation_update.page

@@ -27,8 +27,8 @@ mongoc_bulk_operation_update (mongoc_bulk_operation_t *bulk,
     <title>Parameters</title>
     <table>
       <tr><td><p>bulk</p></td><td><p>A <link xref="mongoc_bulk_operation_t">mongoc_bulk_operation_t</link>.</p></td></tr>
-      <tr><td><p>selector</p></td><td><p>A bson_t containing the selector to query.</p></td></tr>
-      <tr><td><p>document</p></td><td><p>A bson_t containing the update document.</p></td></tr>
+      <tr><td><p>selector</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the selector to query.</p></td></tr>
+      <tr><td><p>document</p></td><td><p>A <code xref="bson:bson_t">bson_t</code> containing the update document.</p></td></tr>
       <tr><td><p>upsert</p></td><td><p><code>true</code> if an <code>upsert</code> should be performed.</p></td></tr>
     </table>
   </section>