Re: [Patch] Bitmap allocator doygen style comments.

[Jonathan Wakely <cow at compsoc dot man dot ac dot uk>]

On Thu, Dec 16, 2004 at 08:46:04PM +0530, Dhruv Matani wrote:

> Ok, thanks for the tips (and the comprehensive spell-check ;-) )

I think it's a mental condition, I can't help spell-checking  ;)

> I'll make the necessary corrections.
> Ok, just one thing. How much is the acceptable brief description? I'll
> take it to be 1 sentence, but I'll wait for your reply before preparing
> the patch.

I'm not sure, to be honest, but I usually go for one sentence.

I think of it like the text that is shown at the top of a manpage
e.g.
       strcmp, strncmp - compare two strings
or
       calloc,  malloc, free, realloc - Allocate and free dynamic memory

I aim to describe the function in a sentence, if I can't maybe the
function is trying to do too many things or I don't understand it!

Others might have difference preferences.

jon

-- 
Message terminated with signal 11, SIGFAULT