blob: 0acead965157ce0a78ee58a3b84a47743a152ede [file] [log] [blame]
Minos Galanakise62ef052025-03-18 17:11:54 +00001PROJECT_NAME = "Mbed TLS v3.6.3"
Krzysztof Stachowiaka0188d62018-01-19 16:21:11 +01002OUTPUT_DIRECTORY = ../apidoc/
Paul Bakker37ca75d2011-01-06 12:28:03 +00003FULL_PATH_NAMES = NO
Paul Bakker37ca75d2011-01-06 12:28:03 +00004OPTIMIZE_OUTPUT_FOR_C = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +00005EXTRACT_ALL = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +00006EXTRACT_PRIVATE = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +00007EXTRACT_STATIC = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +00008CASE_SENSE_NAMES = NO
Gilles Peskine51860142024-01-23 17:45:33 +01009INPUT = ../include input ../tests/include/alt-dummy
Manuel Pégourié-Gonnard27d81392015-03-10 17:37:30 +000010FILE_PATTERNS = *.h
Paul Bakker37ca75d2011-01-06 12:28:03 +000011RECURSIVE = YES
Gilles Peskine11d3cf42017-12-22 15:34:37 +010012EXCLUDE_SYMLINKS = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +000013SOURCE_BROWSER = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +000014REFERENCED_BY_RELATION = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +000015REFERENCES_RELATION = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +000016ALPHABETICAL_INDEX = NO
Paul Bakker37ca75d2011-01-06 12:28:03 +000017HTML_OUTPUT = .
Paul Bakker37ca75d2011-01-06 12:28:03 +000018HTML_TIMESTAMP = YES
Andrzej Kurek47cfd152022-01-21 08:43:44 -050019SEARCHENGINE = YES
Paul Bakker37ca75d2011-01-06 12:28:03 +000020GENERATE_LATEX = NO
David Horstmanndbee8832023-03-22 17:35:14 +000021GENERATE_XML = YES
Mateusz Starzykbeb95b42021-05-20 14:41:22 +020022MACRO_EXPANSION = YES
Mateusz Starzykbeb95b42021-05-20 14:41:22 +020023EXPAND_ONLY_PREDEF = YES
Andrzej Kurek593adc82020-03-27 12:58:13 -040024INCLUDE_PATH = ../include
Mateusz Starzykbeb95b42021-05-20 14:41:22 +020025EXPAND_AS_DEFINED = MBEDTLS_PRIVATE
Paul Bakker37ca75d2011-01-06 12:28:03 +000026CLASS_DIAGRAMS = NO
Paul Bakker37ca75d2011-01-06 12:28:03 +000027HAVE_DOT = YES
Paul Bakker13a94a12013-09-10 16:17:15 +020028DOT_GRAPH_MAX_NODES = 200
Paul Bakker37ca75d2011-01-06 12:28:03 +000029MAX_DOT_GRAPH_DEPTH = 1000
Paul Bakker37ca75d2011-01-06 12:28:03 +000030DOT_TRANSPARENT = YES
Gilles Peskine8ea7d852023-02-14 19:15:40 +010031
Gilles Peskine2fb4e142023-02-23 13:37:54 +010032# We mostly use \retval declarations to document which error codes a function
Gilles Peskine4348a832023-02-23 13:03:30 +010033# 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 Peskine8ea7d852023-02-14 19:15:40 +010040# https://github.com/Mbed-TLS/mbedtls/issues/6960
41# https://github.com/llvm/llvm-project/issues/60315
Gilles Peskine4348a832023-02-23 13:03:30 +010042# As a workaround, you can write something like
Gilles Peskine787f7c82023-02-21 10:21:12 +010043# \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
Gilles Peskine4348a832023-02-23 13:03:30 +010044# This avoids writing redundant text and keeps Clang happy.
Gilles Peskine8ea7d852023-02-14 19:15:40 +010045ALIASES += emptydescription=""
David Horstmann1d46bfb2023-03-14 14:20:38 +000046
David Horstmannb9f06742023-03-16 16:07:12 +000047# 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)=" \
Andrzej Kurek2b3c06e2023-07-03 06:52:37 -040054 "__DOXYGEN__" \
David Horstmannb9f06742023-03-16 16:07:12 +000055