RE: [boost] Reference documentation: one approach

From: Jeff Garland (jeff_at_[hidden])
Date: 2002-10-30 14:33:07

> ... long discussion omitted...
> Eliminating the bug is probably pretty easy for Dmitri.  Adding support for
> template parameter information is probably a bit more complicated.  But even

You make a couple of good points.  These are relevant for regular projects 
as well as those that use meta-programming.  Did you submit requests for 
enhancement? Even if Synopsis works out it would be good to improve 
Doxygen as well.

> at that point, the documentation doesn't structure output to handle the
> metafunction above.  ReturnType and Apply end up on their own pages.  IIRC,
> there aren't even references to it on the MetaPow page, only in the various
> indices and table of contents.  Since the two structures above really
> represent a typedef and a member function, the output should be structured
> to view them that way.

I think that support of documentation of meta-programming constructs
is a whole new sort of documentation that is quite distinct in it's
needs since the coding idioms use C++, but not in the 'usual' way. 

Jeff