David A. Greene wrote:
Is there a complete example somewhere of how to write Boost
documentation for a library that has Doxygen comments, all
using QUickbook as the base?
The documentation for Boost.Xpressive using QuickBook and Doxygen. It's
in boost CVS (HEAD) at libs/xpressive/doc.
The relevant parts of the (v2) jamfile are:
import toolset ;
toolset.using doxygen ;
toolset.using quickbook ;
doxygen autodoc
:
[ glob ../../../boost/xpressive/*.hpp ]
[ glob ../../../boost/xpressive/traits/*.hpp ]
# <snip irrelevant stuff>
;
xml xpressive
:
xpressive.qbk
;
boostbook standalone
:
xpressive
# <snip irrelevant stuff>
;
Then, somewhere in xpressive.qbk, I have a line like this:
[xinclude autodoc.boostbook]
That pulls in the reference section generated by Doxygen. Once you do
that, you can use QuickBook constructs like [classref ...] to link to
things in your reference section.
Hope that helps!
BTW, the Boost web site makes it very hard to find the documentation
for BoostBook or Quickbook. I had to run a search to find the latter.
I can never remember how to find the former, though I know the link is
buried somewhere. The current obvious links point to outdated
instructions for writing HTML docs that seems to have been written
around 2002 or so. This really ought to be updated and made much
more accessible than it currently is.
Can you tell us which obvious links point to outdated information? We
should clean that up.
--
Eric Niebler
Boost Consulting
www.boost-consulting.com
-------------------------------------------------------
This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
for problems? Stop! Download the new AJAX search engine that makes
searching your log files as easy as surfing the web. DOWNLOAD SPLUNK!
http://ads.osdn.com/?ad_id=7637&alloc_id=16865&op=click
_______________________________________________
Boost-docs mailing list
[email protected]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
