mongoc_stream documentation and final cleanup

Author: hanumantmk

configure.ac

@@ -190,6 +190,9 @@ dnl **************************************************************************
 MONGOC_SYMBOLS=`sed -e 's/.*/$(top_srcdir)\/doc\/&.3/' < mongoc/libmongoc.symbols | xargs`
 AC_SUBST([MONGOC_SYMBOLS])
 
+MONGOC_API=`sed -e 's/.*/$(top_srcdir)\/doc\/&.7/' < doc/mongoc_api | xargs`
+AC_SUBST([MONGOC_API])
+
 dnl **************************************************************************
 dnl Check for necessary libraries.
 dnl **************************************************************************

doc/Makefile.include

@@ -1,17 +1,12 @@
-MAN3 = $(top_srcdir)/doc/todo.3 $(MONGOC_SYMBOLS)
+MAN3 = $(MONGOC_SYMBOLS)
 
-MAN7 = \
-	$(top_srcdir)/doc/mongoc_client.7 \
-	$(top_srcdir)/doc/mongoc_client_pool.7 \
-	$(top_srcdir)/doc/mongoc_collection.7 \
-	$(top_srcdir)/doc/mongoc_cursor.7 \
-	$(top_srcdir)/doc/mongoc_database.7 \
-	$(top_srcdir)/doc/mongoc_gridfs.7 \
-	$(top_srcdir)/doc/mongoc_gridfs_file.7 \
-	$(top_srcdir)/doc/mongoc_gridfs_file_list.7 \
-	$(top_srcdir)/doc/mongoc_read_prefs.7 \
-	$(top_srcdir)/doc/mongoc_uri.7 \
-	$(top_srcdir)/doc/mongoc_write_concern.7
+$(top_srcdir)/doc/mongoc_symbols.txt: $(top_srcdir)/mongoc/libmongoc.symbols
+	sed -e 's/.*/linkmongoc:&[3] +/' < $< > $@
+
+$(top_srcdir)/doc/mongoc_api.txt: $(top_srcdir)/doc/mongoc_api
+	sed -e 's/.*/linkmongoc:&[7] +/' < $< > $@
+
+MAN7 = $(MONGOC_API)
 
 MAN_DOC = $(MAN1) $(MAN3) $(MAN7)
 
@@ -32,7 +27,14 @@ endif
 
 MAINTAINERCLEANFILES = $(MAN_DOC) $(MAN_HTML)
 
-doc : $(top_srcdir)/doc/asciidoc.conf $(DOC_EXAMPLES) $(MAN_DOC) $(MAN_HTML)
+doc : \
+	$(top_srcdir)/doc/mongoc_api.txt \
+	$(top_srcdir)/doc/mongoc_symbols.txt \
+	$(top_srcdir)/doc/asciidoc.conf \
+	$(DOC_EXAMPLES) \
+	$(MAN_DOC) \
+	$(MAN_HTML)
+
 dist-hook : doc
 
 if BUILD_DOC
@@ -45,13 +47,15 @@ EXAMPLE_DIR = $(abs_top_srcdir)/examples
 	   ln -fs `basename \`readlink $<\` .txt`.html $@; \
 	else \
 	   asciidoc -d manpage -b xhtml11 -f $(top_srcdir)/doc/asciidoc.conf \
+	      -adocs=$(abs_top_srcdir)/doc \
 	      -aexamples=$(EXAMPLE_DIR) -amongoc_version=@PACKAGE_VERSION@ -o$@ $<; \
 	fi
 .txt.xml:
 	if [ -L $< ]; then \
 	   ln -fs `basename \`readlink $<\` .txt`.xml $@; \
 	else \
 	   asciidoc -d manpage -b docbook -f $(top_srcdir)/doc/asciidoc.conf \
+	      -adocs=$(abs_top_srcdir)/doc \
 	      -aexamples=$(EXAMPLE_DIR) -amongoc_version=@PACKAGE_VERSION@ \
 	      -amongoc_manname=$(*F) -o$@ $<; \
 	fi

doc/mongoc.txt

@@ -0,0 +1,43 @@
+mongoc(7)
+=========
+
+
+NAME
+----
+mongoc - MongoDB C Driver
+
+
+SYNOPSIS
+--------
+
+[source, c]
+---------------
+#include <mongoc.h>
+
+mongoc_client_t * client;
+
+client = mongoc_client_new(uri_string);
+---------------
+
+
+DESCRIPTION
+-----------
+_mongoc_ is the MongoDB C driver
+
+SEE ALSO
+--------
+
+API
+~~~
+
+include::{docs}/mongoc_api.txt[]
+
+FUNCTIONS
+~~~~~~~~~
+
+include::{docs}/mongoc_symbols.txt[]
+
+AUTHORS
+-------
+
+This page was written by MongoDB Inc.

doc/mongoc_api

@@ -0,0 +1,14 @@
+mongoc
+mongoc_client
+mongoc_client_pool
+mongoc_collection
+mongoc_cursor
+mongoc_database
+mongoc_gridfs
+mongoc_gridfs_file
+mongoc_gridfs_file_list
+mongoc_read_prefs
+mongoc_ssl
+mongoc_stream
+mongoc_uri
+mongoc_write_concern

doc/mongoc_api.txt

@@ -0,0 +1,14 @@
+linkmongoc:mongoc[7] +
+linkmongoc:mongoc_client[7] +
+linkmongoc:mongoc_client_pool[7] +
+linkmongoc:mongoc_collection[7] +
+linkmongoc:mongoc_cursor[7] +
+linkmongoc:mongoc_database[7] +
+linkmongoc:mongoc_gridfs[7] +
+linkmongoc:mongoc_gridfs_file[7] +
+linkmongoc:mongoc_gridfs_file_list[7] +
+linkmongoc:mongoc_read_prefs[7] +
+linkmongoc:mongoc_ssl[7] +
+linkmongoc:mongoc_stream[7] +
+linkmongoc:mongoc_uri[7] +
+linkmongoc:mongoc_write_concern[7] +