[PATCH 1/2] Kernel-doc: Convention: Use a "Return" section to describe return values

2012-09-30 Thread Yacine Belkadi
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

[PATCH 1/2] Kernel-doc: Convention: Use a Return section to describe return values

2012-09-30 Thread Yacine Belkadi
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