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

[Randy Dunlap <randy.dunlap@oracle.com>]

Johannes Berg wrote:
> 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.

Uh, please try one more thing.  Delete the '*' line between
 * struct pm_ops - Callbacks ...

and the struct members list and retest that.

-- 
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***