Kernel function documentation question
From: Ben Dooks
Date: Tue Dec 16 2008 - 16:18:37 EST
The Documentation/kernel-doc-nano-HOWTO.txt says that functions
should be documented as so:
/**
* foobar() - short function description of foobar
I notice there are a number of places that ommit the () off the
foobar, for example:
include/linux/skbuff.h, line 461:
/**
* skb_get - reference buffer
* @skb: buffer to reference
where skb_get does not have ()s.
As a note, it seems the default debian emacs does not colour the
function name unless it ends ().
Also, is there any policy on tabs vs a single space for indenting
these comments?
--
Ben (ben@xxxxxxxxx, http://www.fluff.org/)
'a smiley only costs 4 bytes'
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/