kernel-doc: add support for one line inline struct member doc comments
authorJani Nikula <jani.nikula@intel.com>
Wed, 16 Nov 2016 15:26:16 +0000 (17:26 +0200)
committerJonathan Corbet <corbet@lwn.net>
Wed, 16 Nov 2016 23:30:27 +0000 (16:30 -0700)
commit0c9aa209579d41c9b8bf1fc39ce042bea2ec422d
treeb6814f726e98072f37c9d1a40a8128f4d21171ab
parentdc92726e7f8d9e400ae4fa42fde4c3a5020fcbb8
kernel-doc: add support for one line inline struct member doc comments

kernel-doc supports documenting struct members "inline" since
a4c6ebede2f9 ("scripts/kernel-doc Allow struct arguments documentation
in struct body"). This requires the inline kernel-doc comments to have
the opening and closing comment markers (/** and */ respectively) on
lines of their own, even for short comments. For example:

/**
 * struct foo - struct documentation
 */
struct foo {
/**
 * @bar: member documentation
 */
int bar;
};

Add support for one line inline comments:

/**
 * struct foo - struct documentation
 */
struct foo {
/** @bar: member documentation */
int bar;
};

Note that mixing of the two in one doc comment is not allowed; either
both comment markers must be on lines of their own, or both must be on
the one line. This limitation keeps both the comments more uniform, and
kernel-doc less complicated.

Cc: Daniel Vetter <daniel@ffwll.ch>
Signed-off-by: Jani Nikula <jani.nikula@intel.com>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
scripts/kernel-doc