From: Jani Nikula <jani.nikula@intel.com>
To: Johannes Berg <johannes@sipsolutions.net>,
linux-wireless@vger.kernel.org
Cc: linux-doc@vger.kernel.org
Subject: Re: [PATCH 2/2] mac80211: use inline kernel-doc for struct ieee80211_hw
Date: Fri, 21 Oct 2016 16:18:18 +0300 [thread overview]
Message-ID: <87eg39q1r9.fsf@intel.com> (raw)
In-Reply-To: <1477054892.4068.44.camel@sipsolutions.net>
On Fri, 21 Oct 2016, Johannes Berg <johannes@sipsolutions.net> wrote:
> On Fri, 2016-10-21 at 15:57 +0300, Jani Nikula wrote:
>> 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
next prev parent reply other threads:[~2016-10-21 13:18 UTC|newest]
Thread overview: 13+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-10-21 12:57 [PATCH 1/2] mac80211: fix some sphinx warnings Jani Nikula
2016-10-21 12:57 ` [PATCH 2/2] mac80211: use inline kernel-doc for struct ieee80211_hw Jani Nikula
2016-10-21 13:01 ` Johannes Berg
2016-10-21 13:18 ` Jani Nikula [this message]
2016-10-21 18:59 ` Arend van Spriel
2016-10-21 19:56 ` Johannes Berg
2016-10-26 6:09 ` Johannes Berg
2016-10-26 8:36 ` Jani Nikula
2016-10-26 8:55 ` Johannes Berg
2016-10-21 13:01 ` [PATCH 1/2] mac80211: fix some sphinx warnings Johannes Berg
2016-10-21 13:14 ` Jani Nikula
2016-10-21 13:17 ` Johannes Berg
2016-10-26 6:02 ` Johannes Berg
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=87eg39q1r9.fsf@intel.com \
--to=jani.nikula@intel.com \
--cc=johannes@sipsolutions.net \
--cc=linux-doc@vger.kernel.org \
--cc=linux-wireless@vger.kernel.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.