On Thursday 18 September 2003 10:13 am, Pavol Droba wrote:
> Hi,
>
> I'm using boostbook to generate the reference documentation for the library
> I'm working on. It has improved a lot and now it is very good for the
> purpose I need.
Glad to hear it.
> But I have some questions/suggestions.
>
> 1. During the compilation I'm getting following messages and I don't know
> what they mean:
>
> xslt-xsltproc bin/gcc/debug/string_algo.doxygen.doxygen
> xslt-xsltproc bin/gcc/debug/string_algo.doxygen.xml
>
> -- Cannot handle sectiondef with kind=private-attrib
>
> -- Cannot handle sectiondef with kind=private-type
>
> -- Cannot handle sectiondef with kind=private-attrib
>
> -- Cannot handle sectiondef with kind=private-static-attrib
> xslt-xsltproc bin/gcc/debug/string_algo.doxygen.docbook
The Doxygen->BoostBook conversion skips sections it doesn't know how to deal
with, which includes private sections (that presumably shouldn't show up in
the final documentation, anyway).
> and
>
> Writing id5216184-bb.html for refentry(id5216184-bb)
> Writing id5216262-bb.html for refentry(id5216262-bb)
> -- No template matches purpose in emphasis.
> Writing struct.boost.string_algo.is_equal.html for
> refentry(struct.boost.string_algo.is_equal) -- No template matches purpose
> in emphasis.
It's very odd that a brief description (<purpose> in BoostBook) would be
wrapped in an <emphasis> element... is all of this in the sandbox, or
someplace else I can take a look at it?
> 2. Is there a way how to make lists in the reference? Doxygen can handle
> lists in comments, but they are not propagated to boostbook.
If Doxygen puts them into the XML in a sensible format, then I can propagate
them to BoostBook. I'll look into it.
> 3. I have reported this issue before, but non has changed since then. So
> again. To sucessfully execute boostbook build I have to manualy edit
> $BOOST/tools/build/tools/doxygen.jam.
>
> On the line 69 there is a hardcode link to some file.
>
> local xsl-dir = [ boostbook.xsl-dir ] ;
> DEPENDS $(target) : $(index-target) ;
> xslt $(target) : $(index-target) "$(xsl-dir)/doxygen/collect.xsl"
> ---- :
> <xsl:param>doxygen.xml.path=/home/gregod/Projects/Boost/boost/libs/any/doc/
>xml ;
>
> Is this an error, or am I just missing something?
It's definitely an error. How to fix it is, well, an open question. Answering
this question also means answering the question of what to do when someone
_without_ Doxygen wants to regenerate documentation from the BoostBook
version. I'm planning to work on this over the weekend, because my upcoming
tribool submission will actually use the Doxygen->BoostBook transformation :)
> 4. Link to files in the reference index are invalid. Links are always
> pointing to $BOOST/boost/<header name>.hpp, but my files are located in
> $BOOST/boost/string_algo/<header_name>.hpp so the link is invalid.
Shouldn't you specify your header names as "string_algo/header name.hpp"
anyway, because that's what users are expected to #include?
> 5. Last point is just a wish. I have stated it before too, and I don't know
> what is the status of it. I would like to modify doxygen parameters during
> the build somehow. Currently the build process only generates the same
> doxygen file, and it is hard to do something with it. I need to specify
> some additional flags to doxygen config. Namely macro expasion is quite
> essential. What I do now, it to let bjam generate default file, then I
> modify it an rerun th doxygen manualy. Next time bjam uses xml generated
> from my config.
>
> I think it would be enough to add possibility to append a file to doxygen
> config with custom settings.
Okay, this will be part of the Doxygen-fixing over the weekend. Thanks for the
feedback!
Doug
-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
