lib/mbedtls
1
0
Fork 0
mirror of https://github.com/Mbed-TLS/mbedtls.git synced 2025-06-25 12:41:56 +03:00
Code Activity

Merge pull request #7310 from Mbed-TLS/2.28-sphinx-versioned-documentation

Browse Source 
[Backport 2.28] Generate API documentation with Sphinx and Breathe
This commit is contained in:
Dave Rodgman
2023-03-29 14:43:08 +01:00
committed by GitHub
parent 640d07e198 4b30783be4
commit 87af9c38d6
9 changed files with 203 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
doxygen/mbedtls.doxyfile
View File

@ -19,6 +19,9 @@ HTML_OUTPUT = .
HTML_TIMESTAMP = YES
SEARCHENGINE = YES
GENERATE_LATEX = NO
GENERATE_XML = YES
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
INCLUDE_PATH = ../include
CLASS_DIAGRAMS = NO
HAVE_DOT = YES
@ -40,3 +43,12 @@ DOT_TRANSPARENT = YES
# \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
# This avoids writing redundant text and keeps Clang happy.
ALIASES += emptydescription=""
# Define away Mbed TLS macros that make parsing definitions difficult.
# MBEDTLS_DEPRECATED is not included in this list as it's important to
# display deprecated status in the documentation.
PREDEFINED = "MBEDTLS_CHECK_RETURN_CRITICAL=" \
"MBEDTLS_CHECK_RETURN_TYPICAL=" \
"MBEDTLS_CHECK_RETURN_OPTIONAL=" \
"MBEDTLS_PRINTF_ATTRIBUTE(a,b)=" \