From: Pontus L. <po...@ly...> - 2002-01-25 22:08:03
|
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 XFree86 tree and the > > > difference in the build time would be almost negligible.) > > > > That would be a reasonable compromise. I agree with all your points, which I interpret as no html tags, document in the header, brief API documentation only. > 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 be seen at > http://mefriss1.swan.ac.uk/~jfonseca/dri/faq/ ). I guess this means it's ok to submit patches with just doxygen comments? I think this could be a productive way to learn and document at the same time. /Pontus -- Pontus Lidman, po...@ly..., Software Engineer No matter how cynical you get, it's impossible to keep up. Scene: www.dc-s.com | MUD: tyme.envy.com 6969 | irc: irc.quakenet.eu.org |