git://ftp.safe.ca
/
safe
/
jmp
/
linux-2.6
/ blobdiff
commit
grep
author
committer
pickaxe
?
search:
re
summary
|
shortlog
|
log
|
commit
|
commitdiff
|
tree
raw
|
inline
| side by side
nfsd: track last inode only in use_wgather case
[safe/jmp/linux-2.6]
/
Documentation
/
kernel-doc-nano-HOWTO.txt
diff --git
a/Documentation/kernel-doc-nano-HOWTO.txt
b/Documentation/kernel-doc-nano-HOWTO.txt
index
026ec7d
..
4d04572
100644
(file)
--- a/
Documentation/kernel-doc-nano-HOWTO.txt
+++ b/
Documentation/kernel-doc-nano-HOWTO.txt
@@
-269,7
+269,10
@@
Use the argument mechanism to document members or constants.
Inside a struct description, you can use the "private:" and "public:"
comment tags. Structure fields that are inside a "private:" area
Inside a struct description, you can use the "private:" and "public:"
comment tags. Structure fields that are inside a "private:" area
-are not listed in the generated output documentation.
+are not listed in the generated output documentation. The "private:"
+and "public:" tags must begin immediately following a "/*" comment
+marker. They may optionally include comments between the ":" and the
+ending "*/" marker.
Example:
Example:
@@
-283,7
+286,7
@@
Example:
struct my_struct {
int a;
int b;
struct my_struct {
int a;
int b;
-/* private: */
+/* private:
internal use only
*/
int c;
};
int c;
};