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.

I've tried to fix the problem somewhat by creating a list of common symbols by 
hand:

   
http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/program_options.overview.html#id501812

But it's tedious.

What I'd like is a reference organized as a list of symbols. A click on each 
symbol would bring docs for that symbols. And the docs would have to specify 
the header (for example: 
http://www.boost.org/regression-logs/cs-win32_metacomm/doc/html/options_description.html
 
does not say which header must be included).

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?

For example, I would write:

  <section>
      <title>Reference</title>

       <all-classes/>
       <grouped-classes>
              <group><class>Foo</class></group>
        </grouped-classes>      
  </section>

Or, maybe, we can use the Doxygen @ingroup attribute?

Is this reasonable idea? Could something like this be added?

Thanks,
Volodya


-------------------------------------------------------
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

Reply via email to