Point out a couple minor details about "private:" structure members.
Signed-off-by: Robert P. J. Day <rpjday@xxxxxxxxxxxxxx>
---
diff --git a/Documentation/kernel-doc-nano-HOWTO.txt b/Documentation/kernel-doc-nano-HOWTO.txt
index acbc1a3..ff147b1 100644
--- a/Documentation/kernel-doc-nano-HOWTO.txt
+++ b/Documentation/kernel-doc-nano-HOWTO.txt
@@ -302,6 +302,14 @@ struct my_struct {
int c;
};
+Note that you can switch between public and private structure members
+arbitrarily, although that will probably be confusing to anyone reading
+your code.
+
+Note also that you can still use kernel-doc to document private structure
+members in the standard way, although doing this will generate build
+warnings complaining about "excess" structure members -- you're free to
+ignore such warnings as they don't affect the final output.
Including documentation blocks in source files
----------------------------------------------
--
========================================================================
Robert P. J. Day Ottawa, Ontario, CANADA
http://crashcourse.ca
Twitter: http://twitter.com/rpjday
LinkedIn: http://ca.linkedin.com/in/rpjday
========================================================================
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
