1PROJECT_NAME           = "Mbed TLS v3.5.2"
2OUTPUT_DIRECTORY       = ../apidoc/
3FULL_PATH_NAMES        = NO
4OPTIMIZE_OUTPUT_FOR_C  = YES
5EXTRACT_ALL            = YES
6EXTRACT_PRIVATE        = YES
7EXTRACT_STATIC         = YES
8CASE_SENSE_NAMES       = NO
9INPUT                  = ../include input
10FILE_PATTERNS          = *.h
11RECURSIVE              = YES
12EXCLUDE_SYMLINKS       = YES
13SOURCE_BROWSER         = YES
14REFERENCED_BY_RELATION = YES
15REFERENCES_RELATION    = YES
16ALPHABETICAL_INDEX     = NO
17HTML_OUTPUT            = .
18HTML_TIMESTAMP         = YES
19SEARCHENGINE           = YES
20GENERATE_LATEX         = NO
21GENERATE_XML           = YES
22MACRO_EXPANSION        = YES
23EXPAND_ONLY_PREDEF     = YES
24INCLUDE_PATH           = ../include
25EXPAND_AS_DEFINED      = MBEDTLS_PRIVATE
26CLASS_DIAGRAMS         = NO
27HAVE_DOT               = YES
28DOT_GRAPH_MAX_NODES    = 200
29MAX_DOT_GRAPH_DEPTH    = 1000
30DOT_TRANSPARENT        = YES
31
32# We mostly use \retval declarations to document which error codes a function
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.
40#   https://github.com/Mbed-TLS/mbedtls/issues/6960
41#   https://github.com/llvm/llvm-project/issues/60315
42# As a workaround, you can write something like
43#     \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
44# This avoids writing redundant text and keeps Clang happy.
45ALIASES += emptydescription=""
46
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                         "__DOXYGEN__"                      \
55
56