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