Skip to contentSkip to conversation

kernel-doc: allow structs whose members are all private

PATCH In review Randy Dunlap 2 participants 3 messages Sep 15, 2008

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 kernel-doc: allow structs whose members are all private

From: Randy Dunlap <[email protected]>

Fix kernel-doc to handle structs whose members are all private; otherwise invalid XML is generated:

xmlto: input does not validate (status 3)
linux-2.6.27-rc6-git4/Documentation/DocBook/debugobjects.xml:146: element variablelist: validity error : Element variablelist content does not follow the DTD, expecting ((title , titleabbrev?)? , varlistentry+), got () Document linux-2.6.27-rc6-git4/Documentation/DocBook/debugobjects.xml does not validate
make[1]: *** [Documentation/DocBook/debugobjects.html] Error 3

---
 scripts/kernel-doc |    4 ++++
 1 file changed, 4 insertions(+)
scripts/kernel-doc +4 -0
@@ -781,6 +781,7 @@ sub output_struct_xml(%) {
     print " <refsect1>\n";
     print "  <title>Members</title>\n";
 
+    if ($#{$args{'parameterlist'}} >= 0) {
     print "  <variablelist>\n";
     foreach $parameter (@{$args{'parameterlist'}}) {
       ($parameter =~ /^#/) && next;
@@ -798,6 +799,9 @@ sub output_struct_xml(%) {
       print "    </varlistentry>\n";
     }
     print "  </variablelist>\n";
+    } else {
+	print " <para>\n  None\n </para>\n";
+    }
     print " </refsect1>\n";
 
     output_section_xml(@_);
#1 lore raw
Quoted 4 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>

Fix kernel-doc to handle structs whose members are all private; otherwise invalid XML is generated:

What's supposed to be a private member?

#2 lore raw
Quoted 7 lines · On Mon, 15 Sep 2008 13:26:48 -0400 Christoph Hellwig wrote:
Quoted 4 lines · Randy Dunlap

From: Randy Dunlap <[email protected]>

Fix kernel-doc to handle structs whose members are all private; otherwise invalid XML is generated:

What's supposed to be a private member?

Struct members may be marked as private by using

	/* private: */

before them, as noted in Documentation/kernel-doc-nano-HOWTO.txt:

<quote>
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.

Example:

/**
* struct my_struct - short description
* @a: first member
* @b: second member
*
* Longer description
*/

struct my_struct {
    int a;
    int b;
/* private: */
    int c;
};

</quote>

---
~Randy