Re: [PATCH v3 1/2] Documentation/sphinx: allow "functions" with no parameters
From: Matthew Wilcox <willy@infradead.org>
Date: 2018-06-30 11:22:05
On Sat, Jun 30, 2018 at 12:05:10AM +0300, Mike Rapoport wrote:
quoted hunk ↗ jump to hunk
@@ -488,14 +488,19 @@ doc: *title* .. kernel-doc:: drivers/gpu/drm/i915/intel_audio.c :doc: High Definition Audio over HDMI and Display Port -functions: *function* *[...]* +functions: *[ function ...]* Include documentation for each *function* in *source*. + If no *function* if specified, the documentaion for all functions
"is specified". "documentation".
- Example::
+ Examples::
.. kernel-doc:: lib/bitmap.c
:functions: bitmap_parselist bitmap_parselist_user
+ .. kernel-doc:: lib/idr.c
+ :functions:
Is this the right syntax? Should we rather have:
.. kernel-doc:: lib/idr.c
:functions: *
--
To unsubscribe from this list: send the line "unsubscribe linux-doc" in
the body of a message to majordomo@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html