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