Pontus Lidman wrote:
> I agree with all your points, which I interpret as no html tags,
> document in the header, brief API documentation only.
Good summary.
> > Okay. If nobody else volunteers I'll give it a try when I'm finished
> > with the FAQ (which by the way was recently updated and can
Hi,
[...]
> > > In fact a perhaps better alternative would be document only the headers
> > > files instead of the implementation so that the code remains lean. (The
> > > downside would be bigger include fields and more C preprocessing time
> > > but the includes files are just used inside XFre
On Fri, 2002-01-25 at 14:22, Jens Owen wrote:
> Jose,
>
> The example you give looks reasonable, but here is another example, for
> drmAddMap, that I find much harder to read:
>
> ...
yep. This is too verbose. (Sorry I didn't notice that one.)
> > In fact a perhaps better alternative would be
Jose Fonseca wrote:
>
> On Fri, 2002-01-25 at 03:11, Jens Owen wrote:
> > José Fonseca wrote:
> >
> > > Unless anyone has a better suggestion I think this is the way to go. What
> > > do the "elder" developers think?
> >
> > The one down side I see is the complexity (and clutter) created by the
>
On Fri, 2002-01-25 at 03:11, Jens Owen wrote:
> José Fonseca wrote:
>
> > Unless anyone has a better suggestion I think this is the way to go. What
> > do the "elder" developers think?
>
> The one down side I see is the complexity (and clutter) created by the
> TAGS. I like simple
> paragraphs
José Fonseca wrote:
> Unless anyone has a better suggestion I think this is the way to go. What
> do the "elder" developers think?
The one down side I see is the complexity (and clutter) created by the
TAGS. I like simple
paragraphs myself. Perhaps we could encourage a very basic simple
templ
Pontus,
On 2002.01.19 15:33 Pontus Lidman wrote:
> Hello,
>
> Like Mr. Jose Fonseca, I have some very positive experiences with the
> Doxygen tool for documentation, and I warmly recommend it to the DRI
> project. It produces good API documentation, and the documentation is
> easy to maintain be
Hello,
Like Mr. Jose Fonseca, I have some very positive experiences with the
Doxygen tool for documentation, and I warmly recommend it to the DRI
project. It produces good API documentation, and the documentation is
easy to maintain because of its integration in the source code.
To try to show w
