powerpc/mvme3100: Improve Doxygen

This commit is contained in:
Szkocsovszki Zsolt
2014-01-03 13:35:39 +01:00
committed by Joel Sherrill
parent d48ac18144
commit a77c3719f8
6 changed files with 83 additions and 9 deletions

View File

@@ -0,0 +1,15 @@
/**
* @defgroup bsp_powerpc POWERPC
*
* @ingroup bsp_kit
*
* @brief POWERPC Board Support Packages
*/
/**
* @defgroup powerpc_mvme3100 POWERPC MVME3100 Modules
*
* @ingroup bsp_powerpc
*
* @brief POWERPC MVME3100 Modules
*/

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup powerpc_mpc8540i2cbusdrv
*
* @brief I2C bus driver for mpc8540-based boards
*/
#ifndef MPC8540_I2C_BUS_DRIVER_H
#define MPC8540_I2C_BUS_DRIVER_H

View File

@@ -1,5 +1,12 @@
/**
* @file
*
* @ingroup mvme3100_bsp
*
* @brief This file contains BSP API definition.
*/
/*
* bsp.h -- contain BSP API definition.
*
* Copyright (C) 1999 Eric Valette. valette@crf.canon.fr
*
@@ -21,8 +28,12 @@
#include <rtems/clockdrv.h>
#include <bsp/vectors.h>
/*
* confdefs.h overrides for this BSP:
/**
* @defgroup mvme3100_bsp confdefs.h overrides
*
* @ingroup powerpc_mvme3100
*
* @brief confdefs.h overrides for this BSP:
*/
#define BSP_INTERRUPT_STACK_SIZE (16 * 1024)

View File

@@ -1,3 +1,12 @@
/**
* @file
*
* @ingroup powerpc_irq
*
* @brief This include file describe the data structure and the functions
* implemented by RTEMS to write interrupt handlers.
*/
/* irq.h
*
* This include file describe the data structure and the functions implemented
@@ -30,8 +39,12 @@
extern "C" {
#endif
/*
* rtems_irq_number Definitions
/**
* @defgroup powerpc_irq Definitions
*
* @ingroup powerpc_mvme3100
*
* @brief rtems_irq_number Definitions
*/
/* Must pad number of external sources to 16 because

View File

@@ -1,3 +1,11 @@
/**
* @file
*
* @ingroup powerpc_iftsecpub
*
* @brief IF_TSEC_PUB Support
*/
#ifndef IF_TSEC_PUBLIC_INTERFACE_H
#define IF_TSEC_PUBLIC_INTERFACE_H
@@ -60,8 +68,12 @@ struct tsec_private;
/********** Low-level Driver API ****************/
/*
* This API provides driver access to applications that
/**
* @defgroup powerpc_iftsecpub Low-level Driver API
*
* @ingroup powerpc_mvme3100
*
* @brief This API provides driver access to applications that
* want to use e.g., the second ethernet interface
* independently from the BSD TCP/IP stack. E.g., for
* raw ethernet packet communication...

View File

@@ -1,8 +1,14 @@
/**
* @file
*
* @ingroup powerpc_vmeconfig
*
* @brief mvme3100 BSP specific address space configuration parameters
*/
#ifndef RTEMS_BSP_VME_CONFIG_H
#define RTEMS_BSP_VME_CONFIG_H
/* mvme3100 BSP specific address space configuration parameters */
/*
* Authorship
* ----------
@@ -97,6 +103,15 @@
* universe. The default setup tries to use interrupt
* sharing.
*/
/**
* @defgroup powerpc_vme BSP_VME_INSTALL_IRQ_MGR Support
*
* @ingroup powerpc_mvme3100
*
* @brief BSP_VME_INSTALL_IRQ_MGR Support Package
*/
#define BSP_VME_INSTALL_IRQ_MGR(err) \
do { \
err = vmeTsi148InstallIrqMgrAlt(\