[Boost-docs] using boost_doc for non-boost lib

Subject: [Boost-docs] using boost_doc for non-boost lib
From: Frank Mori Hess (frank.hess_at_[hidden])
Date: 2007-09-04 18:53:58

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1

Hi,

I'm wondering if anyone can give any pointers on how to get boostbook from the 
boost_doc svn to generate docs for my library.  I was able to use boostbook 
from the boost 1.34.1 release to generate docs by doing something along the 
lines of

xsltproc --xinclude -o mylibref.docbook $(BOOSTBOOK_TOOL_DIR)/xsl/docbook.xsl 
mylibref.xml

xsltproc --xinclude -o html/ $(BOOSTBOOK_TOOL_DIR)/xsl/html.xsl 
mylibref.docbook

and copying over a copy of boostbook.css.  However, when I try something 
similar with boost_doc, it only generates a single html page (I can put it up 
somewhere if anyone wants to see it) with the table of contents and outlines 
of each header file.  However, the detailed documentation for the classes is 
not generated.  The detailed documentation for the classes is not present in 
the mylibref.docbook file generated by the first xsltproc call.

I also had to copy over the "testing" and "caramel" subdirectories of 
tools/boostbot/xsl/ from boost 1.34.1 since they are not in the boost_doc 
svn.

I also tried copying boost_doc over the boost 1.34.1 source tree (both svn and 
the release zip file from July) and using them to build the boost 1.34.1 doc/ 
subdirectory.  This failed, as some header files seem to be missing since 
tools/quickbook/detail/actions.hpp tries to include some nonexistant files:

#include "../syntax_highlight.hpp"
#include "./collector.hpp"
#include "./template_stack.hpp"
#include "./utils.hpp"

Now, I could just stick with the boostbook from the main boost release, but I 
was hoping to maybe fix a few issues and submit patches.  For example, I want 
support for documenting protected member functions.  I was thinking either 
new elements for a class like

<class>
<public>
<method>...</method>
...
</public>
<protected>
<method>...</method>
...
</protected
</class>

or a new "protection" attribute for the method-group element.  However, I 
presently know next to nothing about xsl or extending docbook so I might not 
have the patience.

- -- 
Frank
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.6 (GNU/Linux)

iD8DBQFG3anG5vihyNWuA4URArOMAKDrD2PGVIGjhNUHnei/jSIj2pR2/wCfQCGU
PC3dwYCAmNFsDIAYGNrf2Sw=
=QMNM
-----END PGP SIGNATURE-----