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