mirror of
https://github.com/Mbed-TLS/mbedtls.git
synced 2024-12-29 09:21:19 +00:00
b9f0674ef1
Sphinx's breathe plugin cannot readily parse the Mbed TLS macros, so define the less essential ones away at the doxygen step to reduce the number of warnings. Signed-off-by: David Horstmann <david.horstmann@arm.com>
56 lines
2.1 KiB
Plaintext
56 lines
2.1 KiB
Plaintext
PROJECT_NAME = "mbed TLS v3.4.0"
|
|
OUTPUT_DIRECTORY = ../apidoc/
|
|
FULL_PATH_NAMES = NO
|
|
OPTIMIZE_OUTPUT_FOR_C = YES
|
|
EXTRACT_ALL = YES
|
|
EXTRACT_PRIVATE = YES
|
|
EXTRACT_STATIC = YES
|
|
CASE_SENSE_NAMES = NO
|
|
INPUT = ../include input
|
|
FILE_PATTERNS = *.h
|
|
RECURSIVE = YES
|
|
EXCLUDE_SYMLINKS = YES
|
|
SOURCE_BROWSER = YES
|
|
REFERENCED_BY_RELATION = YES
|
|
REFERENCES_RELATION = YES
|
|
ALPHABETICAL_INDEX = NO
|
|
HTML_OUTPUT = .
|
|
HTML_TIMESTAMP = YES
|
|
SEARCHENGINE = YES
|
|
GENERATE_LATEX = NO
|
|
MACRO_EXPANSION = YES
|
|
EXPAND_ONLY_PREDEF = YES
|
|
INCLUDE_PATH = ../include
|
|
EXPAND_AS_DEFINED = MBEDTLS_PRIVATE
|
|
CLASS_DIAGRAMS = NO
|
|
HAVE_DOT = YES
|
|
DOT_GRAPH_MAX_NODES = 200
|
|
MAX_DOT_GRAPH_DEPTH = 1000
|
|
DOT_TRANSPARENT = YES
|
|
|
|
# We mostly use \retval declarations to document which error codes a function
|
|
# can return. The reader can follow the hyperlink to the definition of the
|
|
# constant to get the generic documentation of that error code. If we don't
|
|
# have anything to say about the specific error code for the specific
|
|
# function, we can leave the description part of the \retval command blank.
|
|
# This is perfectly valid as far as Doxygen is concerned. However, with
|
|
# Clang >=15, the -Wdocumentation option emits a warning for empty
|
|
# descriptions.
|
|
# https://github.com/Mbed-TLS/mbedtls/issues/6960
|
|
# https://github.com/llvm/llvm-project/issues/60315
|
|
# As a workaround, you can write something like
|
|
# \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
|
|
# This avoids writing redundant text and keeps Clang happy.
|
|
ALIASES += emptydescription=""
|
|
|
|
GENERATE_XML = YES
|
|
|
|
# Define away Mbed TLS macros that make parsing definitions difficult.
|
|
# MBEDTLS_DEPRECATED is not included in this list as it's important to
|
|
# display deprecated status in the documentation.
|
|
PREDEFINED = "MBEDTLS_CHECK_RETURN_CRITICAL=" \
|
|
"MBEDTLS_CHECK_RETURN_TYPICAL=" \
|
|
"MBEDTLS_CHECK_RETURN_OPTIONAL=" \
|
|
"MBEDTLS_PRINTF_ATTRIBUTE(a,b)=" \
|
|
|