From: Yacine Belkadi Date: Mon, 26 Nov 2012 21:21:23 +0000 (+0100) Subject: Kernel-doc: Convention: Use a "Return" section to describe return values X-Git-Tag: omap-for-v3.8/fixes-for-merge-window-v4-signed~37^2~9 X-Git-Url: http://git.openpandora.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=e65fe5a91404af97a7a487e6c7606fb5e3807d7d;p=pandora-kernel.git Kernel-doc: Convention: Use a "Return" section to describe return values Non-void functions should describe their return values in their kernel-doc comments. Currently, some don't, others do in various forms. For example: * Return the result. * Return: The result. * Returns the result. * Returns: the result. * Return Value: The result. * @return: the result. * This function returns the result. * It will return the result. Defining a convention would improve consistency of kernel-doc comments. It would also help scripts/kernel-doc identify the text describing the return value of a function. Thus allowing additional checks on the comments, and suitable highlighting in the generated docs (man pages, html, etc). So, as a convention, use a section named "Return" to describe the return value of a function. Signed-off-by: Yacine Belkadi Signed-off-by: Rob Landley Signed-off-by: Jiri Kosina --- Reading git-diff-tree failed