On Thu, Jan 18, 2018 at 05:33:15AM +0000, Bart Van Assche wrote: > On Thu, 2018-01-18 at 07:20 +0200, Leon Romanovsky wrote: > > Please read Documentation/doc-guide/kernel-doc.rst - "In-line member > > documentation comments" section. > > A quote from that document: > > <quote> > Structure, union, and enumeration documentation > ----------------------------------------------- > > The general format of a struct, union, and enum kernel-doc comment is:: > > /** > * struct struct_name - Brief description. > * @member_name: Description of member member_name. > * > * Description of the structure. > */ > </quote> > > Since the above syntax is shown first I think it's the preferred syntax. I like to have documentation in-place near their actual usage/declaration, so as long as one of the options won't be marked as mandatory, I'll leave my implementation. Thanks > > Bart.
Attachment:
signature.asc
Description: PGP signature
