doc/api/doxy-api.conf.in - main - phprus/github_dpdk

doc/api/doxy-api.conf.in
156 строк7 KB
David Marchand
vfio: remove confusing check on VFIO presence
01 окт 2025, 18:25
01 окт 2025, 18:25df77d01
# SPDX-License-Identifier: BSD-3-Clause
# Copyright 2013-2017 6WIND S.A.

PROJECT_NAME            = DPDK
PROJECT_NUMBER          = @VERSION@
USE_MDFILE_AS_MAINPAGE  = @TOPDIR@/doc/api/doxy-api-index.md
INPUT                   = @TOPDIR@/doc/api/doxy-api-index.md \
                          @TOPDIR@/drivers/bus/vdev \
                          @TOPDIR@/drivers/common/dpaax \
                          @TOPDIR@/drivers/crypto/cnxk \
                          @TOPDIR@/drivers/crypto/scheduler \
                          @TOPDIR@/drivers/event/dlb2 \
                          @TOPDIR@/drivers/event/cnxk \
                          @TOPDIR@/drivers/mempool/cnxk \
                          @TOPDIR@/drivers/mempool/dpaa2 \
                          @TOPDIR@/drivers/net/ark \
                          @TOPDIR@/drivers/net/bnxt \
                          @TOPDIR@/drivers/net/bonding \
                          @TOPDIR@/drivers/net/cnxk \
                          @TOPDIR@/drivers/net/dpaa \
                          @TOPDIR@/drivers/net/dpaa2 \
                          @TOPDIR@/drivers/net/intel/i40e \
                          @TOPDIR@/drivers/net/intel/iavf \
                          @TOPDIR@/drivers/net/intel/ixgbe \
                          @TOPDIR@/drivers/net/mlx5 \
                          @TOPDIR@/drivers/net/softnic \
                          @TOPDIR@/drivers/raw/dpaa2_cmdif \
                          @TOPDIR@/drivers/raw/ifpga \
                          @TOPDIR@/lib/eal/include \
                          @TOPDIR@/lib/eal/include/generic \
                          @TOPDIR@/lib/acl \
                          @TOPDIR@/lib/argparse \
                          @TOPDIR@/lib/bbdev \
                          @TOPDIR@/lib/bitratestats \
                          @TOPDIR@/lib/bpf \
                          @TOPDIR@/lib/cfgfile \
                          @TOPDIR@/lib/cmdline \
                          @TOPDIR@/lib/compressdev \
                          @TOPDIR@/lib/cryptodev \
                          @TOPDIR@/lib/dispatcher \
                          @TOPDIR@/lib/distributor \
                          @TOPDIR@/lib/dmadev \
                          @TOPDIR@/lib/efd \
                          @TOPDIR@/lib/ethdev \
                          @TOPDIR@/lib/eventdev \
                          @TOPDIR@/lib/fib \
                          @TOPDIR@/lib/gpudev \
                          @TOPDIR@/lib/graph \
                          @TOPDIR@/lib/gro \
                          @TOPDIR@/lib/gso \
                          @TOPDIR@/lib/hash \
                          @TOPDIR@/lib/ip_frag \
                          @TOPDIR@/lib/ipsec \
                          @TOPDIR@/lib/jobstats \
                          @TOPDIR@/lib/kvargs \
                          @TOPDIR@/lib/latencystats \
                          @TOPDIR@/lib/log \
                          @TOPDIR@/lib/lpm \
                          @TOPDIR@/lib/mbuf \
                          @TOPDIR@/lib/member \
                          @TOPDIR@/lib/mempool \
                          @TOPDIR@/lib/meter \
                          @TOPDIR@/lib/metrics \
                          @TOPDIR@/lib/mldev \
                          @TOPDIR@/lib/node \
                          @TOPDIR@/lib/net \
                          @TOPDIR@/lib/pcapng \
                          @TOPDIR@/lib/pci \
                          @TOPDIR@/lib/pdcp \
                          @TOPDIR@/lib/pdump \
                          @TOPDIR@/lib/pipeline \
                          @TOPDIR@/lib/pmu \
                          @TOPDIR@/lib/port \
                          @TOPDIR@/lib/power \
                          @TOPDIR@/lib/ptr_compress \
                          @TOPDIR@/lib/rawdev \
                          @TOPDIR@/lib/rcu \
                          @TOPDIR@/lib/regexdev \
                          @TOPDIR@/lib/reorder \
                          @TOPDIR@/lib/rib \
                          @TOPDIR@/lib/ring \
                          @TOPDIR@/lib/sched \
                          @TOPDIR@/lib/security \
                          @TOPDIR@/lib/stack \
                          @TOPDIR@/lib/table \
                          @TOPDIR@/lib/telemetry \
                          @TOPDIR@/lib/timer \
                          @TOPDIR@/lib/vhost
INPUT                   += @API_EXAMPLES@
FILE_PATTERNS           = rte_*.h \
                          cmdline.h
PREDEFINED              = __DOXYGEN__ \
                          RTE_ATOMIC \
                          RTE_HAS_CPUSET \
                          __rte_lockable= \
                          __rte_guarded_by(x)= \
                          __rte_exclusive_locks_required(x)= \
                          __rte_exclusive_lock_function(x)= \
                          __rte_exclusive_trylock_function(x)= \
                          __rte_assert_exclusive_lock(x)= \
                          __rte_shared_locks_required(x)= \
                          __rte_shared_lock_function(x)= \
                          __rte_shared_trylock_function(x)= \
                          __rte_assert_shared_lock(x)= \
                          __rte_unlock_function(x)= \
                          __rte_capability(x)= \
                          __rte_requires_capability(x)= \
                          __rte_acquire_capability(x)= \
                          __rte_try_acquire_capability(x)= \
                          __rte_release_capability(x)= \
                          __rte_assert_capability(x)= \
                          __rte_requires_shared_capability(x)= \
                          __rte_acquire_shared_capability(x)= \
                          __rte_try_acquire_shared_capability(x)= \
                          __rte_release_shared_capability(x)= \
                          __rte_assert_shared_capability(x)= \
                          __rte_exclude_capability(x)= \
                          __attribute__(x)=

OPTIMIZE_OUTPUT_FOR_C   = YES
ENABLE_PREPROCESSING    = YES
MACRO_EXPANSION         = YES
EXPAND_ONLY_PREDEF      = YES
EXTRACT_STATIC          = YES
DISTRIBUTE_GROUP_DOC    = YES
HIDE_UNDOC_MEMBERS      = YES
HIDE_UNDOC_CLASSES      = YES
HIDE_SCOPE_NAMES        = YES
GENERATE_DEPRECATEDLIST = YES
VERBATIM_HEADERS        = NO
ALPHABETICAL_INDEX      = NO

HTML_DYNAMIC_SECTIONS   = YES
HTML_EXTRA_STYLESHEET   = @TOPDIR@/doc/api/custom.css
SEARCHENGINE            = YES
SORT_MEMBER_DOCS        = NO
SOURCE_BROWSER          = YES

ALIASES                 = "dts_api_main_page=@DTS_API_MAIN_PAGE@"

EXAMPLE_PATH            = @TOPDIR@/examples
EXAMPLE_PATTERNS        = *.c
EXAMPLE_RECURSIVE       = YES

OUTPUT_DIRECTORY        = @OUTPUT@
FULL_PATH_NAMES         = @FULL_PATH_NAMES@
STRIP_FROM_PATH         = @STRIP_FROM_PATH@
GENERATE_HTML           = @GENERATE_HTML@
HTML_OUTPUT             = html
GENERATE_LATEX          = NO
GENERATE_MAN            = @GENERATE_MAN@
MAN_LINKS               = YES

HAVE_DOT                = NO

WARN_AS_ERROR           = @WARN_AS_ERROR@