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