Skip to content

Commit 86d3065

Browse files
committed
doc: tweak doxygen precondition label
The doxygen-collected API information about function preconditions has a uninspired title of "pre". This change tweaks that to be "preconditions" in the generated HTML output by editing the generated xml output before it is processed by Sphinx/Breathe. Signed-off-by: David B. Kinder <david.b.kinder@intel.com>
1 parent 4887736 commit 86d3065

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

doc/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,7 @@ help:
4040

4141
doxy:
4242
$(Q)(cat acrn.doxyfile) | doxygen - > doc.log 2>&1
43+
$(Q)find doxygen/xml/* | xargs sed -i 's/simplesect kind="pre"/simplesect kind="preconditions"/'
4344

4445
content:
4546
$(Q)scripts/extract_content.py . tools
@@ -51,7 +52,6 @@ kconfig:
5152
pullsource:
5253
$(Q)scripts/pullsource.sh
5354

54-
5555
html: doxy content kconfig
5656
-$(Q)$(SPHINXBUILD) -t $(DOC_TAG) -b html -d $(BUILDDIR)/doctrees $(SOURCEDIR) $(BUILDDIR)/html $(SPHINXOPTS) $(OPTS) >> doc.log 2>&1
5757
$(Q)./scripts/filter-doc-log.sh doc.log

0 commit comments

Comments
 (0)