regexdev: introduce API
[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/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
73 INPUT                   += @API_EXAMPLES@
74 FILE_PATTERNS           = rte_*.h \
75                           cmdline.h
76 PREDEFINED              = __DOXYGEN__ \
77                            VFIO_PRESENT \
78                           __attribute__(x)=
79
80 OPTIMIZE_OUTPUT_FOR_C   = YES
81 ENABLE_PREPROCESSING    = YES
82 MACRO_EXPANSION         = YES
83 EXPAND_ONLY_PREDEF      = YES
84 EXTRACT_STATIC          = YES
85 DISTRIBUTE_GROUP_DOC    = YES
86 HIDE_UNDOC_MEMBERS      = YES
87 HIDE_UNDOC_CLASSES      = YES
88 HIDE_SCOPE_NAMES        = YES
89 GENERATE_DEPRECATEDLIST = YES
90 VERBATIM_HEADERS        = NO
91 ALPHABETICAL_INDEX      = NO
92
93 HTML_TIMESTAMP          = NO
94 HTML_DYNAMIC_SECTIONS   = YES
95 SEARCHENGINE            = YES
96 SORT_MEMBER_DOCS        = NO
97 SOURCE_BROWSER          = YES
98
99 EXAMPLE_PATH            = @TOPDIR@/examples
100 EXAMPLE_PATTERNS        = *.c
101 EXAMPLE_RECURSIVE       = YES
102
103 OUTPUT_DIRECTORY        = @OUTPUT@
104 STRIP_FROM_PATH         = @STRIP_FROM_PATH@
105 GENERATE_HTML           = YES
106 HTML_OUTPUT             = @HTML_OUTPUT@
107 GENERATE_LATEX          = NO
108 GENERATE_MAN            = NO
109
110 HAVE_DOT                = NO