Commit Graph

15 Commits (beb6d7802a2ba5639f89738354e86b7a54db5104)

Author SHA1 Message Date
Seppo Takalo fbea6f15e2 Add missing Doxygen descriptions for Nanostack
Fix couple of parameter issues as well.
2018-03-21 14:15:28 +02:00
Bartek Szatkowski a7d6c9d1df Fix doxygen for ITM HAL 2018-03-15 10:43:48 +00:00
Vincent Coubard 0363399e56 Doxygen: Update excluded paths and predefined macros.
* Remove BLE feature from the list of excluded folders.
* Define the macro MBED_DEPRECATED.
2017-12-14 16:44:01 +00:00
Martin Kojtal fbd9e7eaf2
Merge pull request #5372 from SenRamakri/sen_PlatformDoxygenUpdates
Doxygen comments fixes
2017-11-09 16:38:45 +00:00
Kevin Gilbert b9d2dbafcf Resolve doxygen warning in filesystems 2017-10-27 18:18:04 -05:00
Senthil Ramakrishnan 3ad298488c Doxygen comment updates and fixes 2017-10-26 15:36:26 -05:00
Russ Butler 1a128154ca Include doxygen from test directories
Turn on doxygen for tests. This allows testing functions to be
referenced, which will be used for various parts of the HAL
specification.
2017-10-02 11:42:00 -05:00
Russ Butler ac22225ad9 Move Cortex specific RTX behind TARGET_CORTEX
Update directory structure to include RTX for only cortex targets, and
for all cortex targets. This patch accomplishes this by moving mbed-os
specific RTX files and RTX itself into rtos/TARGET_CORTEX along with
removing TARGET_CORTEX_M from the RTX5 directory.

The old directory structure:

rtos/rtx5/<mbed-os specific RTX files>
rtos/rtx5/TARGET_CORTEX_M/*
rtos/rtx4/*
rtos/<mbed-os specific RTX files>

Is re-arranged to:

rtos/TARGET_CORTEX/rtx5/*
rtos/TARGET_CORTEX/rtx4/*
rtos/TARGET_CORTEX/<mbed-os specific rtx files>

This both encapsulates RTX code more cleanly and makes it easier to
experiment with non-cortex cmsis-os2 backends, such as a posix
based cmsis-os2 backend.

Note - A potentially better name for the CORTEX_M directory would be
something like FEATURE_RTX5 since this directory only contains RTX5
related files. This cannot be done because there is not an easy way
to turn this feature on, since it cannot be done from mbed_lib.json.
2017-08-31 19:55:54 -05:00
Russ Butler 026df0b7cd Turn on doxygen for DEVICE_* features
Enable doxygen for all device features. Also fix the warnings that
showed up once this was enabled.
2017-08-11 15:47:44 -05:00
Kevin Gilbert af6f342725 Remove RTOS from Doxygen exception list (with the exception of CMSIS/RTX directores) 2017-06-08 15:50:31 -05:00
Kevin Gilbert 1d450f82fb Removed Doxygen errors from Event.h
- Removed Makefile from branch
- Moved a0..a4/c0..c4 parameter documentation from top level overloaded functions to each function to appease Doxygen.
- Removed @see Event::Event from overloaded functions as the link did not work and the argument parameter documentation was moved down to each function
- TODO: Cleanup EventQueue.h
2017-06-07 11:50:33 -05:00
Jimmy Brisson a09db78a4c Enable doxygen for nsapi 2017-06-05 17:32:46 -05:00
Jimmy Brisson e534d3309b Remove more warnings from doxygen config 2017-06-05 17:32:46 -05:00
Jimmy Brisson e4956507b1 Remove warnings from doxyfile_options 2017-06-05 17:32:46 -05:00
Sam Grove 5b57f28071 Update doxyfile_options that has settings used by developer.mbed.org
Should be kept in sync with doxygen_options.json which is used for
building the doxygen which is used by docs.mbed.com It is intended
only generate doxygen for specific directories which present the
public APIs for mbed OS
2017-06-05 17:32:45 -05:00