xref: /dpdk/doc/api/doxy-api.conf.in (revision 9a710863decb1cdb98efbdd5e11df3ebcfcc37b6)
1# SPDX-License-Identifier: BSD-3-Clause
2# Copyright 2013-2017 6WIND S.A.
3
4PROJECT_NAME            = DPDK
5PROJECT_NUMBER          = @VERSION@
6INPUT                   = @TOPDIR@/doc/api/doxy-api-index.md \
7                          @TOPDIR@/drivers/bus/vdev \
8                          @TOPDIR@/drivers/crypto/scheduler \
9                          @TOPDIR@/drivers/mempool/dpaa2 \
10                          @TOPDIR@/drivers/net/bnxt \
11                          @TOPDIR@/drivers/net/bonding \
12                          @TOPDIR@/drivers/net/dpaa \
13                          @TOPDIR@/drivers/net/dpaa2 \
14                          @TOPDIR@/drivers/net/i40e \
15                          @TOPDIR@/drivers/net/ixgbe \
16                          @TOPDIR@/drivers/net/softnic \
17                          @TOPDIR@/drivers/raw/dpaa2_cmdif \
18                          @TOPDIR@/drivers/raw/dpaa2_qdma \
19                          @TOPDIR@/lib/librte_eal/common/include \
20                          @TOPDIR@/lib/librte_eal/common/include/generic \
21                          @TOPDIR@/lib/librte_acl \
22                          @TOPDIR@/lib/librte_bbdev \
23                          @TOPDIR@/lib/librte_bitratestats \
24                          @TOPDIR@/lib/librte_bpf \
25                          @TOPDIR@/lib/librte_cfgfile \
26                          @TOPDIR@/lib/librte_cmdline \
27                          @TOPDIR@/lib/librte_compressdev \
28                          @TOPDIR@/lib/librte_cryptodev \
29                          @TOPDIR@/lib/librte_distributor \
30                          @TOPDIR@/lib/librte_efd \
31                          @TOPDIR@/lib/librte_ethdev \
32                          @TOPDIR@/lib/librte_eventdev \
33                          @TOPDIR@/lib/librte_flow_classify \
34                          @TOPDIR@/lib/librte_gro \
35                          @TOPDIR@/lib/librte_gso \
36                          @TOPDIR@/lib/librte_hash \
37                          @TOPDIR@/lib/librte_ip_frag \
38                          @TOPDIR@/lib/librte_jobstats \
39                          @TOPDIR@/lib/librte_kni \
40                          @TOPDIR@/lib/librte_kvargs \
41                          @TOPDIR@/lib/librte_latencystats \
42                          @TOPDIR@/lib/librte_lpm \
43                          @TOPDIR@/lib/librte_mbuf \
44                          @TOPDIR@/lib/librte_member \
45                          @TOPDIR@/lib/librte_mempool \
46                          @TOPDIR@/lib/librte_meter \
47                          @TOPDIR@/lib/librte_metrics \
48                          @TOPDIR@/lib/librte_net \
49                          @TOPDIR@/lib/librte_pci \
50                          @TOPDIR@/lib/librte_pdump \
51                          @TOPDIR@/lib/librte_pipeline \
52                          @TOPDIR@/lib/librte_port \
53                          @TOPDIR@/lib/librte_power \
54                          @TOPDIR@/lib/librte_rawdev \
55                          @TOPDIR@/lib/librte_rcu \
56                          @TOPDIR@/lib/librte_reorder \
57                          @TOPDIR@/lib/librte_ring \
58                          @TOPDIR@/lib/librte_sched \
59                          @TOPDIR@/lib/librte_security \
60                          @TOPDIR@/lib/librte_stack \
61                          @TOPDIR@/lib/librte_table \
62                          @TOPDIR@/lib/librte_telemetry \
63                          @TOPDIR@/lib/librte_timer \
64                          @TOPDIR@/lib/librte_vhost
65INPUT                   += @API_EXAMPLES@
66FILE_PATTERNS           = rte_*.h \
67                          cmdline.h
68PREDEFINED              = __DOXYGEN__ \
69			   VFIO_PRESENT \
70                          __attribute__(x)=
71
72OPTIMIZE_OUTPUT_FOR_C   = YES
73ENABLE_PREPROCESSING    = YES
74MACRO_EXPANSION         = YES
75EXPAND_ONLY_PREDEF      = YES
76EXTRACT_STATIC          = YES
77DISTRIBUTE_GROUP_DOC    = YES
78HIDE_UNDOC_MEMBERS      = YES
79HIDE_UNDOC_CLASSES      = YES
80HIDE_SCOPE_NAMES        = YES
81GENERATE_DEPRECATEDLIST = YES
82VERBATIM_HEADERS        = NO
83ALPHABETICAL_INDEX      = NO
84
85HTML_TIMESTAMP          = NO
86HTML_DYNAMIC_SECTIONS   = YES
87SEARCHENGINE            = YES
88SORT_MEMBER_DOCS        = NO
89SOURCE_BROWSER          = YES
90
91EXAMPLE_PATH            = @TOPDIR@/examples
92EXAMPLE_PATTERNS        = *.c
93EXAMPLE_RECURSIVE       = YES
94
95OUTPUT_DIRECTORY        = @OUTPUT@
96STRIP_FROM_PATH         = @STRIP_FROM_PATH@
97GENERATE_HTML           = YES
98HTML_OUTPUT             = @HTML_OUTPUT@
99GENERATE_LATEX          = NO
100GENERATE_MAN            = NO
101