xref: /aosp_15_r20/external/mbedtls/doxygen/mbedtls.doxyfile (revision 62c56f9862f102b96d72393aff6076c951fb8148)
1*62c56f98SSadaf EbrahimiPROJECT_NAME           = "Mbed TLS v3.5.2"
2*62c56f98SSadaf EbrahimiOUTPUT_DIRECTORY       = ../apidoc/
3*62c56f98SSadaf EbrahimiFULL_PATH_NAMES        = NO
4*62c56f98SSadaf EbrahimiOPTIMIZE_OUTPUT_FOR_C  = YES
5*62c56f98SSadaf EbrahimiEXTRACT_ALL            = YES
6*62c56f98SSadaf EbrahimiEXTRACT_PRIVATE        = YES
7*62c56f98SSadaf EbrahimiEXTRACT_STATIC         = YES
8*62c56f98SSadaf EbrahimiCASE_SENSE_NAMES       = NO
9*62c56f98SSadaf EbrahimiINPUT                  = ../include input
10*62c56f98SSadaf EbrahimiFILE_PATTERNS          = *.h
11*62c56f98SSadaf EbrahimiRECURSIVE              = YES
12*62c56f98SSadaf EbrahimiEXCLUDE_SYMLINKS       = YES
13*62c56f98SSadaf EbrahimiSOURCE_BROWSER         = YES
14*62c56f98SSadaf EbrahimiREFERENCED_BY_RELATION = YES
15*62c56f98SSadaf EbrahimiREFERENCES_RELATION    = YES
16*62c56f98SSadaf EbrahimiALPHABETICAL_INDEX     = NO
17*62c56f98SSadaf EbrahimiHTML_OUTPUT            = .
18*62c56f98SSadaf EbrahimiHTML_TIMESTAMP         = YES
19*62c56f98SSadaf EbrahimiSEARCHENGINE           = YES
20*62c56f98SSadaf EbrahimiGENERATE_LATEX         = NO
21*62c56f98SSadaf EbrahimiGENERATE_XML           = YES
22*62c56f98SSadaf EbrahimiMACRO_EXPANSION        = YES
23*62c56f98SSadaf EbrahimiEXPAND_ONLY_PREDEF     = YES
24*62c56f98SSadaf EbrahimiINCLUDE_PATH           = ../include
25*62c56f98SSadaf EbrahimiEXPAND_AS_DEFINED      = MBEDTLS_PRIVATE
26*62c56f98SSadaf EbrahimiCLASS_DIAGRAMS         = NO
27*62c56f98SSadaf EbrahimiHAVE_DOT               = YES
28*62c56f98SSadaf EbrahimiDOT_GRAPH_MAX_NODES    = 200
29*62c56f98SSadaf EbrahimiMAX_DOT_GRAPH_DEPTH    = 1000
30*62c56f98SSadaf EbrahimiDOT_TRANSPARENT        = YES
31*62c56f98SSadaf Ebrahimi
32*62c56f98SSadaf Ebrahimi# We mostly use \retval declarations to document which error codes a function
33*62c56f98SSadaf Ebrahimi# can return. The reader can follow the hyperlink to the definition of the
34*62c56f98SSadaf Ebrahimi# constant to get the generic documentation of that error code. If we don't
35*62c56f98SSadaf Ebrahimi# have anything to say about the specific error code for the specific
36*62c56f98SSadaf Ebrahimi# function, we can leave the description part of the \retval command blank.
37*62c56f98SSadaf Ebrahimi# This is perfectly valid as far as Doxygen is concerned. However, with
38*62c56f98SSadaf Ebrahimi# Clang >=15, the -Wdocumentation option emits a warning for empty
39*62c56f98SSadaf Ebrahimi# descriptions.
40*62c56f98SSadaf Ebrahimi#   https://github.com/Mbed-TLS/mbedtls/issues/6960
41*62c56f98SSadaf Ebrahimi#   https://github.com/llvm/llvm-project/issues/60315
42*62c56f98SSadaf Ebrahimi# As a workaround, you can write something like
43*62c56f98SSadaf Ebrahimi#     \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
44*62c56f98SSadaf Ebrahimi# This avoids writing redundant text and keeps Clang happy.
45*62c56f98SSadaf EbrahimiALIASES += emptydescription=""
46*62c56f98SSadaf Ebrahimi
47*62c56f98SSadaf Ebrahimi# Define away Mbed TLS macros that make parsing definitions difficult.
48*62c56f98SSadaf Ebrahimi# MBEDTLS_DEPRECATED is not included in this list as it's important to
49*62c56f98SSadaf Ebrahimi# display deprecated status in the documentation.
50*62c56f98SSadaf EbrahimiPREDEFINED             = "MBEDTLS_CHECK_RETURN_CRITICAL="   \
51*62c56f98SSadaf Ebrahimi                         "MBEDTLS_CHECK_RETURN_TYPICAL="    \
52*62c56f98SSadaf Ebrahimi                         "MBEDTLS_CHECK_RETURN_OPTIONAL="   \
53*62c56f98SSadaf Ebrahimi                         "MBEDTLS_PRINTF_ATTRIBUTE(a,b)="   \
54*62c56f98SSadaf Ebrahimi                         "__DOXYGEN__"                      \
55*62c56f98SSadaf Ebrahimi
56