linux/Documentation/doc-guide
Randy Dunlap 91a3d6be99 doc-guide: kernel-doc: tell about object-like macros
Since 2014 kernel-doc has supported describing object-like macros
but it is not documented anywhere. I should have required some
documentation for it when I merged the patch. :(

There are currently only 3 uses of this (all in DRM headers, in
include/drm/*.h).

Add object-like macro kernel-doc documentation now so that more may
know about it and use it.

Fixes: cbb4d3e651 ("scripts/kernel-doc: handle object-like macros")
Signed-off-by: Randy Dunlap <rdunlap@infradead.org>
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: linux-doc@vger.kernel.org
Acked-by: Daniel Vetter <daniel.vetter@ffwll.ch>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
Link: https://lore.kernel.org/r/20240107012400.32587-1-rdunlap@infradead.org
2024-01-30 13:31:09 -07:00
..
contributing.rst docs: doc-guide: mention 'make refcheckdocs' 2023-10-22 20:38:55 -06:00
hello.dot docs-rst: automatically convert Graphviz and SVG images 2017-03-09 02:59:26 -07:00
index.rst Add a maintainer entry profile for documentation 2020-01-24 09:48:39 -07:00
kernel-doc.rst doc-guide: kernel-doc: tell about object-like macros 2024-01-30 13:31:09 -07:00
maintainer-profile.rst docs: add blurb about target audience to maintainer-profile 2024-01-30 13:16:46 -07:00
parse-headers.rst A handful of late-arriving docs fixes, along with a patch changing a lot of 2020-06-10 14:12:15 -07:00
sphinx.rst docs: Raise the minimum Sphinx requirement to 2.4.4 2023-12-15 08:36:33 -07:00
svg_image.svg docs-rst: automatically convert Graphviz and SVG images 2017-03-09 02:59:26 -07:00