| Aditya Deshpande | 7428c61 | 2022-12-08 11:04:44 +0000 | [diff] [blame] | 1 | PROJECT_NAME = "mbed TLS v2.28.2" |
| 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 |
| Manuel Pégourié-Gonnard | 35d07bf | 2016-01-08 16:48:51 +0100 | [diff] [blame] | 13 | EXCLUDE_PATTERNS = *_internal.h *_wrap.h |
| 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 | ef3f27b | 2022-02-15 06:56:16 -0500 | [diff] [blame] | 20 | SEARCHENGINE = YES |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 21 | GENERATE_LATEX = NO |
| Andrzej Kurek | 593adc8 | 2020-03-27 12:58:13 -0400 | [diff] [blame] | 22 | INCLUDE_PATH = ../include |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 23 | CLASS_DIAGRAMS = NO |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 24 | HAVE_DOT = YES |
| Paul Bakker | 13a94a1 | 2013-09-10 16:17:15 +0200 | [diff] [blame] | 25 | DOT_GRAPH_MAX_NODES = 200 |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 26 | MAX_DOT_GRAPH_DEPTH = 1000 |
| Paul Bakker | 37ca75d | 2011-01-06 12:28:03 +0000 | [diff] [blame] | 27 | DOT_TRANSPARENT = YES |
| Gilles Peskine | 2fb14e9 | 2023-02-14 19:15:40 +0100 | [diff] [blame] | 28 | |
| Gilles Peskine | 809c3d5 | 2023-02-23 13:37:54 +0100 | [diff] [blame] | 29 | # We mostly use \retval declarations to document which error codes a function |
| Gilles Peskine | 8377f3d | 2023-02-23 13:03:30 +0100 | [diff] [blame] | 30 | # can return. The reader can follow the hyperlink to the definition of the |
| 31 | # constant to get the generic documentation of that error code. If we don't |
| 32 | # have anything to say about the specific error code for the specific |
| 33 | # function, we can leave the description part of the \retval command blank. |
| 34 | # This is perfectly valid as far as Doxygen is concerned. However, with |
| 35 | # Clang >=15, the -Wdocumentation option emits a warning for empty |
| 36 | # descriptions. |
| Gilles Peskine | 2fb14e9 | 2023-02-14 19:15:40 +0100 | [diff] [blame] | 37 | # https://github.com/Mbed-TLS/mbedtls/issues/6960 |
| 38 | # https://github.com/llvm/llvm-project/issues/60315 |
| Gilles Peskine | 8377f3d | 2023-02-23 13:03:30 +0100 | [diff] [blame] | 39 | # As a workaround, you can write something like |
| Gilles Peskine | 4b86f53 | 2023-02-21 10:21:12 +0100 | [diff] [blame] | 40 | # \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription |
| Gilles Peskine | 8377f3d | 2023-02-23 13:03:30 +0100 | [diff] [blame] | 41 | # This avoids writing redundant text and keeps Clang happy. |
| Gilles Peskine | 2fb14e9 | 2023-02-14 19:15:40 +0100 | [diff] [blame] | 42 | ALIASES += emptydescription="" |