[platform] Update doxygen comments

[sg-]

Description

Fix warnings and errors when building API docs in the mbed-os/platform directory using doxygen. Still a rouge warning that I haven't yet gotten to the bottom of but other eyes are welcome. Doxyfile attached that is used to build this (matches the developer site settings)

doxyfile-developer.txt

C:\dev\mbed-os>doxygen doxyfile-developer
deprecated:11: warning: explicit link request to 'type' could not be resolved
deprecated:14: warning: explicit link request to 'type' could not be resolved
deprecated:17: warning: explicit link request to 'type' could not be resolved
deprecated:53: warning: explicit link request to 'type' could not be resolved
deprecated:83: warning: explicit link request to 'type' could not be resolved
deprecated:86: warning: explicit link request to 'type' could not be resolved
deprecated:89: warning: explicit link request to 'type' could not be resolved
deprecated:92: warning: explicit link request to 'type' could not be resolved
deprecated:173: warning: explicit link request to 'type' could not be resolved
deprecated:176: warning: explicit link request to 'type' could not be resolved
deprecated:179: warning: explicit link request to 'type' could not be resolved
deprecated:182: warning: explicit link request to 'type' could not be resolved
deprecated:227: warning: explicit link request to 'type' could not be resolved
deprecated:230: warning: explicit link request to 'type' could not be resolved
deprecated:233: warning: explicit link request to 'type' could not be resolved
deprecated:251: warning: explicit link request to 'type' could not be resolved
deprecated:305: warning: explicit link request to 'type' could not be resolved
deprecated:311: warning: explicit link request to 'type' could not be resolved
deprecated:314: warning: explicit link request to 'type' could not be resolved
deprecated:317: warning: explicit link request to 'type' could not be resolved
deprecated:338: warning: explicit link request to 'type' could not be resolved
deprecated:362: warning: explicit link request to 'type' could not be resolved
deprecated:380: warning: explicit link request to 'type' could not be resolved
deprecated:383: warning: explicit link request to 'type' could not be resolved

C:\dev\mbed-os>

Status

IN DEVELOPMENT

[theotherjimmy]

The errors seem to be caused by use of enable_if template parameters like this. @pan- @geky You guys were able to come up with something on the last doxygen related PR. Maybe you could magic us more C++ foo solutions?

[geky]

The best magic I could come up with was to just move the sfinae logic out into a macro that doxygen ignores. It seems like doxygen was having issues with the nested templates?

[0xc0170]

Still needs work? No error anymore?

[theotherjimmy]

@0xc0170 You are correct, it no longer needs work, and may be marked ready for review.

Thanks for the bump.

[sg-]

Pulled the change and looks to still have the same problem

#define MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)                            \
    typename detail::enable_if<                                             \
            detail::is_type<M, &F::operator()>::value &&                    \
            sizeof(F) <= sizeof(uintptr_t)                                  \
        >::newnew = detail::nil()

C:\dev\mbed-os>doxygen doxyfile-developer
deprecated:11: warning: explicit link request to 'newnew' could not be resolved
deprecated:14: warning: explicit link request to 'newnew' could not be resolved
deprecated:17: warning: explicit link request to 'newnew' could not be resolved
deprecated:53: warning: explicit link request to 'newnew' could not be resolved
deprecated:83: warning: explicit link request to 'newnew' could not be resolved
deprecated:86: warning: explicit link request to 'newnew' could not be resolved
deprecated:89: warning: explicit link request to 'newnew' could not be resolved
deprecated:92: warning: explicit link request to 'newnew' could not be resolved
deprecated:173: warning: explicit link request to 'newnew' could not be resolved
deprecated:176: warning: explicit link request to 'newnew' could not be resolved
deprecated:179: warning: explicit link request to 'newnew' could not be resolved
deprecated:182: warning: explicit link request to 'newnew' could not be resolved
deprecated:227: warning: explicit link request to 'newnew' could not be resolved
deprecated:230: warning: explicit link request to 'newnew' could not be resolved
deprecated:233: warning: explicit link request to 'newnew' could not be resolved
deprecated:251: warning: explicit link request to 'newnew' could not be resolved
deprecated:305: warning: explicit link request to 'newnew' could not be resolved
deprecated:311: warning: explicit link request to 'newnew' could not be resolved
deprecated:314: warning: explicit link request to 'newnew' could not be resolved
deprecated:317: warning: explicit link request to 'newnew' could not be resolved
deprecated:338: warning: explicit link request to 'newnew' could not be resolved
deprecated:362: warning: explicit link request to 'newnew' could not be resolved
deprecated:380: warning: explicit link request to 'newnew' could not be resolved
deprecated:383: warning: explicit link request to 'newnew' could not be resolved

[geky]

Oh! @sg- did we add the macro to the doxygen config as well?

- "PREDEFINED": "DOXYGEN_ONLY \"MBED_DEPRECATED_SINCE(f, g)=\"",
+ "PREDEFINED": "DOXYGEN_ONLY \"MBED_DEPRECATED_SINCE(f, g)=\" \"MBED_ENABLE_IF_CALLBACK_COMPATIBLE(F, M)=\"",

[sg-]

@geky Good catch. OK this looks good now.

C:\dev\mbed-os>doxygen doxyfile-developer

C:\dev\mbed-os>

[adbridge]

This PR relies on changes introduced in #3867 which is targeted for 5.5.0 , thus re-targeting this one also to 5.5.0