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