xref: /dpdk/doc/api/doxy-api.conf.in (revision bc8e32473cc3978d763a1387eaa8244bcf75e77d)
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/dlb \
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/dpaa \
17                          @TOPDIR@/drivers/net/dpaa2 \
18                          @TOPDIR@/drivers/net/i40e \
19                          @TOPDIR@/drivers/net/iavf \
20                          @TOPDIR@/drivers/net/ice \
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/dpaa2_qdma \
26                          @TOPDIR@/drivers/raw/ioat \
27                          @TOPDIR@/lib/librte_eal/include \
28                          @TOPDIR@/lib/librte_eal/include/generic \
29                          @TOPDIR@/lib/librte_acl \
30                          @TOPDIR@/lib/librte_bbdev \
31                          @TOPDIR@/lib/librte_bitratestats \
32                          @TOPDIR@/lib/librte_bpf \
33                          @TOPDIR@/lib/librte_cfgfile \
34                          @TOPDIR@/lib/librte_cmdline \
35                          @TOPDIR@/lib/librte_compressdev \
36                          @TOPDIR@/lib/librte_cryptodev \
37                          @TOPDIR@/lib/librte_distributor \
38                          @TOPDIR@/lib/librte_efd \
39                          @TOPDIR@/lib/librte_ethdev \
40                          @TOPDIR@/lib/librte_eventdev \
41                          @TOPDIR@/lib/librte_fib \
42                          @TOPDIR@/lib/librte_flow_classify \
43                          @TOPDIR@/lib/librte_graph \
44                          @TOPDIR@/lib/librte_gro \
45                          @TOPDIR@/lib/librte_gso \
46                          @TOPDIR@/lib/librte_hash \
47                          @TOPDIR@/lib/librte_ip_frag \
48                          @TOPDIR@/lib/librte_ipsec \
49                          @TOPDIR@/lib/librte_jobstats \
50                          @TOPDIR@/lib/librte_kni \
51                          @TOPDIR@/lib/librte_kvargs \
52                          @TOPDIR@/lib/librte_latencystats \
53                          @TOPDIR@/lib/librte_lpm \
54                          @TOPDIR@/lib/librte_mbuf \
55                          @TOPDIR@/lib/librte_member \
56                          @TOPDIR@/lib/librte_mempool \
57                          @TOPDIR@/lib/librte_meter \
58                          @TOPDIR@/lib/librte_metrics \
59                          @TOPDIR@/lib/librte_node \
60                          @TOPDIR@/lib/librte_net \
61                          @TOPDIR@/lib/librte_pci \
62                          @TOPDIR@/lib/librte_pdump \
63                          @TOPDIR@/lib/librte_pipeline \
64                          @TOPDIR@/lib/librte_port \
65                          @TOPDIR@/lib/librte_power \
66                          @TOPDIR@/lib/librte_rawdev \
67                          @TOPDIR@/lib/librte_rcu \
68                          @TOPDIR@/lib/librte_regexdev \
69                          @TOPDIR@/lib/librte_reorder \
70                          @TOPDIR@/lib/librte_rib \
71                          @TOPDIR@/lib/librte_ring \
72                          @TOPDIR@/lib/librte_sched \
73                          @TOPDIR@/lib/librte_security \
74                          @TOPDIR@/lib/librte_stack \
75                          @TOPDIR@/lib/librte_table \
76                          @TOPDIR@/lib/librte_telemetry \
77                          @TOPDIR@/lib/librte_timer \
78                          @TOPDIR@/lib/librte_vhost
79INPUT                   += @API_EXAMPLES@
80FILE_PATTERNS           = rte_*.h \
81                          cmdline.h
82PREDEFINED              = __DOXYGEN__ \
83			   VFIO_PRESENT \
84                          __attribute__(x)=
85
86OPTIMIZE_OUTPUT_FOR_C   = YES
87ENABLE_PREPROCESSING    = YES
88MACRO_EXPANSION         = YES
89EXPAND_ONLY_PREDEF      = YES
90EXTRACT_STATIC          = YES
91DISTRIBUTE_GROUP_DOC    = YES
92HIDE_UNDOC_MEMBERS      = YES
93HIDE_UNDOC_CLASSES      = YES
94HIDE_SCOPE_NAMES        = YES
95GENERATE_DEPRECATEDLIST = YES
96VERBATIM_HEADERS        = NO
97ALPHABETICAL_INDEX      = NO
98
99HTML_TIMESTAMP          = NO
100HTML_DYNAMIC_SECTIONS   = YES
101SEARCHENGINE            = YES
102SORT_MEMBER_DOCS        = NO
103SOURCE_BROWSER          = YES
104
105EXAMPLE_PATH            = @TOPDIR@/examples
106EXAMPLE_PATTERNS        = *.c
107EXAMPLE_RECURSIVE       = YES
108
109OUTPUT_DIRECTORY        = @OUTPUT@
110STRIP_FROM_PATH         = @STRIP_FROM_PATH@
111GENERATE_HTML           = YES
112HTML_OUTPUT             = @HTML_OUTPUT@
113GENERATE_LATEX          = NO
114GENERATE_MAN            = NO
115
116HAVE_DOT                = NO
117
118WARN_AS_ERROR           = @WARN_AS_ERROR@
119