mirror of
https://github.com/torvalds/linux.git
synced 2025-08-15 22:21:42 +02:00
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>
This commit is contained in:
parent
2bf83bdbb2
commit
d6d1df92c2
1 changed files with 7 additions and 2 deletions
|
@ -235,8 +235,13 @@ def add_and_resolve_xref(app, docname, domain, reftype, target, contnode=None):
|
|||
|
||||
if xref:
|
||||
return xref
|
||||
|
||||
return None
|
||||
#
|
||||
# We didn't find the xref; if a container node was supplied,
|
||||
# mark it as a broken xref
|
||||
#
|
||||
if contnode:
|
||||
contnode.set_class("broken_xref")
|
||||
return contnode
|
||||
|
||||
#
|
||||
# Variant of markup_abi_ref() that warns whan a reference is not found
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue