Re: Question about header file documentation

[Ralph Corderoy <ralph@inputplus.demon.co.uk>]

Hi Chris,

> However, it seems like none (or very few) of the kernel header files do
> this.  Is there a particular reason that I don't see ??

I can't answer for the various authors but I wouldn't do it because
it's duplicating information easily obtained in another way, e.g.
ctags, and unlike a mechanical method can become out of date and be
mis-leading, as can many comments.

Comments can be useful, but never believe them.  :-)


Ralph.

-
Kernelnewbies: Help each other learn about the Linux kernel.
Archive:       http://mail.nl.linux.org/
IRC Channel:   irc.openprojects.net / #kernelnewbies
Web Page:      http://www.kernelnewbies.org/