Re-structure CC2538 doxygen module hierarchy

This commit is contained in:
George Oikonomou 2015-02-14 02:13:21 +01:00
parent 8751e55c94
commit 72914369e8
7 changed files with 25 additions and 17 deletions

View file

@ -29,12 +29,21 @@
* OF THE POSSIBILITY OF SUCH DAMAGE. * OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/** /**
* \addtogroup cc2538 * \addtogroup platform
* @{
*
* \defgroup cc2538-platforms TI cc2538-powered platforms
*
* Documentation for all platforms powered by the TI cc2538 System-on-Chip
* @{
*
* \defgroup cc2538 The TI cc2538 System-on-Chip
* CPU-Specific functionality - available to all cc2538-based platforms
* @{ * @{
* *
* \defgroup cc2538-cpu cc2538 CPU * \defgroup cc2538-cpu cc2538 CPU
* *
* cc2538 CPU-specific functions for the cc2538 core * CPU-specific functions for the cc2538 core
* @{ * @{
* *
* \file * \file
@ -60,6 +69,8 @@ unsigned long cpu_cpsie(void);
#endif /* CPU_H_ */ #endif /* CPU_H_ */
/** /**
* @}
* @}
* @} * @}
* @} * @}
*/ */

View file

@ -27,16 +27,13 @@
* SUCH DAMAGE. * SUCH DAMAGE.
*/ */
/** /**
* \addtogroup cc2538 * \addtogroup cc2538-spi
* @{ * @{
* *
* Implementation of the low-level SPI primitives such as waiting for the TX
* FIFO to be ready, inserting into the TX FIFO, etc.
* @{
*/
/**
* \file * \file
* Header file for the cc2538 SPI commands * Header file for the cc2538 SPI driver, including macros for the
* implementation of the low-level SPI primitives such as waiting for the TX
* FIFO to be ready, inserting into the TX FIFO, etc.
*/ */
#ifndef SPI_ARCH_H_ #ifndef SPI_ARCH_H_
#define SPI_ARCH_H_ #define SPI_ARCH_H_
@ -121,6 +118,5 @@ void spi_set_mode(uint32_t frame_format, uint32_t clock_polarity,
#endif /* SPI_ARCH_H_ */ #endif /* SPI_ARCH_H_ */
/** /**
* @}
* @} * @}
*/ */

View file

@ -29,10 +29,10 @@
* OF THE POSSIBILITY OF SUCH DAMAGE. * OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/** /**
* \addtogroup cc2538 * \addtogroup cc2538-platforms
* @{ * @{
* *
* \defgroup cc2538-examples cc2538dk Example Projects * \defgroup cc2538-examples cc2538 Example Projects
* @{ * @{
* *
* \defgroup cc2538-demo cc2538dk Demo Project * \defgroup cc2538-demo cc2538dk Demo Project

View file

@ -1,5 +1,5 @@
/** /**
* \addtogroup cc2538 * \addtogroup cc2538dk
* @{ * @{
* *
* \file * \file

View file

@ -29,10 +29,10 @@
* OF THE POSSIBILITY OF SUCH DAMAGE. * OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/** /**
* \addtogroup platform * \addtogroup cc2538-platforms
* @{ * @{
* *
* \defgroup cc2538 The cc2538 Development Kit platform * \defgroup cc2538dk The cc2538 Development Kit platform
* *
* The cc2538DK is the new platform by Texas Instruments, based on the * The cc2538DK is the new platform by Texas Instruments, based on the
* cc2530 SoC with an ARM Cortex-M3 core. * cc2530 SoC with an ARM Cortex-M3 core.

View file

@ -28,7 +28,8 @@
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED
* OF THE POSSIBILITY OF SUCH DAMAGE. * OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/** \addtogroup cc2538 /**
* \addtogroup cc2538dk
* @{ * @{
* *
* \defgroup cc2538-smartrf SmartRF06EB Peripherals * \defgroup cc2538-smartrf SmartRF06EB Peripherals

View file

@ -30,7 +30,7 @@
* OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
*/ */
/** /**
* \addtogroup cc2538 * \addtogroup cc2538dk
* @{ * @{
* *
* \file * \file