Upstream PR #11073 review request changes #11135
Conversation
…mpliant documentation
|
@hugueskamba, thank you for your changes. |
* Remove `#warning` directive * Add deprecation warning for all class methods * Replace Doxygen `@warning` with `@deprecated`
| @@ -28,11 +28,9 @@ | |||
| #include <cstdio> | |||
|
|
|||
| namespace mbed { | |||
| /** \ingroup mbed-os-public */ | |||
There was a problem hiding this comment.
It is still in the Public API. See line 33. If you are able to, have a look at the generated Doxygen output.
There was a problem hiding this comment.
yeah but why change of groups? We used to have the
Public -> [Drivers, RTOS, ...]
Private -> [...]
is this change affecting the group tree?
There was a problem hiding this comment.
The generated Doxygen ouptut has not changed. This change simply makes the Doxygen comment of this file in line with other files under drivers.
drivers-public-api is defined as being in Public API->Drivers on the Doxygen output.
| @@ -23,8 +23,7 @@ | |||
|
|
|||
| #include "events/mbed_shared_queues.h" | |||
|
|
|||
| /** \ingroup mbed-os-internal */ | |||
| /** \addtogroup events-internal-api */ | |||
| /** \addtogroup events-public-api */ | |||
There was a problem hiding this comment.
The file is not in mbed-os/events/internal but mbed-os/events/ that's where the events Public headers are located.
* Modify Doxygen grouping of `drivers` Public/Internal APIs * Correct classification of `mbed_events.h` * Amend name of Doxygen group containing Device Key API * Classify `CallChain.h` as public API and relocate file * Remove Doxygen group from `equeue_platform.h` as it has no Doxygen compliant documentation * Move USB target specific code back to `usb/device/targets`
* Modify Doxygen grouping of `drivers` Public/Internal APIs * Correct classification of `mbed_events.h` * Amend name of Doxygen group containing Device Key API * Classify `CallChain.h` as public API and relocate file * Remove Doxygen group from `equeue_platform.h` as it has no Doxygen compliant documentation * Move USB target specific code back to `usb/device/targets`
Description
Addressing comments from: #11073 (review)
Pull request type
Reviewers
@evedon
Release Notes
Greetea test result for USB using the command:
mbed test -t arm -m k64f -n tests-usb_device-*is
mbedgt: test case results: 1 FAIL / 30 SKIPPED / 3 OK / 2 ERRORThe same result is obtained with the master branch