Re: [Corelinux-develop] Library abstraction code in

[Frank V. C. <fr...@co...>]

Christophe Prud'homme wrote:
> 
> > Yep, I haven't found any problems other than the ones you fixed.
> good
> 
> > Yes, the reference package is something you may want to generate along
> > with the debian pacakges until I get the doxygen updates.
> 
> but what abount the rpm?
> the ref manual is also generated for rpm for the corelinux-doc

Yes, I have a problem generating that, although you may have forgotten.
I need to apply the update as I am running doxygen 1.1.2. I will check
their site to see if they have a rpm for the latest release, otherwise I
will get the source and build.

> > > - how to make reference manual nicer with doxygen
> > >   put a few comments about how to document classes
> >
> > Am I doing it wrong using the JavaDoc tags?
> yes but you can have much much more
> 
> - todo list
> - warning
> - bug list
> - include examples
> - better formatting
> - inclusion of images (like the use cases amnd classes diagrams)
>   that would be just great
>   I'll work on that for the next version if you agree

I will spend some time with the doxygen specific tags. BUT, as you
appear to be enamored with things that make presentation wonderful, when
the next better mousetrap comes along how will we deal with tools
specific tagging? What I would prefer is a universal tagging option
(JavaDoc?) that doesn't tie us down and yet still provides quality
output.

I would prefer we start thinking about a more complete developers guide
which would have all the requirements, analysis, and design
documentation. But that would be HUGE. For now, I would skip putting the
use-case/class diagrams in the class reference.

> 
> > We may want to start a cvs branch of utilities and scripts?
> why not
> what do you propose as a module name?

devscripts? buildtools? projtools?

Frank