github/acrn-hypervisor
1
0
Fork 0
mirror of https://github.com/projectacrn/acrn-hypervisor.git synced 2025-07-31 07:20:55 +00:00
Code Issues Projects Releases Wiki Activity

doc: tweak doxygen precondition label

Browse Source 
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>
This commit is contained in:
David B. Kinder 2019-06-17 10:59:53 -07:00 committed by David Kinder
parent 48877362c6
commit 86d3065de1
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/Makefile
View File

@ -40,6 +40,7 @@ help:
doxy:
$(Q)(cat acrn.doxyfile) | doxygen - > doc.log 2>&1
$(Q)find doxygen/xml/* | xargs sed -i 's/simplesect kind="pre"/simplesect kind="preconditions"/'
content:
$(Q)scripts/extract_content.py . tools
@ -51,7 +52,6 @@ kconfig:
pullsource:
$(Q)scripts/pullsource.sh
html: doxy content kconfig
-$(Q)$(SPHINXBUILD) -t $(DOC_TAG) -b html -d $(BUILDDIR)/doctrees $(SOURCEDIR) $(BUILDDIR)/html $(SPHINXOPTS) $(OPTS) >> doc.log 2>&1
$(Q)./scripts/filter-doc-log.sh doc.log