Re: Library/function documentation

[olafBuddenhagen]

Hi,

On Sat, Dec 15, 2007 at 12:17:24AM +0530, Shakthi Kannan wrote:

> How do core developers go through Hurd servers/library or gnumach
> functions? Do you use etags/ctags?

Everyone uses what suits him best :-)

As for myself (definitely not a "core developer"), I'm using ctags
extensively, which works out quite nice with vim most of the time.

> Wouldn't it be useful for newbies if all functions can have comments
> to generate gtk-doc style documentation?
> http://library.gnome.org/devel/glib/unstable/index.html
> 
> It will be helpful to skim through a particular library with this
> documentation, and then look at each function in detail? Or, do you
> prefer doxygen over gtk-doc style?
> 
> Or do you recommend to use cross-referencing with GLOBAL?
> http://www.htu.tugraz.at/~past/hurd/global/

Haven't used any of these on Hurd code so far. In another project, I
used doxygen (I didn't know the other two up till now), and found it
quite useful even without special comments, if using the right options.

Special comments are controversial anyways. Personally, I don't like
them at all. If you want to know what a function is about, just look at
any normal comments in the code -- doxygen can link every function to
the corresponding location in the source code.

-antrik-