| David Horstmann | 7ba04a2 | 2024-09-03 17:36:30 +0100 | [diff] [blame] | 1 | PROJECT_NAME = "Mbed TLS v4.0.0" |
| Krzysztof Stachowiak | a0188d6 | 2018-01-19 16:21:11 +0100 | [diff] [blame] | 2 | OUTPUT_DIRECTORY = ../apidoc/ |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 3 | FULL_PATH_NAMES = NO |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 4 | OPTIMIZE_OUTPUT_FOR_C = YES |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 5 | EXTRACT_ALL = YES |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 6 | EXTRACT_PRIVATE = YES |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 7 | EXTRACT_STATIC = YES |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 8 | CASE_SENSE_NAMES = NO |
| Ronald Cron | 09de583 | 2024-06-17 13:52:55 +0200 | [diff] [blame] | 9 | INPUT = ../include ../tf-psa-crypto/include input ../tf-psa-crypto/drivers/builtin/include ../tests/include/alt-dummy |
| Ronald Cron | 51f228c | 2024-11-06 14:32:52 +0100 | [diff] [blame] | 10 | EXCLUDE = ../tf-psa-crypto/drivers/builtin/include/mbedtls/build_info.h |
| Manuel Pégourié-Gonnard | 27d8139 | 2015-03-10 17:37:30 +0000 | [diff] [blame] | 11 | FILE_PATTERNS = *.h |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 12 | RECURSIVE = YES |
| Gilles Peskine | 11d3cf4 | 2017-12-22 15:34:37 +0100 | [diff] [blame] | 13 | EXCLUDE_SYMLINKS = YES |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 14 | SOURCE_BROWSER = YES |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 15 | REFERENCED_BY_RELATION = YES |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 16 | REFERENCES_RELATION = YES |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 17 | ALPHABETICAL_INDEX = NO |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 18 | HTML_OUTPUT = . |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 19 | HTML_TIMESTAMP = YES |
| Andrzej Kurek | 47cfd15 | 2022-01-21 08:43:44 -0500 | [diff] [blame] | 20 | SEARCHENGINE = YES |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 21 | GENERATE_LATEX = NO |
| David Horstmann | dbee883 | 2023-03-22 17:35:14 +0000 | [diff] [blame] | 22 | GENERATE_XML = YES |
| Mateusz Starzyk | beb95b4 | 2021-05-20 14:41:22 +0200 | [diff] [blame] | 23 | MACRO_EXPANSION = YES |
| Mateusz Starzyk | beb95b4 | 2021-05-20 14:41:22 +0200 | [diff] [blame] | 24 | EXPAND_ONLY_PREDEF = YES |
| Ronald Cron | 09de583 | 2024-06-17 13:52:55 +0200 | [diff] [blame] | 25 | INCLUDE_PATH = ../include ../tf-psa-crypto/include ../tf-psa-crypto/drivers/builtin/include |
| Mateusz Starzyk | beb95b4 | 2021-05-20 14:41:22 +0200 | [diff] [blame] | 26 | EXPAND_AS_DEFINED = MBEDTLS_PRIVATE |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 27 | CLASS_DIAGRAMS = NO |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 28 | HAVE_DOT = YES |
| Paul Bakker | 13a94a1 | 2013-09-10 16:17:15 +0200 | [diff] [blame] | 29 | DOT_GRAPH_MAX_NODES = 200 |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 30 | MAX_DOT_GRAPH_DEPTH = 1000 |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 31 | DOT_TRANSPARENT = YES |
| Gilles Peskine | 8ea7d85 | 2023-02-14 19:15:40 +0100 | [diff] [blame] | 32 | |
| Gilles Peskine | 2fb4e14 | 2023-02-23 13:37:54 +0100 | [diff] [blame] | 33 | # We mostly use \retval declarations to document which error codes a function |
| Gilles Peskine | 4348a83 | 2023-02-23 13:03:30 +0100 | [diff] [blame] | 34 | # can return. The reader can follow the hyperlink to the definition of the |
| 35 | # constant to get the generic documentation of that error code. If we don't |
| 36 | # have anything to say about the specific error code for the specific |
| 37 | # function, we can leave the description part of the \retval command blank. |
| 38 | # This is perfectly valid as far as Doxygen is concerned. However, with |
| 39 | # Clang >=15, the -Wdocumentation option emits a warning for empty |
| 40 | # descriptions. |
| Gilles Peskine | 8ea7d85 | 2023-02-14 19:15:40 +0100 | [diff] [blame] | 41 | # https://github.com/Mbed-TLS/mbedtls/issues/6960 |
| 42 | # https://github.com/llvm/llvm-project/issues/60315 |
| Gilles Peskine | 4348a83 | 2023-02-23 13:03:30 +0100 | [diff] [blame] | 43 | # As a workaround, you can write something like |
| Gilles Peskine | 787f7c8 | 2023-02-21 10:21:12 +0100 | [diff] [blame] | 44 | # \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription |
| Gilles Peskine | 4348a83 | 2023-02-23 13:03:30 +0100 | [diff] [blame] | 45 | # This avoids writing redundant text and keeps Clang happy. |
| Gilles Peskine | 8ea7d85 | 2023-02-14 19:15:40 +0100 | [diff] [blame] | 46 | ALIASES += emptydescription="" |
| David Horstmann | 1d46bfb | 2023-03-14 14:20:38 +0000 | [diff] [blame] | 47 | |
| David Horstmann | b9f0674 | 2023-03-16 16:07:12 +0000 | [diff] [blame] | 48 | # Define away Mbed TLS macros that make parsing definitions difficult. |
| 49 | # MBEDTLS_DEPRECATED is not included in this list as it's important to |
| 50 | # display deprecated status in the documentation. |
| 51 | PREDEFINED = "MBEDTLS_CHECK_RETURN_CRITICAL=" \ |
| 52 | "MBEDTLS_CHECK_RETURN_TYPICAL=" \ |
| 53 | "MBEDTLS_CHECK_RETURN_OPTIONAL=" \ |
| 54 | "MBEDTLS_PRINTF_ATTRIBUTE(a,b)=" \ |
| Andrzej Kurek | 2b3c06e | 2023-07-03 06:52:37 -0400 | [diff] [blame] | 55 | "__DOXYGEN__" \ |
| David Horstmann | b9f0674 | 2023-03-16 16:07:12 +0000 | [diff] [blame] | 56 | |