Dave Rodgman | 48223bc | 2022-12-08 14:43:19 +0000 | [diff] [blame] | 1 | PROJECT_NAME = "mbed TLS v3.3.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 |
Gilles Peskine | a9daa5c | 2018-09-26 17:49:57 +0200 | [diff] [blame] | 9 | INPUT = ../include input |
Manuel Pégourié-Gonnard | 27d8139 | 2015-03-10 17:37:30 +0000 | [diff] [blame] | 10 | FILE_PATTERNS = *.h |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 11 | RECURSIVE = YES |
Gilles Peskine | 11d3cf4 | 2017-12-22 15:34:37 +0100 | [diff] [blame] | 12 | EXCLUDE_SYMLINKS = YES |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 13 | SOURCE_BROWSER = YES |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 14 | REFERENCED_BY_RELATION = YES |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 15 | REFERENCES_RELATION = YES |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 16 | ALPHABETICAL_INDEX = NO |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 17 | HTML_OUTPUT = . |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 18 | HTML_TIMESTAMP = YES |
Andrzej Kurek | 47cfd15 | 2022-01-21 08:43:44 -0500 | [diff] [blame] | 19 | SEARCHENGINE = YES |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 20 | GENERATE_LATEX = NO |
Mateusz Starzyk | beb95b4 | 2021-05-20 14:41:22 +0200 | [diff] [blame] | 21 | MACRO_EXPANSION = YES |
Mateusz Starzyk | beb95b4 | 2021-05-20 14:41:22 +0200 | [diff] [blame] | 22 | EXPAND_ONLY_PREDEF = YES |
Andrzej Kurek | 593adc8 | 2020-03-27 12:58:13 -0400 | [diff] [blame] | 23 | INCLUDE_PATH = ../include |
Mateusz Starzyk | beb95b4 | 2021-05-20 14:41:22 +0200 | [diff] [blame] | 24 | EXPAND_AS_DEFINED = MBEDTLS_PRIVATE |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 25 | CLASS_DIAGRAMS = NO |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 26 | HAVE_DOT = YES |
Paul Bakker | 13a94a1 | 2013-09-10 16:17:15 +0200 | [diff] [blame] | 27 | DOT_GRAPH_MAX_NODES = 200 |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 28 | MAX_DOT_GRAPH_DEPTH = 1000 |
Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 29 | DOT_TRANSPARENT = YES |
Gilles Peskine | 8ea7d85 | 2023-02-14 19:15:40 +0100 | [diff] [blame] | 30 | |
| 31 | # Doxygen accepts empty descriptions for commands such as \retval, |
| 32 | # but clang -Wdocumentation doesn't (since Clang 15, for \retval). |
| 33 | # https://github.com/Mbed-TLS/mbedtls/issues/6960 |
| 34 | # https://github.com/llvm/llvm-project/issues/60315 |
Gilles Peskine | 787f7c8 | 2023-02-21 10:21:12 +0100 | [diff] [blame^] | 35 | # We often use \retval declarations with just a constant name to |
| 36 | # document which error codes a function can return. If the documentation |
| 37 | # of the error code is enough to explain the error, then an empty |
| 38 | # description on the \retval statement is ok. However, the source code |
| 39 | # of the description needs to be made non-empty to pacify Clang. |
| 40 | # In such cases, you can write something like |
| 41 | # \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription |
Gilles Peskine | 8ea7d85 | 2023-02-14 19:15:40 +0100 | [diff] [blame] | 42 | # This does not change the documentation generated by Doxygen, but |
| 43 | # it pacifies clang -Wdocumentation. |
| 44 | ALIASES += emptydescription="" |