diff options
| author |   Chris Luke <chrisy@flirble.org> | 2016-05-14 12:17:12 -0400 |
|---|---|---|
| committer |   Keith Burns <alagalah@gmail.com> | 2016-05-15 13:22:54 +0000 |
| commit | 75a37b372efc2b4a324aa38b53487b8168358a63 (patch) | |
| tree | 723b47db3ecf25492cad6076efc8a8f5e1162130 /doxygen/doxygen.cfg | |
| parent | 7e55d364fd88bb462c7211209f5cbb5bbae3a68c (diff) | |
VPP-62 Add a doxy filter to enable vpe.api doc
This makes Doxygen think the API definitions are structs which is close
enough to be able to document the API methods.
It also has logic to create an indexed API page but that's disabled for
now because it duplicates the "brief" text twice in the struct doc.
Fixes a minor line numbering issue in filter_c.py.
Change-Id: If380160b73e7c10d999b35a76f55d0e27cbc91cc
Signed-off-by: Chris Luke <chrisy@flirble.org>
Diffstat (limited to 'doxygen/doxygen.cfg')
| -rw-r--r-- | doxygen/doxygen.cfg | 8 |
1 files changed, 5 insertions, 3 deletions
diff --git a/doxygen/doxygen.cfg b/doxygen/doxygen.cfg index 6d6bb6ccf21..ec4312c9fe7 100644 --- a/doxygen/doxygen.cfg +++ b/doxygen/doxygen.cfg @@ -281,7 +281,7 @@ OPTIMIZE_OUTPUT_VHDL = NO # Note that for custom extensions you also need to set FILE_PATTERNS otherwise # the files are not read by doxygen. -EXTENSION_MAPPING = def=C +EXTENSION_MAPPING = def=C api=C # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments # according to the Markdown format, which allows for more readable @@ -796,7 +796,7 @@ INPUT_ENCODING = UTF-8 # *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f, *.for, *.tcl, # *.vhd, *.vhdl, *.ucf, *.qsf, *.as and *.js. -FILE_PATTERNS = *.md *.c *.h *.def *.inc *.S *.dox +FILE_PATTERNS = *.md *.c *.h *.def *.inc *.S *.dox *.api # The RECURSIVE tag can be used to specify whether or not subdirectories should # be searched for input files as well. @@ -898,7 +898,9 @@ INPUT_FILTER = # need to set EXTENSION_MAPPING for the extension otherwise the files are not # properly processed by doxygen. -FILTER_PATTERNS = *.c=$(ROOT)/doxygen/filter_c.py +FILTER_PATTERNS = \ + *.c=$(ROOT)/doxygen/filter_c.py \ + *.api=$(ROOT)/doxygen/filter_api.py # If the FILTER_SOURCE_FILES tag is set to YES, the input filter (if set using # INPUT_FILTER) will also be used to filter the input files that are used for |