TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / mirror / mbed-tls / refs/heads/2.28-sphinx-versioned-documentation / . / doxygen / mbedtls.doxyfile
blob: 38fb8dbfcd3608b4a7b72c7750d91341daa92039 [file] [log] [blame]
Aditya Deshpande7428c612022-12-08 11:04:44 +0000[diff] [blame]1PROJECT_NAME = "mbed TLS v2.28.2"
Krzysztof Stachowiaka0188d62018-01-19 16:21:11 +0100[diff] [blame]2OUTPUT_DIRECTORY = ../apidoc/
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]3FULL_PATH_NAMES = NO
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]4OPTIMIZE_OUTPUT_FOR_C = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]5EXTRACT_ALL = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]6EXTRACT_PRIVATE = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]7EXTRACT_STATIC = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]8CASE_SENSE_NAMES = NO
Gilles Peskinea9daa5c2018-09-26 17:49:57 +0200[diff] [blame]9INPUT = ../include input
Manuel Pégourié-Gonnard27d81392015-03-10 17:37:30 +0000[diff] [blame]10FILE_PATTERNS = *.h
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]11RECURSIVE = YES
Gilles Peskine11d3cf42017-12-22 15:34:37 +0100[diff] [blame]12EXCLUDE_SYMLINKS = YES
Manuel Pégourié-Gonnard35d07bf2016-01-08 16:48:51 +0100[diff] [blame]13EXCLUDE_PATTERNS = *_internal.h *_wrap.h
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]14SOURCE_BROWSER = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]15REFERENCED_BY_RELATION = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]16REFERENCES_RELATION = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]17ALPHABETICAL_INDEX = NO
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]18HTML_OUTPUT = .
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]19HTML_TIMESTAMP = YES
Andrzej Kurekef3f27b2022-02-15 06:56:16 -0500[diff] [blame]20SEARCHENGINE = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]21GENERATE_LATEX = NO
David Horstmannf15b7b62023-03-22 17:35:14 +0000[diff] [blame]22GENERATE_XML = YES
23MACRO_EXPANSION = YES
24EXPAND_ONLY_PREDEF = YES
Andrzej Kurek593adc82020-03-27 12:58:13 -0400[diff] [blame]25INCLUDE_PATH = ../include
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]26CLASS_DIAGRAMS = NO
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]27HAVE_DOT = YES
Paul Bakker13a94a12013-09-10 16:17:15 +0200[diff] [blame]28DOT_GRAPH_MAX_NODES = 200
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]29MAX_DOT_GRAPH_DEPTH = 1000
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]30DOT_TRANSPARENT = YES
Gilles Peskine2fb14e92023-02-14 19:15:40 +0100[diff] [blame]31
Gilles Peskine809c3d52023-02-23 13:37:54 +0100[diff] [blame]32# We mostly use \retval declarations to document which error codes a function
Gilles Peskine8377f3d2023-02-23 13:03:30 +0100[diff] [blame]33# can return. The reader can follow the hyperlink to the definition of the
34# constant to get the generic documentation of that error code. If we don't
35# have anything to say about the specific error code for the specific
36# function, we can leave the description part of the \retval command blank.
37# This is perfectly valid as far as Doxygen is concerned. However, with
38# Clang >=15, the -Wdocumentation option emits a warning for empty
39# descriptions.
Gilles Peskine2fb14e92023-02-14 19:15:40 +0100[diff] [blame]40# https://github.com/Mbed-TLS/mbedtls/issues/6960
41# https://github.com/llvm/llvm-project/issues/60315
Gilles Peskine8377f3d2023-02-23 13:03:30 +0100[diff] [blame]42# As a workaround, you can write something like
Gilles Peskine4b86f532023-02-21 10:21:12 +0100[diff] [blame]43# \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
Gilles Peskine8377f3d2023-02-23 13:03:30 +0100[diff] [blame]44# This avoids writing redundant text and keeps Clang happy.
Gilles Peskine2fb14e92023-02-14 19:15:40 +0100[diff] [blame]45ALIASES += emptydescription=""
David Horstmann62ef6212023-03-14 14:20:38 +0000[diff] [blame]46
David Horstmanne04d4922023-03-16 16:07:12 +0000[diff] [blame]47# Define away Mbed TLS macros that make parsing definitions difficult.
48# MBEDTLS_DEPRECATED is not included in this list as it's important to
49# display deprecated status in the documentation.
50PREDEFINED = "MBEDTLS_CHECK_RETURN_CRITICAL=" \
51 "MBEDTLS_CHECK_RETURN_TYPICAL=" \
52 "MBEDTLS_CHECK_RETURN_OPTIONAL=" \
53 "MBEDTLS_PRINTF_ATTRIBUTE(a,b)=" \
54