[<prev] [next>] [<thread-prev] [day] [month] [year] [list]
Message-Id: <20080915103154.9edf6f69.randy.dunlap@oracle.com>
Date: Mon, 15 Sep 2008 10:31:54 -0700
From: Randy Dunlap <randy.dunlap@...cle.com>
To: Christoph Hellwig <hch@...radead.org>
Cc: lkml <linux-kernel@...r.kernel.org>,
akpm <akpm@...ux-foundation.org>, samr <sam@...nborg.org>,
Roland McGrath <roland@...hat.com>
Subject: Re: [PATCH] kernel-doc: allow structs whose members are all private
On Mon, 15 Sep 2008 13:26:48 -0400 Christoph Hellwig wrote:
> On Mon, Sep 15, 2008 at 10:02:29AM -0700, Randy Dunlap wrote:
> > From: Randy Dunlap <randy.dunlap@...cle.com>
> >
> > 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
--
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@...r.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
Please read the FAQ at http://www.tux.org/lkml/
Powered by blists - more mailing lists