mbedtls.doxyfile 1.7 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344
  1. PROJECT_NAME = "mbed TLS v3.4.0"
  2. OUTPUT_DIRECTORY = ../apidoc/
  3. FULL_PATH_NAMES = NO
  4. OPTIMIZE_OUTPUT_FOR_C = YES
  5. EXTRACT_ALL = YES
  6. EXTRACT_PRIVATE = YES
  7. EXTRACT_STATIC = YES
  8. CASE_SENSE_NAMES = NO
  9. INPUT = ../include input
  10. FILE_PATTERNS = *.h
  11. RECURSIVE = YES
  12. EXCLUDE_SYMLINKS = YES
  13. SOURCE_BROWSER = YES
  14. REFERENCED_BY_RELATION = YES
  15. REFERENCES_RELATION = YES
  16. ALPHABETICAL_INDEX = NO
  17. HTML_OUTPUT = .
  18. HTML_TIMESTAMP = YES
  19. SEARCHENGINE = YES
  20. GENERATE_LATEX = NO
  21. MACRO_EXPANSION = YES
  22. EXPAND_ONLY_PREDEF = YES
  23. INCLUDE_PATH = ../include
  24. EXPAND_AS_DEFINED = MBEDTLS_PRIVATE
  25. CLASS_DIAGRAMS = NO
  26. HAVE_DOT = YES
  27. DOT_GRAPH_MAX_NODES = 200
  28. MAX_DOT_GRAPH_DEPTH = 1000
  29. DOT_TRANSPARENT = YES
  30. # We mostly use \retval declarations to document which error codes a function
  31. # can return. The reader can follow the hyperlink to the definition of the
  32. # constant to get the generic documentation of that error code. If we don't
  33. # have anything to say about the specific error code for the specific
  34. # function, we can leave the description part of the \retval command blank.
  35. # This is perfectly valid as far as Doxygen is concerned. However, with
  36. # Clang >=15, the -Wdocumentation option emits a warning for empty
  37. # descriptions.
  38. # https://github.com/Mbed-TLS/mbedtls/issues/6960
  39. # https://github.com/llvm/llvm-project/issues/60315
  40. # As a workaround, you can write something like
  41. # \retval #PSA_ERROR_INSUFFICIENT_MEMORY \emptydescription
  42. # This avoids writing redundant text and keeps Clang happy.
  43. ALIASES += emptydescription=""