bug-hurd
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: Library/function documentation


From: Shakthi Kannan
Subject: Re: Library/function documentation
Date: Mon, 17 Dec 2007 11:35:14 +0530

Hi,

----- On Dec 16, 2007 7:40 PM, Carl Fredrik Hammar <hammy.lite@gmail.com> wrote:
| The consensus seem to be that proper overview documentation belongs in
| info pages were it can be handled more appropriate.
\--

Where are the info pages available?

Different developers have different ways of reading code. I usually
like to skim through the .c file to get an overview of the available
functions, and then delve into each function to see what it does, and
thus having doxygen or gtk-doc on the code-base would be quite
helpful, in this regard.

Would someone be willing to review the documentation comments written
before each function, if patches are sent for each file?

Thanks for your reply,

SK

-- 
Shakthi Kannan
http://www.shakthimaan.com




reply via email to

[Prev in Thread] Current Thread [Next in Thread]