doc-guide: kernel-doc: tell about object-like macros
authorRandy Dunlap <rdunlap@infradead.org>
Sun, 7 Jan 2024 01:24:00 +0000 (17:24 -0800)
committerJonathan Corbet <corbet@lwn.net>
Tue, 30 Jan 2024 20:31:09 +0000 (13:31 -0700)
commit91a3d6be99e63f6b0a4b2983aef20bd3da2d1a74
tree7c1a15fe1cf996a30ec1b08896c123dafd26cc87
parentd2a70e28ef738765f9226731dfdb3b6c06565456
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: cbb4d3e6510b ("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
Documentation/doc-guide/kernel-doc.rst