Hello,
there's one thing I don't like about reference doc produced by Doxygen/BoostBook combination. Take a look at:
http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/program_options.reference.html
I'm I'm looking for a specific class or function, that reference is very hard to use. First, it's organised by header, and the header where a symbols is defined is secondary information for almost every user -- he first look ups a symbols, reads what the symbols is, and only then wants to know which header to include.
There's also a lot of syntantic noise there. For example, namespace declarations, or even exact prototypes are not interesting for a user looking for a specific symbol.
[snip]
The 100% excellent solution would be something like Qt docs: http://doc.trolltech.com/4.0/index.html. There are "All Classes", "Main Classes", "Grouped classes" (almost what I've tried to do for program_options), and "Annotated Classes".
I'm not sure how this could be implemented. For example, is it possible to provide custom "reference index" page and a set of BoostBook elements I can use to make various lists?
[snip]
Is this reasonable idea? Could something like this be added?
Thanks, Volodya
The XML files generated by doxygen are very detailed, containing a lot of information about the code used to generate the file, including directory structure and namespace structure.
The question is: how do you process this information to create reference documentation? It should be possible to generate a file per class (and namespace for functions contained within a namespace) in a format similar to the Javadoc and Qt documentation structures. You could also build an index based on header file, directory and namespace.
How do we structure this reference information? It would be useful to have all the doxygen reference information in one place so you can have a single Boost-wide reference like you have for the Java APIs. This may require some processing changes to collate all the information in one place. You could then run it through a doxygen XSLT stylesheet to generate the reference files in a similar way that BoostBook works.
It would be useful then to separate out the doxygen and BoostBook files during the build stage so you can have a global reference while still having the BoostBook "user manual".
Let me know if you want me to take a look at this and I'll see what I can do. Ideally, also, the doxygen files should support the boostbook L&F.
Regards, Reece
------------------------------------------------------- This SF.net email is sponsored by: IT Product Guide on ITManagersJournal Use IT products in your business? Tell us what you think of them. Give us Your Opinions, Get Free ThinkGeek Gift Certificates! Click to find out more http://productguide.itmanagersjournal.com/guidepromo.tmpl _______________________________________________ Boost-docs mailing list [EMAIL PROTECTED] Unsubscribe and other administrative requests: https://lists.sourceforge.net/lists/listinfo/boost-docs
