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