mbedtls/doxygen/mbedtls.doxyfile

PROJECT_NAME           = "mbed TLS v3.1.0"
OUTPUT_DIRECTORY       = ../apidoc/
FULL_PATH_NAMES        = NO
OPTIMIZE_OUTPUT_FOR_C  = YES
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES
CASE_SENSE_NAMES       = NO
INPUT                  = ../include input
FILE_PATTERNS          = *.h
RECURSIVE              = YES
EXCLUDE_SYMLINKS       = YES
SOURCE_BROWSER         = YES
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION    = YES
ALPHABETICAL_INDEX     = NO
HTML_OUTPUT            = .
HTML_TIMESTAMP         = YES
SEARCHENGINE           = YES
GENERATE_LATEX         = NO
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
INCLUDE_PATH           = ../include
EXPAND_AS_DEFINED      = MBEDTLS_PRIVATE
CLASS_DIAGRAMS         = NO
HAVE_DOT               = YES
DOT_GRAPH_MAX_NODES    = 200
MAX_DOT_GRAPH_DEPTH    = 1000
DOT_TRANSPARENT        = YES
Bump version to 3.1.0 Executed ./scripts/bump_version.sh --version 3.1.0 --so-crypto 11 --so-tls 17 + fix of build_info.h Signed-off-by: Ronald Cron <ronald.cron@arm.com> 2021-12-14 15:16:59 +00:00			`PROJECT_NAME = "mbed TLS v3.1.0"`
Have doxygen run in the doxygen directory When the Doxywizzard GUI is used and the doxyfile is loaded, the workind directory for doxygen is set to the location of the doxyfile. However the Make and CMake build systems expect doxygen to be ran from the top level directory. This commit unifies the build system and the Doxywizzard GUI so that all of them expect doxygen to be executed in the doxygen directory. 2018-01-19 15:21:11 +00:00			`OUTPUT_DIRECTORY = ../apidoc/`
- Added Doxygen source code documentation parts (donated by Fox-IT) 2011-01-06 12:28:03 +00:00			`FULL_PATH_NAMES = NO`
			`OPTIMIZE_OUTPUT_FOR_C = YES`
			`EXTRACT_ALL = YES`
			`EXTRACT_PRIVATE = YES`
			`EXTRACT_STATIC = YES`
			`CASE_SENSE_NAMES = NO`
Look for documentation only in specific directories Generate the documentation from include and doxygen/input only. Don't get snared by files containing Doxygen comments that lie in other directories such as tests, yotta, crypto/include, ... The only difference this makes in a fresh checkout is that the documentation no longer lists target_config.h. This file is from yotta, does not contain any Doxygen comment, and its inclusion in the rendered documentation was clearly an oversight. 2018-09-26 15:49:57 +00:00			`INPUT = ../include input`
Use only headers for doxygen (no doc in C files) 2015-03-10 17:37:30 +00:00			`FILE_PATTERNS = *.h`
- Added Doxygen source code documentation parts (donated by Fox-IT) 2011-01-06 12:28:03 +00:00			`RECURSIVE = YES`
Doxygen: don't traverse symbolic links We don't use symbolic links as part of our build process, so tell Doxygen not to traverse them. In particular, if I have a symbolic link to a directory outside the build tree, I don't want Doxygen to follow it. 2017-12-22 14:34:37 +00:00			`EXCLUDE_SYMLINKS = YES`
- Added Doxygen source code documentation parts (donated by Fox-IT) 2011-01-06 12:28:03 +00:00			`SOURCE_BROWSER = YES`
			`REFERENCED_BY_RELATION = YES`
			`REFERENCES_RELATION = YES`
			`ALPHABETICAL_INDEX = NO`
			`HTML_OUTPUT = .`
			`HTML_TIMESTAMP = YES`
doxygen: enable the search engine Signed-off-by: Andrzej Kurek <andrzej.kurek@arm.com> 2022-01-21 13:43:44 +00:00			`SEARCHENGINE = YES`
- Added Doxygen source code documentation parts (donated by Fox-IT) 2011-01-06 12:28:03 +00:00			`GENERATE_LATEX = NO`
Adjust doxyfile to expand MBEDTLS_PRIVATE macro. Signed-off-by: Mateusz Starzyk <mateusz.starzyk@mobica.com> 2021-05-20 12:41:22 +00:00			`MACRO_EXPANSION = YES`
			`EXPAND_ONLY_PREDEF = YES`
Add an include path to the doxyfile to fix preprocessing for docs Previously, doxygen was unable to effectively use preprocessing to determine which parts of code should be documented. This was due to its inability to include headers during preprocessing, which was discovered by running it in preprocessing debug mode: doxygen -d preprocessor mbedtls.doxyfile An example of failure: "#include mbedtls/config.h: not found! skipping..." With the following fix includes are properly preprocessed with the documentation being considerably larger. Signed-off-by: Andrzej Kurek <andrzej.kurek@arm.com> 2020-03-27 16:58:13 +00:00			`INCLUDE_PATH = ../include`
Adjust doxyfile to expand MBEDTLS_PRIVATE macro. Signed-off-by: Mateusz Starzyk <mateusz.starzyk@mobica.com> 2021-05-20 12:41:22 +00:00			`EXPAND_AS_DEFINED = MBEDTLS_PRIVATE`
- Added Doxygen source code documentation parts (donated by Fox-IT) 2011-01-06 12:28:03 +00:00			`CLASS_DIAGRAMS = NO`
			`HAVE_DOT = YES`
Upgraded doxygen config file 2013-09-10 14:17:15 +00:00			`DOT_GRAPH_MAX_NODES = 200`
- Added Doxygen source code documentation parts (donated by Fox-IT) 2011-01-06 12:28:03 +00:00			`MAX_DOT_GRAPH_DEPTH = 1000`
			`DOT_TRANSPARENT = YES`