diff options
| author | Robert P. J. Day <rpjday@mindspring.com> | 2007-01-26 00:57:09 -0800 |
|---|---|---|
| committer | Linus Torvalds <torvalds@woody.linux-foundation.org> | 2007-01-26 13:51:00 -0800 |
| commit | 45f8bde0d0d6deb168b45998c72b4fbeb2f57efb (patch) | |
| tree | 69ffee8cc05f3ffaa437412f55832f7276125e8b /include/linux/list.h | |
| parent | a8d814b5dd7a1bc5c19ae32d35b8bd4d8a510eae (diff) | |
| download | linux-45f8bde0d0d6deb168b45998c72b4fbeb2f57efb.tar.gz linux-45f8bde0d0d6deb168b45998c72b4fbeb2f57efb.tar.bz2 linux-45f8bde0d0d6deb168b45998c72b4fbeb2f57efb.zip | |
[PATCH] fix various kernel-doc in header files
Fix a number of kernel-doc entries for header files in include/linux by
making sure they begin with the appropriate '/**' notation and use @var
notation.
Signed-off-by: Robert P. J. Day <rpjday@mindspring.com>
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@osdl.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'include/linux/list.h')
| -rw-r--r-- | include/linux/list.h | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/include/linux/list.h b/include/linux/list.h index a9c90287c0ff..611059d633f4 100644 --- a/include/linux/list.h +++ b/include/linux/list.h @@ -227,13 +227,13 @@ static inline void list_replace_init(struct list_head *old, INIT_LIST_HEAD(old); } -/* +/** * list_replace_rcu - replace old entry by new one * @old : the element to be replaced * @new : the new element to insert * - * The old entry will be replaced with the new entry atomically. - * Note: 'old' should not be empty. + * The @old entry will be replaced with the @new entry atomically. + * Note: @old should not be empty. */ static inline void list_replace_rcu(struct list_head *old, struct list_head *new) @@ -680,12 +680,12 @@ static inline void hlist_del_init(struct hlist_node *n) } } -/* +/** * hlist_replace_rcu - replace old entry by new one * @old : the element to be replaced * @new : the new element to insert * - * The old entry will be replaced with the new entry atomically. + * The @old entry will be replaced with the @new entry atomically. */ static inline void hlist_replace_rcu(struct hlist_node *old, struct hlist_node *new) |