---

yaml
---
r: 126399
b: refs/heads/master
c: 28f4d75
h: refs/heads/master
i:
  126397: f4f3f60
  126395: c104beb
  126391: e9a5b01
  126383: a15cc32
  126367: 60dda74
  126335: 7c9003f
v: v3

[refs]

@@ -1,2 +1,2 @@
 ---
-refs/heads/master: 58cc855c395fc22db996cc893134c4c690f0f0dc
+refs/heads/master: 28f4d75a618e52f93d8e4a3e7bc66db8c882d679

trunk/Documentation/kernel-doc-nano-HOWTO.txt

@@ -287,6 +287,32 @@ struct my_struct {
 };
 
 
+Including documentation blocks in source files
+----------------------------------------------
+
+To facilitate having source code and comments close together, you can
+include kernel-doc documentation blocks that are free-form comments
+instead of being kernel-doc for functions, structures, unions,
+enums, or typedefs.  This could be used for something like a
+theory of operation for a driver or library code, for example.
+
+This is done by using a DOC: section keyword with a section title.  E.g.:
+
+/**
+ * DOC: Theory of Operation
+ *
+ * The whizbang foobar is a dilly of a gizmo.  It can do whatever you
+ * want it to do, at any time.  It reads your mind.  Here's how it works.
+ *
+ * foo bar splat
+ *
+ * The only drawback to this gizmo is that is can sometimes damage
+ * hardware, software, or its subject(s).
+ */
+
+DOC: sections are used in SGML templates files as indicated below.
+
+
 How to make new SGML template files
 -----------------------------------
 
@@ -307,6 +333,9 @@ exported using EXPORT_SYMBOL.
 !F<filename> <function [functions...]> is replaced by the
 documentation, in <filename>, for the functions listed.
 
+!P<filename> <section title> is replaced by the contents of the DOC:
+section titled <section title> from <filename>.
+Spaces are allowed in <section title>; do not quote the <section title>.
 
 Tim.
 */ <twaugh@redhat.com>