On Mon, 3 Feb 2003, Jeff Garland wrote:
> > On Monday 03 February 2003 09:41 am, Douglas Gregor wrote:
> > > I know Doxygen does have some of the clauses (e.g., returns). I'll work on
> > > getting those mapped properly Real Soon Now (TM).
> >
> > ... done for returns.
> >
> > The Date-Time library's reference documentation is started to look quite nice.
> > A little more work and some fixing on the Doxygen output side (anyone want to
> > take this on?) and we'll have a usable system.
>
> Sure I'll take this since I'll initially be the primary beneficiary. Just
> make a list of issues...
Great! I'll keep the issues list on the Wiki updated; the main issue is
still matching up namespace-level functions to their headers. Until that's
solved, we're not going to get any of those functions into BoostBook :(.
> Now in your examples you have a /reference subdirectory which seems like a
> good idea. So I'm assuming I'll want something similar for date_time, but
> with mostly generated content. I'm assuming I'll still want a reference.xml
> as an anchor to refer to the generated xml?
Well, since the generated content will always go into a single file, and
that'll be the <library-reference> element, you can probably just
transform the Doxygen output directly to "reference.xml".
> Well, actually this brings up a question of whether I processed things as
> you intended:
>
> -- I used your doxygen-all.xml file (presumably I could recreate this by
> running Doxygen 1.2.18 and xsltproc with boostbook-xsl/doxygen/collect.xsl)
You'll actually need to copy collect.xsl into the Doxygen XML output
directory (for now), because it looks for the Doxygen XML files relative
to the XSL stylesheet directory (I don't know why...).
> -- Then I ran
> xsltproc --xinclude boostbook-xsl/doxygen/doxygen2boostbook.xsl
>doxygen-all.xml > dt_ref.boostbook
> xsltproc boostbook-xsl/docbook.xsl dt_ref.boostbook > dt_ref.docbook
> xsltproc -o dt_ref_html/ docboosk-xsl-1.60.1/html/chunk.xsl
>
> Anyway, just processing the reference piece like this created a couple of anomolies
>(like not TOC and all the synopsis's combined
> into index.html).
Right, because the top-level element is <library-reference>, which won't
have a TOC. You'll get the TOC if you integrate the reference into a
<library> element, which might look like this:
<library name="Date-Time" dirname="date_time"
xmlns:xi="http://www.w3.org/2001/XInclude";>
<libraryinfo>
<author>
<firstname>Jeff</firstname>
<surname>Garland</surname>
</author>
<librarypurpose>Date-Time library</librarypurpose>
<librarycategory name="category:misc"/>
</libraryinfo>
<!-- Include the BoostBook reference documentation generated from
Doxygen XML -->
<xi:include href="reference.xml"/>
</library>
If you then want to integrate this documentation with the rest of the
Boost documentation, remove the current <library> element for Date-Time
from libs/documentation/examples/boost.xml and put in an XInclude to your
new <library> element.
> The other twist here is that I would like to section off the reference documentation
>into parts:
> -- Generic elements
> -- Gregorian Date-Time system stuff
> -- Posix Time system stuff
> -- XYZ Time system stuff
>
> Any thoughts on how best to arrange this?
>
> Jeff
In BoostBook, you can do this by adding <section> elements in the
<library-reference> element, e.g.,
<library-reference>
<section>
<title>Generic Elements</title>
<header name="blah"> ... </header>
</section>
<section>
<title>Gregorian Date-Time system stuff</title>
<header name="wibble"> ... </header>
</section>
...
</library-reference>
Does Doxygen have the ability to do that kind of organization? If it does,
we can use it. Otherwise, I'll have to think about this a bit more...
Doug
-------------------------------------------------------
This SF.NET email is sponsored by:
SourceForge Enterprise Edition + IBM + LinuxWorld = Something 2 See!
http://www.vasoftware.com
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
