Re: [PATCH] power management: no valid states w/o pm_ops + docs

[Johannes Berg <johannes@sipsolutions.net>]

[-- Attachment #1.1: Type: text/plain, Size: 1137 bytes --]

On Tue, 2007-02-13 at 09:41 -0800, Randy Dunlap wrote:

> >>  * struct pm_ops - callbacks for managing platform-dependent suspend states
> > 
> > But then the description "callbacks for ..." disappears completely in
> > the HTML output! Should I duplicate it or something?
> 
> No, it's right there by the struct name (top line).
> As you have it, it shows up at the bottom, after the struct members,
> doesn't it (i.e., out of order)?

I now have:

/**
 * struct pm_ops - Callbacks for managing platform dependent suspend states.
 *
 *... (rest kept identical)
 */

and it's not there for me (output of
  ./scripts/kernel-doc -html include/linux/pm.h
attached). I also get an empty "Description" section.

But yes, if I put it into the third line then it shows up in the
"Description" section which is all the way down.

I think I'll put this down to a bug in the html output (that maybe you
get to fix? :) ), I just tested text and man output now and they both
look fine as you describe.

> I would probably just indent all of them by one tab.  Don't worry about
> the @verylong one.

ok.

johannes

[-- Attachment #1.2: pm.html --]
[-- Type: text/html, Size: 2115 bytes --]

[-- Attachment #2: This is a digitally signed message part --]
[-- Type: application/pgp-signature, Size: 190 bytes --]

[-- Attachment #3: Type: text/plain, Size: 0 bytes --]