Doug Gregor wrote:
On Friday 30 July 2004 5:14 pm, Eric Niebler wrote:
I am using doxygen/boostbook/BBv2 to build a reference, and I'm running into some problems. Maybe someone can offer some suggestions.
I'm about to head home, so I'll revisit this list in the next day or two...
*nudge* ;-)
There is a bunch of stuff I don't want emitted, like stuff in the detail:: namespace. The doxygen documentation suggests wrapping them in a #ifndef DOXYGEN_SKIP_THIS block, and then defining DOXYGEN_SKIP_THIS when running doxygen. Is there a way to do this from the Jamfile?
I just ran into this problem myself, and checked in a fix so that anything in a "detail" namespace is automagically ignored. If you have something in a non-detail that you want ignored, place "INTERNAL ONLY" into the documentation for that thing and it will be skipped.
Works great, thanks!
I'll repeat my other gripes here ...
My project is in the boost-sandbox, and all the relative HTML links generated by doxygen/boostbook are broken. For instance, the links in the header (Home, Libraries, People, FAQ, More) are broken, as are all the links to the source files. Is there some way to specify a relative path prefix so these links are correct?
<<extra info: the filenames in the Jamfile look like this:
../../../boost/xpressive/detail/algo.hpp
However, the URLs to the source files look like this:
<a href="../../boost/xpressive/detail/backref.hpp"
Considering where bjam is outputting the html, this should be:
<a href="../../../../boost/xpressive/detail/backref.hpp">>I don't want the private members documented. I have added these directives to the doxygen rule in my Jamfile.v2, but they don't seem to have any visible effect:
<doxygen:param>EXTRACT_ALL=NO
<doxygen:param>HIDE_UNDOC_MEMBERS=YES
<doxygen:param>EXTRACT_PRIVATE=NO
<doxygen:param>ENABLE_PREPROCESSING=YES
<doxygen:param>MACRO_EXPANSION=YES
<doxygen:param>EXPAND_ONLY_PREDEF=YES
<doxygen:param>SEARCH_INCLUDES=YES
What am I doing wrong?
<<extra info: With Doug's recent changes, private members are thrown out, so this one is moot. Sort of. I'm still interested in turning on preprocessing, but the above isn't doing it. I have added <doxygen:param>PREDEFINED=BOOST_DEDUCED_TYPENAME=typename, in the hopes that it would replace all occurances of "BOOST_DEDUCED_TYPENAME" with "typename" in the code, but it didn't work. Why?>>
For each entity, I have a brief description and a detailed description. The brief description ends up at the top of the generated HTML file (good), but the detailed description ends up orphaned at the bottom (bad). There is a "Description" section in the HTML following the "Synopsis" section, but it is always empty. Bug?
<<extra info: I find this only happens for the documentation corresponding to free functions, not classes. If there is a Parameters section (/param), it appears after the "Description" header but before the description text.>>
The text for the following doxygen fields end up orphaned at the bottom of the generated HTML, with no section header:
\pre
\return
There are probably others that I haven't discovered yet.
<<extra info: also without headers are \post and \attention.>>
For enumerations, I have doc comments for each of the members, but they are not getting emitted in the HTML. Known problem? (I am aware that I need a \file directive for global entities to get emitted.)
<<extra info: I can't get *any* documentation about enumeration to get emitted -- not the brief description, or the full description, or the descriptions of any of the individual members of the enum. Nothing.>>
Other things I've noticed:
If I mention a type in a doc comment, it should get cross-linked in the resulting HTML, but it doesn't. And if I want to change the filename that a class appears in, the Doxygen guide says I can do it with the /class directive, but it doesn't seem to have any effect.
I would be happy to make some of these changes myself, if I only knew where to start. Can somebody point me in the right direction? What files are involved in the various transformations?
Thanks.
-- Eric Niebler Boost Consulting www.boost-consulting.com
------------------------------------------------------- SF.Net email is sponsored by Shop4tech.com-Lowest price on Blank Media 100pk Sonic DVD-R 4x for only $29 -100pk Sonic DVD+R for only $33 Save 50% off Retail on Ink & Toner - Free Shipping and Free Gift. http://www.shop4tech.com/z/Inkjet_Cartridges/9_108_r285 _______________________________________________ Boost-docs mailing list [EMAIL PROTECTED] Unsubscribe and other administrative requests: https://lists.sourceforge.net/lists/listinfo/boost-docs
