mbedtls.doxyfile (2287B)
1 PROJECT_NAME = "Mbed TLS v3.6.4" 2 OUTPUT_DIRECTORY = ../apidoc/ 3 FULL_PATH_NAMES = NO 4 OPTIMIZE_OUTPUT_FOR_C = YES 5 EXTRACT_ALL = YES 6 EXTRACT_PRIVATE = YES 7 EXTRACT_STATIC = YES 8 CASE_SENSE_NAMES = NO 9 INPUT = ../include input ../tests/include/alt-dummy 10 FILE_PATTERNS = *.h 11 RECURSIVE = YES 12 EXCLUDE_SYMLINKS = YES 13 SOURCE_BROWSER = YES 14 REFERENCED_BY_RELATION = YES 15 REFERENCES_RELATION = YES 16 ALPHABETICAL_INDEX = NO 17 HTML_OUTPUT = . 18 HTML_TIMESTAMP = YES 19 SEARCHENGINE = YES 20 GENERATE_LATEX = NO 21 GENERATE_XML = YES 22 MACRO_EXPANSION = YES 23 EXPAND_ONLY_PREDEF = YES 24 INCLUDE_PATH = ../include 25 EXPAND_AS_DEFINED = MBEDTLS_PRIVATE 26 CLASS_DIAGRAMS = NO 27 HAVE_DOT = YES 28 DOT_GRAPH_MAX_NODES = 200 29 MAX_DOT_GRAPH_DEPTH = 1000 30 DOT_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. 45 ALIASES += 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. 50 PREDEFINED = "MBEDTLS_CHECK_RETURN_CRITICAL=" \ 51 "MBEDTLS_CHECK_RETURN_TYPICAL=" \ 52 "MBEDTLS_CHECK_RETURN_OPTIONAL=" \ 53 "MBEDTLS_PRINTF_ATTRIBUTE(a,b)=" \ 54 "__DOXYGEN__" \ 55