On 04/20/18 17:07, Luis R. Rodriguez wrote: > On Sat, Apr 21, 2018 at 12:01:31AM +0000, Bart Van Assche wrote: >> On Fri, 2018-04-20 at 16:59 -0700, Luis R. Rodriguez wrote: >>> +/** >>> + * thaw_super -- unlock filesystem >>> + * @sb: the super to thaw >>> + * >>> + * Unlocks the filesystem and marks it writeable again after >>> freeze_super(). >>> + */ >> >> Have you verified the output generated by scripts/kernel-doc? Last >> time I checked the output for headers containing a double dash looked >> weird. > > No, I just moved the block of kdoc crap. Randy would have this memorized I'm > sure though so I should just fix the kdoc if its bad while at it. > > Luis >
"--" does sound odd. I've never seen it used on purpose. FWIW, I just go by what is in Documentation/doc-guide/kernel-doc.rst: Function documentation ---------------------- The general format of a function and function-like macro kernel-doc comment is:: /** * function_name() - Brief description of function. * @arg1: Describe the first argument. * @arg2: Describe the second argument. * One can provide multiple line descriptions * for arguments. -- ~Randy
