Linux kernel mirror (for testing)
git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel
os
linux
docs: automarkup: Mark up undocumented entities too
The automarkup code generates markup and a cross-reference link for
functions, structs, etc. for which it finds kerneldoc documentation.
Undocumented entities are left untouched; that creates an inconsistent
reading experience and has caused some writers to go to extra measures to
cause the markup to happen.
Mark up detected C entities regardless of whether they are documented.
Reviewed-by: Mauro Carvalho Chehab <mchehab+huawei@kernel.org>
Signed-off-by: Jonathan Corbet <corbet@lwn.net>
+7
-2
+7
-2
Documentation/sphinx/automarkup.py
+7
-2
Documentation/sphinx/automarkup.py
···
235
235
236
236
if xref:
237
237
return xref
238
-
239
-
return None
238
+
#
239
+
# We didn't find the xref; if a container node was supplied,
240
+
# mark it as a broken xref
241
+
#
242
+
if contnode:
243
+
contnode.set_class("broken_xref")
244
+
return contnode
240
245
241
246
#
242
247
# Variant of markup_abi_ref() that warns whan a reference is not found