Re: [PATCH 2/2] mac80211: use inline kernel-doc for struct ieee80211_hw
From: Jani Nikula <hidden>
Date: 2016-10-21 13:18:22
From: Jani Nikula <hidden>
Date: 2016-10-21 13:18:22
On Fri, 21 Oct 2016, Johannes Berg [off-list ref] wrote:
On Fri, 2016-10-21 at 15:57 +0300, Jani Nikula wrote:quoted
It's easier to manage the kernel-doc for the fields when they documentation is next to the field.Hah, I wasn't even aware this was possible. Thanks!
It is indeed. And this lets you have multi-paragraph descriptions for fields which would be impossible in the top level struct kernel-doc, because you can't have blank lines in the field descriptions there. Currently you can't have one line inline /** @foo: bar */ descriptions though, the opening and closing comment markers still need to be on their own lines. Maybe I'll get around to fixing that one of these days... BR, Jani. -- Jani Nikula, Intel Open Source Technology Center