[upstream_utils] Clean up and enable foonathan memory docs (#6990)

Group memory doxygen into one module.

Remove concept alias and add doxygen definitions for foonathan memory.

\concept was added as a doxygen command in 1.9.2 and is meant to be applied to concepts. Inserting them into standard comment paragraphs causes doxygen to interpret the following text as a concept name and add it to the documentation, as well as remove the text from the paragraph.
In the upstream repo, this alias links to markdown documentation, so it's not usable for us anyways.

That, plus adding the doxygen definitions/aliases from upstream cleans up most of the errors/weird output from doxygen for foonathan memory.
This commit is contained in:
Ryan Blue
2024-08-24 09:54:32 -04:00
committed by GitHub
parent 370e63ede6
commit 1fd1dc31b7
35 changed files with 3192 additions and 328 deletions

View File

@@ -290,10 +290,11 @@ TAB_SIZE = 4
# @} or use a double escape (\\{ and \\})
ALIASES = "effects=\par <i>Effects:</i>^^" \
"returns=\par <i>Returns:</i>^^" \
"notes=\par <i>Notes:</i>^^" \
"throws=\par <i>Throws:</i>^^" \
"requires=\par <i>Requires:</i>^^" \
"requiredbe=\par <i>Required Behavior:</i>^^" \
"concept{2}=<a href=\"md_doc_concepts.html#\1\">\2</a>" \
"defaultbe=\par <i>Default Behavior:</i>^^"
# Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C sources
@@ -2443,7 +2444,18 @@ INCLUDE_FILE_PATTERNS =
# recursively expanded use the := operator instead of the = operator.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
PREDEFINED = __cplusplus "HAL_ENUM(name)=enum name : int32_t"
PREDEFINED = __cplusplus \
"HAL_ENUM(name)=enum name : int32_t" \
DOXYGEN \
WPI_NOEXCEPT:=noexcept \
WPI_SFINAE(x):= \
WPI_REQUIRES(x):= \
WPI_REQUIRES_RET(...):= \
WPI_ENABLE_IF(...):= \
WPI_CONSTEXPR:=constexpr \
WPI_CONSTEXPR_FNC:=constexpr \
WPI_IMPL_DEFINED(...):=implementation_defined \
WPI_EBO(...):=
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
# tag can be used to specify a list of macro names that should be expanded. The
@@ -2452,7 +2464,7 @@ PREDEFINED = __cplusplus "HAL_ENUM(name)=enum name : int32_t"
# definition found in the source code.
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
EXPAND_AS_DEFINED =
EXPAND_AS_DEFINED = WPI_ALIAS_TEMPLATE
# If the SKIP_FUNCTION_MACROS tag is set to YES then Doxygen's preprocessor will
# remove all references to function-like macros that are alone on a line, have

View File

@@ -144,9 +144,6 @@ doxygen {
exclude 'units/**'
}
//TODO: building memory docs causes search to break
exclude 'wpi/memory/**'
exclude '*.pb.h'
// Save space by excluding protobuf and eigen

View File

@@ -2799,4 +2799,4 @@ SOFTWARE.
left: var(--spacing-medium) !important;
right: auto;
}
}
}