On Friday 14 May 2004 08:54 am, Vladimir Prus wrote:
> > This way, BoostBook will just "do the right thing" of grouping the
> > \overloads together using the documentation from the first. Doxygen's
> > output is a little less pretty, but that's my opinion :)
>
> The problem with this is that you can't add specific documentation for each
> overload. E.g:
>
> /**
> * \overload
> * If the parameter if INF, your monitor will blow up and your mouse will
> * bite you.
> */
> void foo(double);
True, true. Do we even want them on the same page, if they're different enough
that they need separate documentation? I ask because the Standard always
groups overloads and documents them together.
> The best solution would be to automatically group all overloads on the same
> HTML page.
Would the HTML page then have another synopsis? e.g.,
Synopsis
void foo(int);
void foo(double);
void foo(int);
documentation for void foo(int);
void foo(double);
documentation for void foo(double);
Doug
-------------------------------------------------------
This SF.Net email is sponsored by: SourceForge.net Broadband
Sign-up now for SourceForge Broadband and get the fastest
6.0/768 connection for only $19.95/mo for the first 3 months!
http://ads.osdn.com/?ad_id=2562&alloc_id=6184&op=click
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
