diff options
author | Randy Dunlap <randy.dunlap@oracle.com> | 2008-03-19 20:00:40 -0400 |
---|---|---|
committer | Linus Torvalds <torvalds@linux-foundation.org> | 2008-03-19 21:53:35 -0400 |
commit | 7682486b3ee06f800d5b11033371c7c5e92e3057 (patch) | |
tree | d0c2eda3204b085fc63200c787b2cf04f0298729 /mm/vmalloc.c | |
parent | 6cb2a21049b8990df4576c5fce4d48d0206c22d5 (diff) |
mm: fix various kernel-doc comments
Fix various kernel-doc notation in mm/:
filemap.c: add function short description; convert 2 to kernel-doc
fremap.c: change parameter 'prot' to @prot
pagewalk.c: change "-" in function parameters to ":"
slab.c: fix short description of kmem_ptr_validate()
swap.c: fix description & parameters of put_pages_list()
swap_state.c: fix function parameters
vmalloc.c: change "@returns" to "Returns:" since that is not a parameter
Signed-off-by: Randy Dunlap <randy.dunlap@oracle.com>
Signed-off-by: Andrew Morton <akpm@linux-foundation.org>
Signed-off-by: Linus Torvalds <torvalds@linux-foundation.org>
Diffstat (limited to 'mm/vmalloc.c')
-rw-r--r-- | mm/vmalloc.c | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/mm/vmalloc.c b/mm/vmalloc.c index 950c0be9ca81..ecf91f8034bf 100644 --- a/mm/vmalloc.c +++ b/mm/vmalloc.c | |||
@@ -757,7 +757,8 @@ finished: | |||
757 | * @vma: vma to cover (map full range of vma) | 757 | * @vma: vma to cover (map full range of vma) |
758 | * @addr: vmalloc memory | 758 | * @addr: vmalloc memory |
759 | * @pgoff: number of pages into addr before first page to map | 759 | * @pgoff: number of pages into addr before first page to map |
760 | * @returns: 0 for success, -Exxx on failure | 760 | * |
761 | * Returns: 0 for success, -Exxx on failure | ||
761 | * | 762 | * |
762 | * This function checks that addr is a valid vmalloc'ed area, and | 763 | * This function checks that addr is a valid vmalloc'ed area, and |
763 | * that it is big enough to cover the vma. Will return failure if | 764 | * that it is big enough to cover the vma. Will return failure if |
@@ -829,7 +830,8 @@ static int f(pte_t *pte, pgtable_t table, unsigned long addr, void *data) | |||
829 | /** | 830 | /** |
830 | * alloc_vm_area - allocate a range of kernel address space | 831 | * alloc_vm_area - allocate a range of kernel address space |
831 | * @size: size of the area | 832 | * @size: size of the area |
832 | * @returns: NULL on failure, vm_struct on success | 833 | * |
834 | * Returns: NULL on failure, vm_struct on success | ||
833 | * | 835 | * |
834 | * This function reserves a range of kernel address space, and | 836 | * This function reserves a range of kernel address space, and |
835 | * allocates pagetables to map that range. No actual mappings | 837 | * allocates pagetables to map that range. No actual mappings |