Skip to content

Doxygen features/Frameworks updates to not produce warnings and errors [DOC Changes Only] #4452

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 2 commits into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion doxyfile_options
Original file line number Diff line number Diff line change
Expand Up @@ -848,7 +848,6 @@ EXCLUDE_PATTERNS = */tools/* \
*/features/mbedtls/* \
*/features/storage/* \
*/features/unsupported/* \
*/features/frameworks/* \
*/features/filesystem/* \

# The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
Expand Down
2 changes: 1 addition & 1 deletion doxygen_options.json
Original file line number Diff line number Diff line change
Expand Up @@ -8,5 +8,5 @@
"PREDEFINED": "DOXYGEN_ONLY \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\"",
"EXPAND_AS_DEFINED": "",
"SKIP_FUNCTION_MACROS": "NO",
"EXCLUDE_PATTERNS": "*/tools/* */TESTS/* */targets/* */FEATURE_*/* */features/mbedtls/* */features/storage/* */features/unsupported/* */features/frameworks/* */features/filesystem/* */BUILD/* */rtos/* */events/* */cmsis/* */hal/* */features/FEATURES_*"
"EXCLUDE_PATTERNS": "*/tools/* */TESTS/* */targets/* */FEATURE_*/* */features/mbedtls/* */features/storage/* */features/unsupported/* */features/filesystem/* */BUILD/* */rtos/* */events/* */cmsis/* */hal/* */features/FEATURES_*"
}
8 changes: 8 additions & 0 deletions features/frameworks/utest/utest/utest_default_handlers.h
Original file line number Diff line number Diff line change
Expand Up @@ -38,13 +38,17 @@ namespace v1 {
*/
static const struct
{
///@cond IGNORE
// Doxygen can't parse these implicit conversion operators properly, remove from
// doc build
operator test_setup_handler_t() const { return test_setup_handler_t(1); }
operator test_teardown_handler_t() const { return test_teardown_handler_t(1); }
operator test_failure_handler_t() const { return test_failure_handler_t(1); }

operator case_setup_handler_t() const { return case_setup_handler_t(1); }
operator case_teardown_handler_t() const { return case_teardown_handler_t(1); }
operator case_failure_handler_t() const { return case_failure_handler_t(1); }
///@endcond
} default_handler;

/** Ignore handler hint.
Expand All @@ -55,6 +59,9 @@ namespace v1 {
*/
static const struct
{
///@cond IGNORE
// Doxygen can't parse these implicit conversion operators properly, remove from
// doc build
operator case_handler_t() const { return case_handler_t(NULL); }
operator case_control_handler_t() const { return case_control_handler_t(NULL); }
operator case_call_count_handler_t() const { return case_call_count_handler_t(NULL); }
Expand All @@ -66,6 +73,7 @@ namespace v1 {
operator case_setup_handler_t() const { return case_setup_handler_t(NULL); }
operator case_teardown_handler_t() const { return case_teardown_handler_t(NULL); }
operator case_failure_handler_t() const { return case_failure_handler_t(NULL); }
///@endcond
} ignore_handler;

/** A table of handlers.
Expand Down
4 changes: 4 additions & 0 deletions features/frameworks/utest/utest/utest_types.h
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ namespace utest {
/** @{*/
namespace v1 {

/// repeat_t
enum repeat_t {
REPEAT_UNDECLR = 0,
REPEAT_NONE = 1, ///< continue with the next test case
Expand All @@ -47,12 +48,14 @@ namespace v1 {
REPEAT_HANDLER = REPEAT_CASE_ONLY | REPEAT_ON_VALIDATE ///< repeat only the handler
};

/// status_t
enum status_t {
STATUS_CONTINUE = -1, ///< continues testing
STATUS_IGNORE = -2, ///< ignores failure and continues testing
STATUS_ABORT = -3 ///< stops testing
};

/// failure_reason_t
enum failure_reason_t {
REASON_NONE = 0, ///< No failure occurred

Expand All @@ -74,6 +77,7 @@ namespace v1 {
REASON_IGNORE = 0x8000 ///< The failure may be ignored
};

/// location_t
enum location_t {
LOCATION_NONE = 0, ///< No location information
LOCATION_TEST_SETUP, ///< A failure occurred in the test setup
Expand Down