xref: /dpdk/doc/api/doxy-api.conf.in (revision c1d145834f287aa8cf53de914618a7312f2c360e)
198d05387SLuca Boccassi# SPDX-License-Identifier: BSD-3-Clause
298d05387SLuca Boccassi# Copyright 2013-2017 6WIND S.A.
398d05387SLuca Boccassi
498d05387SLuca BoccassiPROJECT_NAME            = DPDK
598d05387SLuca BoccassiPROJECT_NUMBER          = @VERSION@
660814f95SThomas MonjalonUSE_MDFILE_AS_MAINPAGE  = @TOPDIR@/doc/api/doxy-api-index.md
798d05387SLuca BoccassiINPUT                   = @TOPDIR@/doc/api/doxy-api-index.md \
842490f38SAideen McLoughlin                          @TOPDIR@/drivers/bus/vdev \
97cfcce8eSJun Yang                          @TOPDIR@/drivers/common/dpaax \
1026bb5c4dSAnoob Joseph                          @TOPDIR@/drivers/crypto/cnxk \
1198d05387SLuca Boccassi                          @TOPDIR@/drivers/crypto/scheduler \
12c667583dSTimothy McDaniel                          @TOPDIR@/drivers/event/dlb2 \
1303714a41SPavan Nikhilesh                          @TOPDIR@/drivers/event/cnxk \
141d0f0957SAshwin Sekhar T K                          @TOPDIR@/drivers/mempool/cnxk \
1598d05387SLuca Boccassi                          @TOPDIR@/drivers/mempool/dpaa2 \
161abc7209SEd Czeck                          @TOPDIR@/drivers/net/ark \
1798d05387SLuca Boccassi                          @TOPDIR@/drivers/net/bnxt \
1898d05387SLuca Boccassi                          @TOPDIR@/drivers/net/bonding \
198efa348eSKiran Kumar K                          @TOPDIR@/drivers/net/cnxk \
2098d05387SLuca Boccassi                          @TOPDIR@/drivers/net/dpaa \
21c1870f65SAkhil Goyal                          @TOPDIR@/drivers/net/dpaa2 \
22*c1d14583SBruce Richardson                          @TOPDIR@/drivers/net/intel/i40e \
23*c1d14583SBruce Richardson                          @TOPDIR@/drivers/net/intel/iavf \
24*c1d14583SBruce Richardson                          @TOPDIR@/drivers/net/intel/ixgbe \
25a0dd7cc7SBing Zhao                          @TOPDIR@/drivers/net/mlx5 \
2698d05387SLuca Boccassi                          @TOPDIR@/drivers/net/softnic \
2798d05387SLuca Boccassi                          @TOPDIR@/drivers/raw/dpaa2_cmdif \
28a05bd1b4SWei Huang                          @TOPDIR@/drivers/raw/ifpga \
2999a2dd95SBruce Richardson                          @TOPDIR@/lib/eal/include \
3099a2dd95SBruce Richardson                          @TOPDIR@/lib/eal/include/generic \
3199a2dd95SBruce Richardson                          @TOPDIR@/lib/acl \
32e3e579f5SChengwen Feng                          @TOPDIR@/lib/argparse \
3399a2dd95SBruce Richardson                          @TOPDIR@/lib/bbdev \
3499a2dd95SBruce Richardson                          @TOPDIR@/lib/bitratestats \
3599a2dd95SBruce Richardson                          @TOPDIR@/lib/bpf \
3699a2dd95SBruce Richardson                          @TOPDIR@/lib/cfgfile \
3799a2dd95SBruce Richardson                          @TOPDIR@/lib/cmdline \
3899a2dd95SBruce Richardson                          @TOPDIR@/lib/compressdev \
3999a2dd95SBruce Richardson                          @TOPDIR@/lib/cryptodev \
40ecca8a0bSMattias Rönnblom                          @TOPDIR@/lib/dispatcher \
4199a2dd95SBruce Richardson                          @TOPDIR@/lib/distributor \
42b36970f2SChengwen Feng                          @TOPDIR@/lib/dmadev \
4399a2dd95SBruce Richardson                          @TOPDIR@/lib/efd \
4499a2dd95SBruce Richardson                          @TOPDIR@/lib/ethdev \
4599a2dd95SBruce Richardson                          @TOPDIR@/lib/eventdev \
4699a2dd95SBruce Richardson                          @TOPDIR@/lib/fib \
478b8036a6SElena Agostini                          @TOPDIR@/lib/gpudev \
4899a2dd95SBruce Richardson                          @TOPDIR@/lib/graph \
4999a2dd95SBruce Richardson                          @TOPDIR@/lib/gro \
5099a2dd95SBruce Richardson                          @TOPDIR@/lib/gso \
5199a2dd95SBruce Richardson                          @TOPDIR@/lib/hash \
5299a2dd95SBruce Richardson                          @TOPDIR@/lib/ip_frag \
5399a2dd95SBruce Richardson                          @TOPDIR@/lib/ipsec \
5499a2dd95SBruce Richardson                          @TOPDIR@/lib/jobstats \
5599a2dd95SBruce Richardson                          @TOPDIR@/lib/kvargs \
5699a2dd95SBruce Richardson                          @TOPDIR@/lib/latencystats \
5709ce4131SBruce Richardson                          @TOPDIR@/lib/log \
5899a2dd95SBruce Richardson                          @TOPDIR@/lib/lpm \
5999a2dd95SBruce Richardson                          @TOPDIR@/lib/mbuf \
6099a2dd95SBruce Richardson                          @TOPDIR@/lib/member \
6199a2dd95SBruce Richardson                          @TOPDIR@/lib/mempool \
6299a2dd95SBruce Richardson                          @TOPDIR@/lib/meter \
6399a2dd95SBruce Richardson                          @TOPDIR@/lib/metrics \
64d82cac58SJerin Jacob                          @TOPDIR@/lib/mldev \
6599a2dd95SBruce Richardson                          @TOPDIR@/lib/node \
6699a2dd95SBruce Richardson                          @TOPDIR@/lib/net \
678d23ce8fSStephen Hemminger                          @TOPDIR@/lib/pcapng \
6899a2dd95SBruce Richardson                          @TOPDIR@/lib/pci \
69a702bd09SAnoob Joseph                          @TOPDIR@/lib/pdcp \
7099a2dd95SBruce Richardson                          @TOPDIR@/lib/pdump \
7199a2dd95SBruce Richardson                          @TOPDIR@/lib/pipeline \
7299a2dd95SBruce Richardson                          @TOPDIR@/lib/port \
7399a2dd95SBruce Richardson                          @TOPDIR@/lib/power \
74077596a4SPaul Szczepanek                          @TOPDIR@/lib/ptr_compress \
7599a2dd95SBruce Richardson                          @TOPDIR@/lib/rawdev \
7699a2dd95SBruce Richardson                          @TOPDIR@/lib/rcu \
7799a2dd95SBruce Richardson                          @TOPDIR@/lib/regexdev \
7899a2dd95SBruce Richardson                          @TOPDIR@/lib/reorder \
7999a2dd95SBruce Richardson                          @TOPDIR@/lib/rib \
8099a2dd95SBruce Richardson                          @TOPDIR@/lib/ring \
8199a2dd95SBruce Richardson                          @TOPDIR@/lib/sched \
8299a2dd95SBruce Richardson                          @TOPDIR@/lib/security \
8399a2dd95SBruce Richardson                          @TOPDIR@/lib/stack \
8499a2dd95SBruce Richardson                          @TOPDIR@/lib/table \
8599a2dd95SBruce Richardson                          @TOPDIR@/lib/telemetry \
8699a2dd95SBruce Richardson                          @TOPDIR@/lib/timer \
8799a2dd95SBruce Richardson                          @TOPDIR@/lib/vhost
8898d05387SLuca BoccassiINPUT                   += @API_EXAMPLES@
8998d05387SLuca BoccassiFILE_PATTERNS           = rte_*.h \
9098d05387SLuca Boccassi                          cmdline.h
9198d05387SLuca BoccassiPREDEFINED              = __DOXYGEN__ \
925c381a35STyler Retzlaff                          RTE_ATOMIC \
93e0473c6dSThomas Monjalon                          RTE_HAS_CPUSET \
9498d05387SLuca Boccassi                          VFIO_PRESENT \
95657a98f3SDavid Marchand                          __rte_lockable= \
96657a98f3SDavid Marchand                          __rte_guarded_by(x)= \
97657a98f3SDavid Marchand                          __rte_exclusive_locks_required(x)= \
98657a98f3SDavid Marchand                          __rte_exclusive_lock_function(x)= \
99657a98f3SDavid Marchand                          __rte_exclusive_trylock_function(x)= \
100657a98f3SDavid Marchand                          __rte_assert_exclusive_lock(x)= \
101657a98f3SDavid Marchand                          __rte_shared_locks_required(x)= \
102657a98f3SDavid Marchand                          __rte_shared_lock_function(x)= \
103657a98f3SDavid Marchand                          __rte_shared_trylock_function(x)= \
104657a98f3SDavid Marchand                          __rte_assert_shared_lock(x)= \
105657a98f3SDavid Marchand                          __rte_unlock_function(x)= \
10698d05387SLuca Boccassi                          __attribute__(x)=
10798d05387SLuca Boccassi
10898d05387SLuca BoccassiOPTIMIZE_OUTPUT_FOR_C   = YES
10998d05387SLuca BoccassiENABLE_PREPROCESSING    = YES
11098d05387SLuca BoccassiMACRO_EXPANSION         = YES
11198d05387SLuca BoccassiEXPAND_ONLY_PREDEF      = YES
11298d05387SLuca BoccassiEXTRACT_STATIC          = YES
11398d05387SLuca BoccassiDISTRIBUTE_GROUP_DOC    = YES
11498d05387SLuca BoccassiHIDE_UNDOC_MEMBERS      = YES
11598d05387SLuca BoccassiHIDE_UNDOC_CLASSES      = YES
11698d05387SLuca BoccassiHIDE_SCOPE_NAMES        = YES
117953ff37dSThomas MonjalonGENERATE_DEPRECATEDLIST = YES
11898d05387SLuca BoccassiVERBATIM_HEADERS        = NO
11998d05387SLuca BoccassiALPHABETICAL_INDEX      = NO
12098d05387SLuca Boccassi
12198d05387SLuca BoccassiHTML_DYNAMIC_SECTIONS   = YES
122e4c22414SDmitry KozlyukHTML_EXTRA_STYLESHEET   = @TOPDIR@/doc/api/custom.css
12392d6c874SAideen McLoughlinSEARCHENGINE            = YES
12498d05387SLuca BoccassiSORT_MEMBER_DOCS        = NO
12598d05387SLuca BoccassiSOURCE_BROWSER          = YES
12698d05387SLuca Boccassi
1277f932642SJuraj LinkešALIASES                 = "dts_api_main_page=@DTS_API_MAIN_PAGE@"
1287f932642SJuraj Linkeš
12998d05387SLuca BoccassiEXAMPLE_PATH            = @TOPDIR@/examples
13098d05387SLuca BoccassiEXAMPLE_PATTERNS        = *.c
13198d05387SLuca BoccassiEXAMPLE_RECURSIVE       = YES
13298d05387SLuca Boccassi
13398d05387SLuca BoccassiOUTPUT_DIRECTORY        = @OUTPUT@
134c56185fcSBruce RichardsonFULL_PATH_NAMES         = @FULL_PATH_NAMES@
13598d05387SLuca BoccassiSTRIP_FROM_PATH         = @STRIP_FROM_PATH@
136c56185fcSBruce RichardsonGENERATE_HTML           = @GENERATE_HTML@
137c56185fcSBruce RichardsonHTML_OUTPUT             = html
13898d05387SLuca BoccassiGENERATE_LATEX          = NO
139c56185fcSBruce RichardsonGENERATE_MAN            = @GENERATE_MAN@
140c56185fcSBruce RichardsonMAN_LINKS               = YES
1411f7250dfSAli Alnubani
1421f7250dfSAli AlnubaniHAVE_DOT                = NO
1431f161999SBruce Richardson
1441f161999SBruce RichardsonWARN_AS_ERROR           = @WARN_AS_ERROR@
145