dmadev: introduce DMA device library
[dpdk.git] / doc / api / doxy-api.conf.in
1 # SPDX-License-Identifier: BSD-3-Clause
2 # Copyright 2013-2017 6WIND S.A.
3
4 PROJECT_NAME            = DPDK
5 PROJECT_NUMBER          = @VERSION@
6 USE_MDFILE_AS_MAINPAGE  = @TOPDIR@/doc/api/doxy-api-index.md
7 INPUT                   = @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/dmadev \
39                           @TOPDIR@/lib/efd \
40                           @TOPDIR@/lib/ethdev \
41                           @TOPDIR@/lib/eventdev \
42                           @TOPDIR@/lib/fib \
43                           @TOPDIR@/lib/flow_classify \
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/pci \
63                           @TOPDIR@/lib/pdump \
64                           @TOPDIR@/lib/pipeline \
65                           @TOPDIR@/lib/port \
66                           @TOPDIR@/lib/power \
67                           @TOPDIR@/lib/rawdev \
68                           @TOPDIR@/lib/rcu \
69                           @TOPDIR@/lib/regexdev \
70                           @TOPDIR@/lib/reorder \
71                           @TOPDIR@/lib/rib \
72                           @TOPDIR@/lib/ring \
73                           @TOPDIR@/lib/sched \
74                           @TOPDIR@/lib/security \
75                           @TOPDIR@/lib/stack \
76                           @TOPDIR@/lib/table \
77                           @TOPDIR@/lib/telemetry \
78                           @TOPDIR@/lib/timer \
79                           @TOPDIR@/lib/vhost
80 INPUT                   += @API_EXAMPLES@
81 FILE_PATTERNS           = rte_*.h \
82                           cmdline.h
83 PREDEFINED              = __DOXYGEN__ \
84                           RTE_HAS_CPUSET \
85                           VFIO_PRESENT \
86                           __attribute__(x)=
87
88 OPTIMIZE_OUTPUT_FOR_C   = YES
89 ENABLE_PREPROCESSING    = YES
90 MACRO_EXPANSION         = YES
91 EXPAND_ONLY_PREDEF      = YES
92 EXTRACT_STATIC          = YES
93 DISTRIBUTE_GROUP_DOC    = YES
94 HIDE_UNDOC_MEMBERS      = YES
95 HIDE_UNDOC_CLASSES      = YES
96 HIDE_SCOPE_NAMES        = YES
97 GENERATE_DEPRECATEDLIST = YES
98 VERBATIM_HEADERS        = NO
99 ALPHABETICAL_INDEX      = NO
100
101 HTML_TIMESTAMP          = NO
102 HTML_DYNAMIC_SECTIONS   = YES
103 SEARCHENGINE            = YES
104 SORT_MEMBER_DOCS        = NO
105 SOURCE_BROWSER          = YES
106
107 EXAMPLE_PATH            = @TOPDIR@/examples
108 EXAMPLE_PATTERNS        = *.c
109 EXAMPLE_RECURSIVE       = YES
110
111 OUTPUT_DIRECTORY        = @OUTPUT@
112 STRIP_FROM_PATH         = @STRIP_FROM_PATH@
113 GENERATE_HTML           = YES
114 HTML_OUTPUT             = @HTML_OUTPUT@
115 GENERATE_LATEX          = NO
116 GENERATE_MAN            = NO
117
118 HAVE_DOT                = NO
119
120 WARN_AS_ERROR           = @WARN_AS_ERROR@