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