Yacine Belkadi
e65fe5a914
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 <yacine.belkadi.1@gmail.com>
Signed-off-by: Rob Landley <rob@landley.net>
Signed-off-by: Jiri Kosina <jkosina@suse.cz>
2012-11-27 21:08:57 +01:00
2012-11-19 14:28:24 +01:00
2012-11-26 14:22:21 +01:00
2012-03-30 03:30:19 -04:00
2012-10-06 03:05:30 +09:00
2012-10-11 10:55:04 +01:00
2012-09-17 13:41:56 +01:00
2012-03-23 16:58:33 -07:00
2012-04-16 14:37:13 +02:00
2012-09-09 10:35:39 +02:00
2012-03-30 16:03:15 -07:00
2011-09-27 18:08:04 +02:00
2012-10-09 16:22:54 +09:00
2012-06-26 21:19:02 -07:00
2012-09-09 22:05:12 +02:00
2012-09-04 01:35:44 +02:00
2012-04-03 13:09:18 +02:00
2012-10-08 13:50:12 +10:30
2011-12-12 14:14:31 -08:00
2012-10-11 13:40:24 +11:00
2012-10-17 19:45:35 +02:00
2012-10-18 16:10:42 -07:00
2012-09-10 17:05:45 +02:00
2012-09-28 16:16:00 -03:00
2012-03-20 10:09:28 +00:00
2012-04-20 09:24:27 -07:00
2012-11-19 14:28:24 +01:00
2012-03-30 16:03:15 -07:00
2012-10-13 10:53:54 +09:00
2012-10-25 11:53:36 -07:00
2011-09-27 18:08:04 +02:00
2012-11-19 14:28:24 +01:00
2012-11-19 14:16:09 +01:00
2012-10-05 22:23:54 +02:00
2012-03-07 16:08:24 +01:00
2012-09-01 09:57:10 -07:00
2012-03-30 16:03:15 -07:00
2012-09-20 16:49:17 -04:00
2012-11-19 14:28:24 +01:00
2012-08-14 00:07:39 -03:00
2012-03-30 16:03:15 -07:00
2011-07-25 23:06:24 -07:00
2012-11-19 14:28:24 +01:00
2012-07-18 18:35:57 -07:00
2012-02-15 14:48:01 -08:00
2012-08-04 12:15:09 +04:00
2012-09-11 18:32:41 +08:00
2011-08-03 14:25:21 -10:00
2012-05-02 00:10:49 -07:00
2011-03-31 11:26:23 -03:00
2012-11-19 14:28:24 +01:00
2012-01-11 23:58:43 -05:00
2012-10-01 18:39:45 -04:00
2012-07-09 16:42:11 -04:00
2012-04-16 14:37:13 +02:00
2011-09-27 18:08:04 +02:00
2012-10-07 17:29:24 +09:00
2012-05-22 14:37:24 +10:00
2012-07-08 00:25:48 +10:00
2011-05-13 16:31:00 -07:00
2011-05-23 13:01:00 -07:00
2011-11-02 16:07:02 -07:00
2012-09-24 20:02:22 -07:00
2012-03-30 16:03:15 -07:00
2012-09-13 16:52:04 +02:00
2012-10-09 11:21:48 +01:00
2012-10-14 13:39:34 -07:00
2012-08-16 12:31:18 -07:00
2012-09-15 16:32:31 +02:00
2012-10-02 17:26:42 -07:00
2012-10-06 03:05:15 +09:00
2012-09-17 17:12:58 -07:00
2011-03-31 11:26:23 -03:00
2012-09-24 14:44:38 +08:00
2011-09-27 18:08:04 +02:00
2012-09-27 12:11:29 +02:00
2012-08-10 12:06:39 -07:00
2011-07-14 17:57:09 -07:00
2012-11-19 14:28:24 +01:00
2012-10-10 11:15:20 +09:00
2012-11-19 14:28:24 +01:00
2012-08-16 12:33:59 -07:00
2012-08-29 17:12:58 +02:00
2012-09-27 10:08:00 -07:00
2012-10-25 11:54:06 -07:00
2012-10-24 04:07:02 +03:00
2011-12-11 10:31:58 -08:00
2011-09-27 18:08:04 +02:00
2011-05-25 08:39:21 -07:00
2011-07-11 16:48:38 -07:00
2012-03-16 20:35:01 +00:00
2012-01-14 22:25:56 +01:00
2012-10-06 03:04:59 +09:00
2012-03-29 15:38:31 +10:30
2012-03-23 16:58:37 -07:00
2011-03-31 11:26:23 -03:00
2012-06-03 12:05:50 +02:00
2011-11-09 12:10:37 +02:00
2011-07-26 16:49:45 -07:00
2011-11-02 16:07:02 -07:00
2012-07-30 12:25:47 +02:00
2012-11-19 14:28:24 +01:00
2012-03-07 16:08:24 +01:00
2012-11-19 14:10:53 +01:00
2012-04-30 16:26:30 -04:00
2012-07-29 21:11:05 -03:00
2012-05-17 19:06:13 -04:00
2011-08-13 18:34:03 -07:00
2011-04-28 16:12:47 -04:00
2012-04-05 21:24:06 -07:00
2012-04-19 19:13:08 -07:00
2011-09-21 19:45:34 +03:00
2012-05-25 16:18:34 +02:00
2011-03-23 20:44:18 +01:00
2012-10-16 18:07:12 -07:00
2011-05-25 08:39:45 -07:00
2012-07-11 14:59:17 +01:00
2011-03-31 11:26:23 -03:00
2012-11-27 21:08:57 +01:00
2011-09-27 18:08:04 +02:00
2012-10-14 13:39:34 -07:00
2011-12-02 16:12:42 +00:00
2012-09-04 16:06:34 -07:00
2011-12-11 10:31:23 -08:00
2011-05-28 17:03:29 +02:00
2012-02-11 15:11:28 +01:00
2012-01-30 12:54:40 -05:00
2012-05-09 13:59:09 -07:00
2012-06-28 12:03:15 +02:00
2011-12-23 10:17:51 +11:00
2012-05-14 08:44:11 -03:00
2011-09-27 18:08:04 +02:00
2012-04-16 14:37:13 +02:00
2012-03-30 16:03:15 -07:00
2012-02-28 16:05:06 +01:00
2011-11-07 07:54:42 +10:30
2012-03-30 16:03:15 -07:00
2012-09-26 19:56:15 +02:00
2012-09-17 10:53:57 +02:00
2012-10-06 03:04:50 +09:00
2012-09-10 17:05:45 +02:00
2012-09-06 22:16:58 -07:00
2012-10-09 16:22:40 +09:00
2012-09-18 12:53:22 +03:00
2011-09-27 18:08:04 +02:00
2012-02-08 22:53:58 +02:00
2012-10-06 03:05:01 +09:00
2011-03-31 11:26:23 -03:00
2012-10-01 15:27:48 +02:00
2011-07-11 12:45:04 -07:00
2011-03-30 12:02:05 +02:00
2012-06-25 12:11:58 -07:00
2012-04-16 14:37:13 +02:00
2011-07-25 20:57:17 -07:00
2011-08-13 18:34:03 -07:00
2012-05-25 16:18:30 +02:00
2012-10-16 09:34:01 -07:00
2012-09-21 10:48:03 -06:00
2012-01-02 13:04:55 +01:00
2012-05-08 16:01:34 -07:00
2012-07-13 22:24:45 -07:00
e65fe5a914
