Groups | Search | Server Info | Keyboard shortcuts | Login | Register [http] [https] [nntp] [nntps]
Groups > linux.kernel > #1524231
| From | Jani Nikula <jani.nikula@intel.com> |
|---|---|
| Newsgroups | linux.kernel |
| Subject | Re: [PATCH] doc: Document the new inline struct member kernel-doc style |
| Date | 2016-11-17 11:10 +0100 |
| Message-ID | <sErNN-7If-43@gated-at.bofh.it> (permalink) |
| References | <sEruq-7iB-17@gated-at.bofh.it> <sErE6-7my-9@gated-at.bofh.it> |
| Organization | Intel Finland Oy - BIC 0357606-4 - Westendinkatu 7, 02160 Espoo |
On Thu, 17 Nov 2016, Jani Nikula <jani.nikula@intel.com> wrote: > On Thu, 17 Nov 2016, Daniel Vetter <daniel.vetter@ffwll.ch> wrote: >> We don't just need better doc toolchains, we also need better docs for >> our doc toolchain! > > Mea culpa. Thanks, LGTM. Oh, the example struct now has too "foo" fields, documented twice. That's not good. BR, Jani. > > BR, > Jani. > > >> Cc: Daniel Vetter <daniel@ffwll.ch> >> Cc: Jani Nikula <jani.nikula@intel.com> >> Cc: Jonathan Corbet <corbet@lwn.net> >> Cc: linux-doc@vger.kernel.org >> Signed-off-by: Daniel Vetter <daniel.vetter@intel.com> >> --- >> Documentation/kernel-documentation.rst | 7 ++++++- >> 1 file changed, 6 insertions(+), 1 deletion(-) >> >> diff --git a/Documentation/kernel-documentation.rst b/Documentation/kernel-documentation.rst >> index 10cc7ddb6235..a5bd12d8bd4e 100644 >> --- a/Documentation/kernel-documentation.rst >> +++ b/Documentation/kernel-documentation.rst >> @@ -484,7 +484,10 @@ span multiple lines. The continuation lines may contain indentation. >> In-line member documentation comments >> ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ >> >> -The structure members may also be documented in-line within the definition:: >> +The structure members may also be documented in-line within the definition. >> +There are two styles, single-line comments where both the opening ``/**`` and >> +closing ``*/`` are on the same line, and multi-line comments where they are each >> +on a line of their own, like all other kernel-doc comments:: >> >> /** >> * struct foo - Brief description. >> @@ -502,6 +505,8 @@ The structure members may also be documented in-line within the definition:: >> * Here, the member description may contain several paragraphs. >> */ >> int baz; >> + /** @foo: Single line description. */ >> + int foo; >> } >> >> Private members -- Jani Nikula, Intel Open Source Technology Center
Back to linux.kernel | Previous | Next — Previous in thread | Next in thread | Find similar | Unroll thread
[PATCH] doc: Document the new inline struct member kernel-doc style Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-11-17 10:50 +0100
Re: [PATCH] doc: Document the new inline struct member kernel-doc style Jani Nikula <jani.nikula@intel.com> - 2016-11-17 11:00 +0100
Re: [PATCH] doc: Document the new inline struct member kernel-doc style Jani Nikula <jani.nikula@intel.com> - 2016-11-17 11:10 +0100
[PATCH] doc: Document the new inline struct member kernel-doc style Daniel Vetter <daniel.vetter@ffwll.ch> - 2016-11-17 11:30 +0100
Re: [PATCH] doc: Document the new inline struct member kernel-doc style Jani Nikula <jani.nikula@intel.com> - 2016-11-17 11:30 +0100
Re: [PATCH] doc: Document the new inline struct member kernel-doc style Jonathan Corbet <corbet@lwn.net> - 2016-11-19 18:40 +0100
csiph-web