diff options
author | Jani Nikula <jani.nikula@intel.com> | 2016-11-16 18:26:16 +0300 |
---|---|---|
committer | Jonathan Corbet <corbet@lwn.net> | 2016-11-17 02:30:27 +0300 |
commit | 0c9aa209579d41c9b8bf1fc39ce042bea2ec422d (patch) | |
tree | b6814f726e98072f37c9d1a40a8128f4d21171ab /drivers/ata | |
parent | dc92726e7f8d9e400ae4fa42fde4c3a5020fcbb8 (diff) | |
download | linux-0c9aa209579d41c9b8bf1fc39ce042bea2ec422d.tar.xz |
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>
Diffstat (limited to 'drivers/ata')
0 files changed, 0 insertions, 0 deletions