X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=doxygen%2Fdoxygen.cfg;h=39a918f57362deae4e4ad1a193d6facee3c54fdf;hb=db14f5aff69311d13a0a90baa3567e92f3faa783;hp=6d6bb6ccf21578331156a38c902718b2d37c4381;hpb=b585097048884e063ac25aecc26a6802ee3faa4d;p=vpp.git
diff --git a/doxygen/doxygen.cfg b/doxygen/doxygen.cfg
index 6d6bb6ccf21..39a918f5736 100644
--- a/doxygen/doxygen.cfg
+++ b/doxygen/doxygen.cfg
@@ -230,6 +230,24 @@ TAB_SIZE = 8
ALIASES =
+## Indexes VPP graph nodes
+ALIASES += "node=@xrefitem nodes \"Node Identifier\" \"Node Identifiers\" @c "
+
+## Formatting for CLI commands and output
+ALIASES += "cli{1}=\1
"
+ALIASES += "clistart="
+ALIASES += "cliend=
"
+
+## Formatting for CLI example paragraphs
+ALIASES += "cliexpar=@par Example usage"
+ALIASES += "cliexcmd{1}=@clistartvpp# \1@cliend"
+ALIASES += "cliexstart{1}=@cliexcmd{\1}@clistart"
+ALIASES += "cliexend=@cliend"
+
+## Formatting for config directives
+ALIASES += "cfgcmd{2}=@par \1 \2
"
+ALIASES += "cfgcmd{1}=@par \1
"
+
# This tag can be used to specify a number of word-keyword mappings (TCL only).
# A mapping has the form "name=value". For example adding "class=itcl::class"
# will allow you to use the command class in the itcl::class meaning.
@@ -281,7 +299,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
@@ -629,7 +647,7 @@ GENERATE_DEPRECATEDLIST= YES
# sections, marked by \if ... \endif and \cond
# ... \endcond blocks.
-ENABLED_SECTIONS =
+ENABLED_SECTIONS = DPDK
# The MAX_INITIALIZER_LINES tag determines the maximum number of lines that the
# initial value of a variable or macro / define can have for it to appear in the
@@ -796,7 +814,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 *.cpp *.hpp *.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.
@@ -811,7 +829,7 @@ RECURSIVE = YES
# Note that relative paths are relative to the directory from which doxygen is
# run.
-EXCLUDE =
+EXCLUDE = $(EXCLUDE)
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
@@ -864,7 +882,8 @@ EXAMPLE_RECURSIVE = NO
# that contain images that are to be included in the documentation (see the
# \image command).
-IMAGE_PATH = $(ROOT)/doxygen/assets
+IMAGE_PATH = $(ROOT)/doxygen/assets \
+ $(ROOT)/extras/libmemif/docs
# The INPUT_FILTER tag can be used to specify a program that doxygen should
# invoke to filter for each input file. Doxygen will invoke the filter program
@@ -898,7 +917,10 @@ 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 \
+ *.h=$(ROOT)/doxygen/filter_h.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
@@ -2019,7 +2041,7 @@ SEARCH_INCLUDES = YES
# preprocessor.
# This tag requires that the tag SEARCH_INCLUDES is set to YES.
-INCLUDE_PATH =
+INCLUDE_PATH = $(INCLUDE_PATH)
# You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard
# patterns (like *.h and *.hpp) to filter out the header-files in the
@@ -2042,8 +2064,10 @@ PREDEFINED = \
__x86_64__ __X86_64__ __linux__ __LINUX__ __64BIT__ __64bit__ \
__ORDER_LITTLE_ENDIAN__=1234 \
__BYTE_ORDER__=1234 \
- __FLOAT_WORD_ORDER__=1234
-
+ __FLOAT_WORD_ORDER__=1234 \
+ DPDK=1 \
+ always_inline:="static inline"
+
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
# macro definition that is found in the sources will be used. Use the PREDEFINED
@@ -2086,7 +2110,7 @@ TAGFILES =
# tag file that is based on the input files it reads. See section "Linking to
# external documentation" for more information about the usage of tag files.
-GENERATE_TAGFILE = $(BUILD_ROOT)/docs/vpp.doxytags
+GENERATE_TAGFILE = $(BUILD_ROOT)/docs/html/vpp.doxytags
# If the ALLEXTERNALS tag is set to YES, all external class will be listed in
# the class index. If set to NO, only the inherited external classes will be