xref: /dpdk/doc/api/doxy-api.conf.in (revision 9c30a6f3c9a456e8111a2b1e5f6c2c02a62025b6)
1# SPDX-License-Identifier: BSD-3-Clause
2# Copyright 2013-2017 6WIND S.A.
3
4PROJECT_NAME            = DPDK
5PROJECT_NUMBER          = @VERSION@
6USE_MDFILE_AS_MAINPAGE  = @TOPDIR@/doc/api/doxy-api-index.md
7INPUT                   = @TOPDIR@/doc/api/doxy-api-index.md \
8                          @TOPDIR@/drivers/bus/vdev \
9                          @TOPDIR@/drivers/crypto/scheduler \
10                          @TOPDIR@/drivers/event/dlb2 \
11                          @TOPDIR@/drivers/mempool/dpaa2 \
12                          @TOPDIR@/drivers/net/ark \
13                          @TOPDIR@/drivers/net/bnxt \
14                          @TOPDIR@/drivers/net/bonding \
15                          @TOPDIR@/drivers/net/dpaa \
16                          @TOPDIR@/drivers/net/dpaa2 \
17                          @TOPDIR@/drivers/net/i40e \
18                          @TOPDIR@/drivers/net/iavf \
19                          @TOPDIR@/drivers/net/ice \
20                          @TOPDIR@/drivers/net/ixgbe \
21                          @TOPDIR@/drivers/net/mlx5 \
22                          @TOPDIR@/drivers/net/softnic \
23                          @TOPDIR@/drivers/raw/dpaa2_cmdif \
24                          @TOPDIR@/drivers/raw/dpaa2_qdma \
25                          @TOPDIR@/drivers/raw/ifpga \
26                          @TOPDIR@/drivers/raw/ioat \
27                          @TOPDIR@/lib/eal/include \
28                          @TOPDIR@/lib/eal/include/generic \
29                          @TOPDIR@/lib/acl \
30                          @TOPDIR@/lib/bbdev \
31                          @TOPDIR@/lib/bitratestats \
32                          @TOPDIR@/lib/bpf \
33                          @TOPDIR@/lib/cfgfile \
34                          @TOPDIR@/lib/cmdline \
35                          @TOPDIR@/lib/compressdev \
36                          @TOPDIR@/lib/cryptodev \
37                          @TOPDIR@/lib/distributor \
38                          @TOPDIR@/lib/efd \
39                          @TOPDIR@/lib/ethdev \
40                          @TOPDIR@/lib/eventdev \
41                          @TOPDIR@/lib/fib \
42                          @TOPDIR@/lib/flow_classify \
43                          @TOPDIR@/lib/graph \
44                          @TOPDIR@/lib/gro \
45                          @TOPDIR@/lib/gso \
46                          @TOPDIR@/lib/hash \
47                          @TOPDIR@/lib/ip_frag \
48                          @TOPDIR@/lib/ipsec \
49                          @TOPDIR@/lib/jobstats \
50                          @TOPDIR@/lib/kni \
51                          @TOPDIR@/lib/kvargs \
52                          @TOPDIR@/lib/latencystats \
53                          @TOPDIR@/lib/lpm \
54                          @TOPDIR@/lib/mbuf \
55                          @TOPDIR@/lib/member \
56                          @TOPDIR@/lib/mempool \
57                          @TOPDIR@/lib/meter \
58                          @TOPDIR@/lib/metrics \
59                          @TOPDIR@/lib/node \
60                          @TOPDIR@/lib/net \
61                          @TOPDIR@/lib/pci \
62                          @TOPDIR@/lib/pdump \
63                          @TOPDIR@/lib/pipeline \
64                          @TOPDIR@/lib/port \
65                          @TOPDIR@/lib/power \
66                          @TOPDIR@/lib/rawdev \
67                          @TOPDIR@/lib/rcu \
68                          @TOPDIR@/lib/regexdev \
69                          @TOPDIR@/lib/reorder \
70                          @TOPDIR@/lib/rib \
71                          @TOPDIR@/lib/ring \
72                          @TOPDIR@/lib/sched \
73                          @TOPDIR@/lib/security \
74                          @TOPDIR@/lib/stack \
75                          @TOPDIR@/lib/table \
76                          @TOPDIR@/lib/telemetry \
77                          @TOPDIR@/lib/timer \
78                          @TOPDIR@/lib/vhost
79INPUT                   += @API_EXAMPLES@
80FILE_PATTERNS           = rte_*.h \
81                          cmdline.h
82PREDEFINED              = __DOXYGEN__ \
83                          RTE_HAS_CPUSET \
84                          VFIO_PRESENT \
85                          __attribute__(x)=
86
87OPTIMIZE_OUTPUT_FOR_C   = YES
88ENABLE_PREPROCESSING    = YES
89MACRO_EXPANSION         = YES
90EXPAND_ONLY_PREDEF      = YES
91EXTRACT_STATIC          = YES
92DISTRIBUTE_GROUP_DOC    = YES
93HIDE_UNDOC_MEMBERS      = YES
94HIDE_UNDOC_CLASSES      = YES
95HIDE_SCOPE_NAMES        = YES
96GENERATE_DEPRECATEDLIST = YES
97VERBATIM_HEADERS        = NO
98ALPHABETICAL_INDEX      = NO
99
100HTML_TIMESTAMP          = NO
101HTML_DYNAMIC_SECTIONS   = YES
102SEARCHENGINE            = YES
103SORT_MEMBER_DOCS        = NO
104SOURCE_BROWSER          = YES
105
106EXAMPLE_PATH            = @TOPDIR@/examples
107EXAMPLE_PATTERNS        = *.c
108EXAMPLE_RECURSIVE       = YES
109
110OUTPUT_DIRECTORY        = @OUTPUT@
111STRIP_FROM_PATH         = @STRIP_FROM_PATH@
112GENERATE_HTML           = YES
113HTML_OUTPUT             = @HTML_OUTPUT@
114GENERATE_LATEX          = NO
115GENERATE_MAN            = NO
116
117HAVE_DOT                = NO
118
119WARN_AS_ERROR           = @WARN_AS_ERROR@
120