Re: [boost] doxygen doc / STL container unit test

Subject: Re: [boost] doxygen doc / STL container unit test
From: Stefan Strasser (strasser_at_[hidden])
Date: 2009-09-15 18:49:59

thanks for that, my doc builds now.
I have 2 problems left though:

1. inline documentation that looks like:
\throw A Here's why A was thrown
\throw B Here's why B was thrown

is translated to
Throws: A
in the output. no mention of B, and no explanations.

this works with standalone doxygen. is there any way to change that without 
changing any of the stuff that is used for every boost library?

2.
doxygen keeps ignoring my parameters.
my Jamfile.v2 looks exactly like yours below, I copied it from boost.intrusive 
and changed it.
but private and undocumented members still show up in the output.
any hint on what could be the reason for that?

thanks again

Am Friday 11 September 2009 16:52:46 schrieb Joachim Faulhaber:

> You have to code the required information in two files for a library
> somelib: Jamfile.v2 and somelib.qbk. These files should both
> be located in
> <boost_root>/libs/somelib/doc
>
> # ----------------------------------------------------------
> # Jamfile.v2
> import doxygen ;
> import quickbook ;
>
> # ----------------------------------------------------------
> # Doxygen
>
> doxygen somelibdoc
>
>         [ glob ../../../boost/somelib/*.hpp ]
>
>         <doxygen:param>EXTRACT_ALL=YES
>         <doxygen:param>HIDE_UNDOC_MEMBERS=NO
>         <doxygen:param>EXTRACT_PRIVATE=NO
>         <doxygen:param>ENABLE_PREPROCESSING=YES
>         <doxygen:param>MACRO_EXPANSION=NO
>         <doxygen:param>EXPAND_ONLY_PREDEF=YES
>         <doxygen:param>SEARCH_INCLUDES=NO
>         <reftitle>"My fancy new Library Reference"
>     ;
> # ----------------------------------------------------------
> # Quickbook
>
> import quickbook ;
>
> xml somelib
>
>         somelib.qbk
>     ;
>
> boostbook standalone
>
>         somelib
>
>         <xsl:param>boost.root=../../../..
>         <xsl:param>boost.libraries=../../../libraries.htm
>         <xsl:param>toc.max.depth=2
>         <xsl:param>toc.section.depth=2
>         <xsl:param>chunk.section.depth=2
> 		<dependency>somelibdoc
>     ;
> # ----------------------------------------------------------
>
> In the file that is your library's quickbook root: somelib.qbk
> you have to include the doxygen generated
> reference to your docs by
>
> [xinclude somelibdoc.xml]
>
> HTH
> Joachim
> _______________________________________________
> Unsubscribe & other changes:
> http://lists.boost.org/mailman/listinfo.cgi/boost