On Tue, Jun 24, 2003 at 03:45:06PM -0700, Jeff Garland wrote:
> On Tue, 24 Jun 2003 17:25:23 -0400, David Abrahams wrote
> > Pavol Droba <[EMAIL PROTECTED]> writes:
> >
>
> There are a few problems here. If you haven't written any comments
> in the code to support Doxygen or Synopsis, you won't be able to
> get useful results. Also if you adopt Boost Book even if you use
> Doxygen you will get results that are not much like the 'out of
> the box Doxygen' results.
This is not a problem. I'm prepeared to change the coding style. It doesn't
matter, if the documentation is in the code, or in the separate file. It has
to be written, but I would prefer not to have the same information
on different places. Therefor, I would like to use some comment extractor
to help me build a reference.
> In my experience the problem with
> Doxygen and templates is not so much the parsing of the templates
> as Dave suggests below, but rather splitting and refining down
> the output in a logical structure as you suggest in your mail.
This is exatly the point. Doxygen parsed code quite well, but the output
was confusing and not very nice. Doxygen cannot format templated structures
very well.
> The easy thing is to run all the code. The hard thing is
> to actully document the components in the code and split
> things into logical groups.
Therefore I'm asking here for help. I would like to generate a reference from
to code, and then link a conceptual documentation to this reference.
I assume, that with BoostBook it should be able to do this, although I don't know
how, yet.
> > > I was following the discussion about BoostBook a little bit, and it
> > > seems to me that it could be used for this documentation. I have
> > > seen in the archives of this list that it is possible to generate a
> > > part of documentation using doxygen and then integrate it with
> > > BoostBook.
> >
> > If doxygen is having problems parsing your templates to begin with,
> > BoostBook can't help. If it's just formatting, you might get
> > somewhere this way.
>
> Agreed. No matter what I would recommend looking into BoostBook. Doug
> has done a nice job on this...
>
I will try to do look into it.
Thanks,
Pavol
-------------------------------------------------------
This SF.Net email is sponsored by: INetU
Attention Web Developers & Consultants: Become An INetU Hosting Partner.
Refer Dedicated Servers. We Manage Them. You Get 10% Monthly Commission!
INetU Dedicated Managed Hosting http://www.inetu.net/partner/index.php
_______________________________________________
Boost-docs mailing list
[EMAIL PROTECTED]
Unsubscribe and other administrative requests:
https://lists.sourceforge.net/lists/listinfo/boost-docs
