[PATCH] Doc/kernel-doc: add more usage info

Take a look around the source tree for examples.

kernel-doc for structs, unions, enums, and typedefs

---------------------------------------------------

Beside functions you can also write documentation for structs, unions,

enums and typedefs. Instead of the function name you must write the name

of the declaration;  the struct/union/enum/typedef must always precede

the name. Nesting of declarations is not supported.

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

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;

};

How to make new SGML template files

-----------------------------------

Tim.

*/ <twaugh@redhat.com>

# Note: This only supports 'c'.

# usage:

# kerneldoc [ -docbook | -html | -text | -man ]

# kernel-doc [ -docbook | -html | -text | -man ]

#           [ -function funcname [ -function funcname ...] ] c file(s)s > outputfile

# or

#           [ -nofunction funcname [ -function funcname ...] ] c file(s)s > outputfile

#  -nofunction funcname

#	If set, then only generate documentation for the other function(s).  All

#	other functions are ignored. Cannot be used with -function together

#	(yes thats a bug - perl hackers can fix it 8))

#	(yes, that's a bug -- perl hackers can fix it 8))

#

#  c files - list of 'c' files to process

#

    print "<hr>\n";

}

# output tyepdef in html

# output typedef in html

sub output_typedef_html(%) {

    my %args = %{$_[0]};

    my ($parameter);