Eric Niebler wrote:
Jeff Garland wrote:
On Thu, 23 Mar 2006 10:36:00 -0800, Eric Niebler wrote
Looking at the nightly generated docs in the wake of my XSLT changes,
I notice that the date_time docs are out of step. Turns out for
date_time, Doxygen needs to be run as a separate step and the
resulting .boostbook files need to be checked in. Why is this not
integrated into the doc build process?
Sorry to be slow on the response. It's true, we generate the
reference xml
ourselves and check it in. The primary reason is getting a bit foggy
for me
now, but I believe the essential reason is the BoostBook isn't able to
split
the reference into parts. If you look at:
http://www.boost.org/doc/html/date_time/doxy.html
you'll see that we split things into 4 logical groupings. As far as I
know
there's no automated way to do this. As I recall there may be some other
issues with the Doxygen results that we modify 'manually' (by script)
as well...
In January, I added support to BoostBook for multiple Doxygen-generated
reference sections. See http://tinyurl.com/ruy73. You might give that a
shot. You can even have cross-references between the multiple reference
sections if you use doxygen to generate tagfiles. In your Jamfile, you
can add <doxygen:param>GENERATE_TAGFILE=foo.tag for one reference
section, and then <doxygen:param>TAGFILES=foo.tag when generating a
second section that refers to entries in the first.
I've regenerated the date_time docs locally and changed the Jamfile to
use BoostBook's support for multiple reference sections. The Jamfile was
broken because the two invocations of the boostbook rule we causing a
conflict, so I commented out "boostbook date_time_doc" invocation, which
seemed superflous. (Jeff, any guidance here?)
The patch is attached. If you'd like, I can commit this change along
with the regenerated docs. Jeff?
The next logical step would be to integrate this into the normal
documentation build progress so that we never have to worry again about
regenerating the date_time docs. Should be pretty trivial after this.
--
Eric Niebler
Boost Consulting
www.boost-consulting.com
Index: Jamfile.v2
===================================================================
RCS file: /cvsroot/boost/boost/libs/date_time/xmldoc/Jamfile.v2,v
retrieving revision 1.6
diff -b -d -u -r1.6 Jamfile.v2
--- Jamfile.v2 8 May 2005 18:55:38 -0000 1.6
+++ Jamfile.v2 6 Apr 2006 20:40:15 -0000
@@ -6,7 +6,7 @@
boostbook date_time : date_time.xml ;
-boostbook date_time_doc : exclusive_date_time.xml ;
+# boostbook date_time_doc : exclusive_date_time.xml ;
# file lists take the form of [ set.difference [ glob include/these ] : [ glob
but/not/these ] ]
@@ -33,21 +33,25 @@
doxygen date_time_autodoc :
$(date_time_files) :
<doxygen:param>ENABLE_PREPROCESSING=NO
+ <xsl:param>"boost.doxygen.reftitle=\"Date Time Reference\""
;
doxygen gregorian_autodoc :
$(gregorian_files) :
<doxygen:param>ENABLE_PREPROCESSING=NO
+ <xsl:param>"boost.doxygen.reftitle=\"Gregorian Reference\""
;
doxygen posix_time_autodoc :
[ glob ../../../boost/date_time/posix_time/*.hpp ] :
<doxygen:param>ENABLE_PREPROCESSING=NO
+ <xsl:param>"boost.doxygen.reftitle=\"Posix Time Reference\""
;
doxygen local_time_autodoc :
[ glob ../../../boost/date_time/local_time/*.hpp ] :
<doxygen:param>ENABLE_PREPROCESSING=NO
+ <xsl:param>"boost.doxygen.reftitle=\"Local Time Reference\""
;
