12 Jan, 2010
1 commit
-
Remove comments about function short descriptions not allowed to be on
multiple lines (that was fixed/changed recently).Add comments that function "section header:" names need to be unique per
function/struct/union/typedef/enum.Signed-off-by: Randy Dunlap
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds
19 Sep, 2009
1 commit
-
Allow the short description after symbol name and dash in a kernel-doc
comment to span multiple lines, e.g. like this:/**
* unmap_mapping_range - unmap the portion of all mmaps in the
* specified address_space corresponding to the specified
* page range in the underlying file.
* @mapping: the address space containing mmaps to be unmapped.
* ...
*/The short description ends with a parameter description, an empty line
or the end of the comment block.Signed-off-by: Johannes Weiner
Signed-off-by: Randy Dunlap
Signed-off-by: Linus Torvalds
03 May, 2009
1 commit
-
scripts/kernel-doc can (incorrectly) delete struct members that are
surrounded by /* ... */ /* ... */ if there is a /*
private: */ comment in there somewhere also.Fix that by making the "/* private:" only allow whitespace between /* and
"private:", not anything/everything in the world.This fixes some erroneous kernel-doc warnings that popped up while
processing include/linux/usb/composite.h.Signed-off-by: Randy Dunlap
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds
12 Feb, 2009
1 commit
-
Fix kernel-doc-nano-HOWTO.txt to use */ as the ending marker in kernel-doc
examples and state that */ is the preferred ending marker.Signed-off-by: Randy Dunlap
Reported-by: Robert Love
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds
07 Jan, 2009
2 commits
-
Add info on how to use DOC: sections in kernel-doc. DOC: sections enable
the addition of inline source file comments that are general in nature
instead of being specific to a function, struct, union, enum, or typedef.Signed-off-by: Randy Dunlap
Cc: Johannes Berg
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds -
Add documentation on how to use kernel-doc for function parameters
that are "..." (varargs).Signed-off-by: Randy Dunlap
Cc: Rusty Russell
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds
26 Aug, 2008
1 commit
-
This patch adds kernel doc for the completion feature.
An error in the split-man.pl PERL snippet in kernel-doc-nano-HOWTO.txt is
also fixed.Signed-off-by: Kevin Diggs
Signed-off-by: Ingo Molnar
07 Jun, 2008
1 commit
-
Provide documentation of the kernel-doc documentation conventions oriented
to kernel hackers.Since I figure that there will be more people reading this
kernel-doc-nano-HOWTO.txt file who are kernel developers focused on the
rest of the kernel, than there will be readers of this file who are
documentation developers extracting that embedded kernel-doc
documentation, I have taken the liberty of making the new section added
here:How to format kernel-doc comments
the first section of the kernel-doc-nano-HOWTO.txt file.
This first section is intended to introduce, motivate and provide basic
usage of the kernel-doc mechanism for kernel hackers developing other
portions of the kernel.Signed-off-by: Paul Jackson
Acked-by: Randy Dunlap
Cc: Alan Cox
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds
12 Feb, 2007
2 commits
-
Explain a couple of the most common errors in kernel-doc usage.
Signed-off-by: Robert P. J. Day
Acked-by: Randy Dunlap
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds -
In kernel-doc syntax, be a little flexible: allow whitespace between
a function parameter name and the colon that must follow it, such as:
@pdev : PCI device to unplug(This allows lots of megaraid kernel-doc to work without tons of
editing.)Signed-off-by: Randy Dunlap
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds
04 Nov, 2006
1 commit
-
Correct a few comments in kernel-doc Doc and source files.
(akpm: note: the patch removes a non-ascii character and might have to be
applied by hand..)Signed-off-by: Randy Dunlap
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds
02 Feb, 2006
1 commit
-
- Add info that structs, unions, enums, and typedefs are supported.
- Add doc about "private:" and "public:" tags for struct fields.
- Fix some typos.
- Remove some trailing whitespace.
Signed-off-by: Randy Dunlap
Signed-off-by: Andrew Morton
Signed-off-by: Linus Torvalds
17 Apr, 2005
1 commit
-
Initial git repository build. I'm not bothering with the full history,
even though we have it. We can create a separate "historical" git
archive of that later if we want to, and in the meantime it's about
3.2GB when imported into git - space that would just make the early
git days unnecessarily complicated, when we don't have a lot of good
infrastructure for it.Let it rip!
