crypto/scheduler: fix doxygen comments
[dpdk.git] / doc / api / doxy-api.conf
1 # BSD LICENSE
2 #
3 # Copyright 2013-2017 6WIND S.A.
4 #
5 # Redistribution and use in source and binary forms, with or without
6 # modification, are permitted provided that the following conditions
7 # are met:
8 #
9 #   * Redistributions of source code must retain the above copyright
10 #     notice, this list of conditions and the following disclaimer.
11 #   * Redistributions in binary form must reproduce the above copyright
12 #     notice, this list of conditions and the following disclaimer in
13 #     the documentation and/or other materials provided with the
14 #     distribution.
15 #   * Neither the name of 6WIND S.A. nor the names of its
16 #     contributors may be used to endorse or promote products derived
17 #     from this software without specific prior written permission.
18 #
19 # THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
20 # "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
21 # LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
22 # A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
23 # OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
24 # SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
25 # LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
26 # DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
27 # THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
28 # (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
29 # OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
30
31 PROJECT_NAME            = DPDK
32 INPUT                   = doc/api/doxy-api-index.md \
33                           drivers/crypto/scheduler \
34                           drivers/net/bonding \
35                           drivers/net/i40e \
36                           drivers/net/ixgbe \
37                           lib/librte_eal/common/include \
38                           lib/librte_eal/common/include/generic \
39                           lib/librte_acl \
40                           lib/librte_bitratestats \
41                           lib/librte_cfgfile \
42                           lib/librte_cmdline \
43                           lib/librte_compat \
44                           lib/librte_cryptodev \
45                           lib/librte_distributor \
46                           lib/librte_efd \
47                           lib/librte_ether \
48                           lib/librte_eventdev \
49                           lib/librte_hash \
50                           lib/librte_ip_frag \
51                           lib/librte_jobstats \
52                           lib/librte_kni \
53                           lib/librte_kvargs \
54                           lib/librte_latencystats \
55                           lib/librte_lpm \
56                           lib/librte_mbuf \
57                           lib/librte_mempool \
58                           lib/librte_meter \
59                           lib/librte_metrics \
60                           lib/librte_net \
61                           lib/librte_pdump \
62                           lib/librte_pipeline \
63                           lib/librte_port \
64                           lib/librte_power \
65                           lib/librte_reorder \
66                           lib/librte_ring \
67                           lib/librte_sched \
68                           lib/librte_table \
69                           lib/librte_timer \
70                           lib/librte_vhost
71 FILE_PATTERNS           = rte_*.h \
72                           cmdline.h
73 PREDEFINED              = __DOXYGEN__ \
74                           __attribute__(x)=
75
76 OPTIMIZE_OUTPUT_FOR_C   = YES
77 ENABLE_PREPROCESSING    = YES
78 MACRO_EXPANSION         = YES
79 EXPAND_ONLY_PREDEF      = YES
80 EXTRACT_STATIC          = YES
81 DISTRIBUTE_GROUP_DOC    = YES
82 HIDE_UNDOC_MEMBERS      = YES
83 HIDE_UNDOC_CLASSES      = YES
84 HIDE_SCOPE_NAMES        = YES
85 GENERATE_DEPRECATEDLIST = NO
86 VERBATIM_HEADERS        = NO
87 ALPHABETICAL_INDEX      = NO
88
89 HTML_TIMESTAMP          = NO
90 HTML_DYNAMIC_SECTIONS   = YES
91 SEARCHENGINE            = NO
92 SORT_MEMBER_DOCS        = NO
93 SOURCE_BROWSER          = YES
94
95 EXAMPLE_PATH            = examples
96 EXAMPLE_PATTERNS        = *.c
97 EXAMPLE_RECURSIVE       = YES