TrustedFirmware Git Browser
Code Review Sign In
review.trustedfirmware.org / mirror / mbed-tls / 550d147078356ad67fb60d781c6c652f028402ca / . / doxygen / mbedtls.doxyfile
blob: 075880c5d0d1e8791ec1cd7fe323e95086ddecf0 [file] [log] [blame]
Gilles Peskine550d1472023-08-02 12:50:23 +0200[diff] [blame^]1PROJECT_NAME = "mbed TLS v3.4.1"
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
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]13SOURCE_BROWSER = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]14REFERENCED_BY_RELATION = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]15REFERENCES_RELATION = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]16ALPHABETICAL_INDEX = NO
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]17HTML_OUTPUT = .
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]18HTML_TIMESTAMP = YES
Andrzej Kurek47cfd152022-01-21 08:43:44 -0500[diff] [blame]19SEARCHENGINE = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]20GENERATE_LATEX = NO
Mateusz Starzykbeb95b42021-05-20 14:41:22 +0200[diff] [blame]21MACRO_EXPANSION = YES
Mateusz Starzykbeb95b42021-05-20 14:41:22 +0200[diff] [blame]22EXPAND_ONLY_PREDEF = YES
Andrzej Kurek593adc82020-03-27 12:58:13 -0400[diff] [blame]23INCLUDE_PATH = ../include
Mateusz Starzykbeb95b42021-05-20 14:41:22 +0200[diff] [blame]24EXPAND_AS_DEFINED = MBEDTLS_PRIVATE
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]25CLASS_DIAGRAMS = NO
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]26HAVE_DOT = YES
Paul Bakker13a94a12013-09-10 16:17:15 +0200[diff] [blame]27DOT_GRAPH_MAX_NODES = 200
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]28MAX_DOT_GRAPH_DEPTH = 1000
Paul Bakker37ca75d2011-01-06 12:28:03 +0000[diff] [blame]29DOT_TRANSPARENT = YES
Gilles Peskine8ea7d852023-02-14 19:15:40 +0100[diff] [blame]30
Gilles Peskine2fb4e142023-02-23 13:37:54 +0100[diff] [blame]31# We mostly use \retval declarations to document which error codes a function
Gilles Peskine4348a832023-02-23 13:03:30 +0100[diff] [blame]32# can return. The reader can follow the hyperlink to the definition of the
33# constant to get the generic documentation of that error code. If we don't
34# have anything to say about the specific error code for the specific
35# function, we can leave the description part of the \retval command blank.
36# This is perfectly valid as far as Doxygen is concerned. However, with
37# Clang >=15, the -Wdocumentation option emits a warning for empty
38# descriptions.
Gilles Peskine8ea7d852023-02-14 19:15:40 +0100[diff] [blame]39# https://github.com/Mbed-TLS/mbedtls/issues/6960
40# https://github.com/llvm/llvm-project/issues/60315
Gilles Peskine4348a832023-02-23 13:03:30 +0100[diff] [blame]41# As a workaround, you can write something like
Gilles Peskine787f7c82023-02-21 10:21:12 +0100[diff] [blame]42# \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
Gilles Peskine4348a832023-02-23 13:03:30 +0100[diff] [blame]43# This avoids writing redundant text and keeps Clang happy.
Gilles Peskine8ea7d852023-02-14 19:15:40 +0100[diff] [blame]44ALIASES += emptydescription=""