xref: /dpdk/doc/api/doxy-api.conf.in (revision 97433132c2edda70ff69843b8f9273853cac984c)
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/event/cnxk \
13                          @TOPDIR@/drivers/mempool/cnxk \
14                          @TOPDIR@/drivers/mempool/dpaa2 \
15                          @TOPDIR@/drivers/net/ark \
16                          @TOPDIR@/drivers/net/bnxt \
17                          @TOPDIR@/drivers/net/bonding \
18                          @TOPDIR@/drivers/net/cnxk \
19                          @TOPDIR@/drivers/net/dpaa \
20                          @TOPDIR@/drivers/net/dpaa2 \
21                          @TOPDIR@/drivers/net/i40e \
22                          @TOPDIR@/drivers/net/iavf \
23                          @TOPDIR@/drivers/net/ixgbe \
24                          @TOPDIR@/drivers/net/mlx5 \
25                          @TOPDIR@/drivers/net/softnic \
26                          @TOPDIR@/drivers/raw/dpaa2_cmdif \
27                          @TOPDIR@/drivers/raw/ifpga \
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/dispatcher \
39                          @TOPDIR@/lib/distributor \
40                          @TOPDIR@/lib/dmadev \
41                          @TOPDIR@/lib/efd \
42                          @TOPDIR@/lib/ethdev \
43                          @TOPDIR@/lib/eventdev \
44                          @TOPDIR@/lib/fib \
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/kvargs \
54                          @TOPDIR@/lib/latencystats \
55                          @TOPDIR@/lib/log \
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/mldev \
63                          @TOPDIR@/lib/node \
64                          @TOPDIR@/lib/net \
65                          @TOPDIR@/lib/pcapng \
66                          @TOPDIR@/lib/pci \
67                          @TOPDIR@/lib/pdcp \
68                          @TOPDIR@/lib/pdump \
69                          @TOPDIR@/lib/pipeline \
70                          @TOPDIR@/lib/port \
71                          @TOPDIR@/lib/power \
72                          @TOPDIR@/lib/rawdev \
73                          @TOPDIR@/lib/rcu \
74                          @TOPDIR@/lib/regexdev \
75                          @TOPDIR@/lib/reorder \
76                          @TOPDIR@/lib/rib \
77                          @TOPDIR@/lib/ring \
78                          @TOPDIR@/lib/sched \
79                          @TOPDIR@/lib/security \
80                          @TOPDIR@/lib/stack \
81                          @TOPDIR@/lib/table \
82                          @TOPDIR@/lib/telemetry \
83                          @TOPDIR@/lib/timer \
84                          @TOPDIR@/lib/vhost
85INPUT                   += @API_EXAMPLES@
86FILE_PATTERNS           = rte_*.h \
87                          cmdline.h
88PREDEFINED              = __DOXYGEN__ \
89                          RTE_ATOMIC \
90                          RTE_HAS_CPUSET \
91                          VFIO_PRESENT \
92                          __rte_lockable= \
93                          __rte_guarded_by(x)= \
94                          __rte_exclusive_locks_required(x)= \
95                          __rte_exclusive_lock_function(x)= \
96                          __rte_exclusive_trylock_function(x)= \
97                          __rte_assert_exclusive_lock(x)= \
98                          __rte_shared_locks_required(x)= \
99                          __rte_shared_lock_function(x)= \
100                          __rte_shared_trylock_function(x)= \
101                          __rte_assert_shared_lock(x)= \
102                          __rte_unlock_function(x)= \
103                          __attribute__(x)=
104
105OPTIMIZE_OUTPUT_FOR_C   = YES
106ENABLE_PREPROCESSING    = YES
107MACRO_EXPANSION         = YES
108EXPAND_ONLY_PREDEF      = YES
109EXTRACT_STATIC          = YES
110DISTRIBUTE_GROUP_DOC    = YES
111HIDE_UNDOC_MEMBERS      = YES
112HIDE_UNDOC_CLASSES      = YES
113HIDE_SCOPE_NAMES        = YES
114GENERATE_DEPRECATEDLIST = YES
115VERBATIM_HEADERS        = NO
116ALPHABETICAL_INDEX      = NO
117
118HTML_DYNAMIC_SECTIONS   = YES
119HTML_EXTRA_STYLESHEET   = @TOPDIR@/doc/api/custom.css
120SEARCHENGINE            = YES
121SORT_MEMBER_DOCS        = NO
122SOURCE_BROWSER          = YES
123
124EXAMPLE_PATH            = @TOPDIR@/examples
125EXAMPLE_PATTERNS        = *.c
126EXAMPLE_RECURSIVE       = YES
127
128OUTPUT_DIRECTORY        = @OUTPUT@
129FULL_PATH_NAMES         = @FULL_PATH_NAMES@
130STRIP_FROM_PATH         = @STRIP_FROM_PATH@
131GENERATE_HTML           = @GENERATE_HTML@
132HTML_OUTPUT             = html
133GENERATE_LATEX          = NO
134GENERATE_MAN            = @GENERATE_MAN@
135MAN_LINKS               = YES
136
137HAVE_DOT                = NO
138
139WARN_AS_ERROR           = @WARN_AS_ERROR@
140