Changeset 212663be in rtems


Ignore:
Timestamp:
Feb 26, 2019, 2:44:50 PM (8 weeks ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
master
Children:
631ccd7
Parents:
a6e39d4a
git-author:
Sebastian Huber <sebastian.huber@…> (02/26/19 14:44:50)
git-committer:
Sebastian Huber <sebastian.huber@…> (03/04/19 06:51:38)
Message:

bsps: Adjust architecture Doxygen groups

  • Use CamelCase as it is not used in our C code. Enables simple search and replace.
  • Prefix with "RTEMS" to aid deployment and integration. It aids searching and sorting.

Update #3706.

Location:
bsps
Files:
10 added
2 deleted
46 edited

Legend:

Unmodified
Added
Removed
  • bsps/arm/beagle/include/bsp.h

    ra6e39d4a r212663be  
    351351 * @defgroup arm_beagle Beaglebone, Beagleboard Support
    352352 *
    353  * @ingroup bsp_arm
     353 * @ingroup RTEMSBSPsARM
    354354 *
    355355 * @brief Beaglebones and beagleboards support package
  • bsps/arm/csb336/include/bsp.h

    ra6e39d4a r212663be  
    3333 * @defgroup arm_csb336 CSB336 Support
    3434 *
    35  * @ingroup bsp_arm
     35 * @ingroup RTEMSBSPsARM
    3636 *
    3737 * @brief CSB336 support package.
  • bsps/arm/csb337/include/bsp.h

    ra6e39d4a r212663be  
    3232 * @defgroup arm_csb337 CSB337 Support
    3333 *
    34  * @ingroup bsp_arm
     34 * @ingroup RTEMSBSPsARM
    3535 *
    3636 * @brief CSB337 support package.
  • bsps/arm/csb337/umon/doxygen.h

    ra6e39d4a r212663be  
    22 *  @defgroup shared_umon SHARED UMON Modules
    33 *
    4  *  @ingroup bsp_shared
    5  *
    64 *  @brief SHARED UMON Modules
    75 */
  • bsps/arm/edb7312/include/bsp.h

    ra6e39d4a r212663be  
    3232/**
    3333 * @defgroup arm_edb7312 EDB7312 Support
    34  * @ingroup bsp_arm
     34 * @ingroup RTEMSBSPsARM
    3535 * @brief EDB7312 Support Package
    3636 * @{
  • bsps/arm/gdbarmsim/include/bsp.h

    ra6e39d4a r212663be  
    3333 * @defgroup arm_gdbarmsim GDBARMSIM Support
    3434 *
    35  * @ingroup bsp_arm
     35 * @ingroup RTEMSBSPsARM
    3636 *
    3737 * @brief GDBARMSIM support package.
  • bsps/arm/gumstix/include/bsp.h

    ra6e39d4a r212663be  
    2727/**
    2828 * @defgroup arm_gumstix Gumstix Support
    29  * @ingroup bsp_arm
     29 * @ingroup RTEMSBSPsARM
    3030 * @brief Gumstix support package
    3131 * @{
  • bsps/arm/lm3s69xx/include/bsp.h

    ra6e39d4a r212663be  
    4747 * @defgroup arm_lm3s69xx LM3S69XX Support
    4848 *
    49  * @ingroup bsp_arm
     49 * @ingroup RTEMSBSPsARM
    5050 *
    5151 * @brief LM3S69XX Support Package
  • bsps/arm/lpc176x/include/bsp.h

    ra6e39d4a r212663be  
    4848 * @defgroup lpc176x LPC176X Support
    4949 *
    50  * @ingroup bsp_arm
     50 * @ingroup RTEMSBSPsARM
    5151 *
    5252 * @brief LPC176X support package.
  • bsps/arm/lpc24xx/include/bsp.h

    ra6e39d4a r212663be  
    5757 * @defgroup lpc24xx LPC24XX Support
    5858 *
    59  * @ingroup bsp_arm
     59 * @ingroup RTEMSBSPsARM
    6060 *
    6161 * @brief LPC24XX support package.
  • bsps/arm/lpc32xx/include/bsp.h

    ra6e39d4a r212663be  
    4444 * @defgroup arm_lpc32xx LPC32XX Support
    4545 *
    46  * @ingroup bsp_arm
     46 * @ingroup RTEMSBSPsARM
    4747 *
    4848 * @brief LPC32XX support package.
  • bsps/arm/raspberrypi/include/bsp.h

    ra6e39d4a r212663be  
    6363 * @defgroup arm_raspberrypi Raspberry Pi Support
    6464 *
    65  * @ingroup bsp_arm
     65 * @ingroup RTEMSBSPsARM
    6666 *
    6767 * @brief Raspberry Pi support package
  • bsps/arm/realview-pbx-a9/include/bsp.h

    ra6e39d4a r212663be  
    6161 * @defgroup arm_realview-pbx-a9 Realview PBX-A9
    6262 *
    63  * @ingroup bsp_arm
     63 * @ingroup RTEMSBSPsARM
    6464 *
    6565 * @brief Realview PBX-A9 support package
  • bsps/arm/rtl22xx/include/bsp.h

    ra6e39d4a r212663be  
    2222/**
    2323 * @defgroup arm_rtl22xx RTL22XX Support
    24  * @ingroup bsp_arm
     24 * @ingroup RTEMSBSPsARM
    2525 * @brief RTL22XX Support Package
    2626 * @{
  • bsps/arm/shared/doxygen.h

    ra6e39d4a r212663be  
    1   /**
    2   *  @defgroup bsp_arm ARM
    3   *
    4   *  @ingroup bsp_kit
    5   *
    6   *  @brief ARM Board Support Packages
    7   */
     1/**
     2 * @defgroup RTEMSBSPsARM ARM
     3 *
     4 * @ingroup RTEMSBSPs
     5 *
     6 * @brief ARM Board Support Packages.
     7 */
    88
    99 /**
    1010  *  @defgroup arm_shared ARM Shared Modules
    1111  *
    12   *  @ingroup bsp_arm
     12  *  @ingroup RTEMSBSPsARM
    1313  *
    1414  *  @brief ARM Shared Modules
  • bsps/arm/stm32f4/include/bsp.h

    ra6e39d4a r212663be  
    2121/**
    2222 * @defgroup arm_stm32f4 STM32F4 Support
    23  * @ingroup bsp_arm
     23 * @ingroup RTEMSBSPsARM
    2424 * @brief STM32f4 Support Package
    2525 * @{
  • bsps/arm/xilinx-zynq/include/bsp.h

    ra6e39d4a r212663be  
    3939/**
    4040 * @defgroup arm_zynq Xilinx-Zynq Support
    41  * @ingroup bsp_arm
     41 * @ingroup RTEMSBSPsARM
    4242 * @brief Xilinz-Zynq Board Support Package
    4343 * @{
  • bsps/bfin/TLL6527M/include/bsp.h

    ra6e39d4a r212663be  
    3434/**
    3535 * @defgroup bfin_tll6527m TLL6527M Support
    36  * @ingroup bsp_bfin
     36 * @ingroup RTEMSBSPsBfin
    3737 * @brief TLL6527M Support Package
    3838 * @{
  • bsps/bfin/eZKit533/include/bsp.h

    ra6e39d4a r212663be  
    3939/**
    4040 * @defgroup bfin_ezkit533 eZKit533 Support
    41  * @ingroup bsp_bfin
     41 * @ingroup RTEMSBSPsBfin
    4242 * @brief eZKit533 Board Support Package
    4343 * @{
  • bsps/bfin/shared/doxygen.h

    ra6e39d4a r212663be  
    1  /**
    2   *  @defgroup bsp_bfin Blackfin
    3   *  @ingroup bsp_kit
    4   *  @brief Blackfin Board Support Packages
    5   */
    6 
    7  /**
    8   *  @defgroup bfin_shared Blackfin Shared Modules
    9   *  @ingroup bsp_bfin
    10   *  @brief Blackfin Shared Modules
    11   */
     1/**
     2 * @defgroup RTEMSBSPsBfin Blackfin
     3 *
     4 * @ingroup RTEMSBSPs
     5 *
     6 * @brief Blackfin Board Support Packages.
     7 */
  • bsps/i386/pc386/include/bsp.h

    ra6e39d4a r212663be  
    6363
    6464/**
    65  * @degroup pc386_i386 PC386 Support
    66  *
    67  * @ingroup bsp_i386
     65 * @degroup i386_pc386 PC386 Support
     66 *
     67 * @ingroup RTEMSBSPsI386
    6868 *
    6969 * @brief PC386 support.
  • bsps/i386/shared/doxygen.h

    ra6e39d4a r212663be  
    11/**
    2  *  @defgroup bsp_i386 i386
    3  *  @ingroup bsp_kit
    4  *  @brief i386 Board Support Packages
     2 * @defgroup RTEMSBSPsI386 i386
     3 *
     4 * @ingroup RTEMSBSPs
     5 *
     6 * @brief i386 Board Support Packages.
    57 */
    68
  • bsps/include/bsp/bootcard.h

    ra6e39d4a r212663be  
    22 * @file
    33 *
    4  * @ingroup bsp_bootcard
    5  *
    6  * @brief Standard system startup.
     4 * @ingroup RTEMSBSPsSharedStartup
    75 */
    86
     
    3836
    3937/**
    40  * @defgroup shared_bootcard Bootcard
     38 * @defgroup RTEMSBSPsSharedStartup Bootcard
    4139 *
    42  * @ingroup bsp_shared
     40 * @ingroup RTEMSBSPsShared
    4341 *
    4442 * @brief Standard system startup.
  • bsps/include/bsp/irq-generic.h

    ra6e39d4a r212663be  
    111111 * @defgroup bsp_interrupt BSP Interrupt Support
    112112 *
    113  * @ingroup bsp_shared
     113 * @ingroup RTEMSBSPsShared
    114114 *
    115115 * @brief Generic BSP Interrupt Support
  • bsps/include/bsp/stackalloc.h

    ra6e39d4a r212663be  
    3434 * @defgroup bsp_stack Task Stack Allocator
    3535 *
    36  * @ingroup bsp_shared
     36 * @ingroup RTEMSBSPsShared
    3737 *
    3838 * @brief Task stack initialization, allocation and free functions.
  • bsps/lm32/lm32_evr/include/bsp.h

    ra6e39d4a r212663be  
    3131 * @defgroup lm32_evr EVR Support
    3232 *
    33  * @ingroup bsp_lm32
     33 * @ingroup RTEMSBSPsLM32
    3434 *
    3535 * @brief EVR support package.
  • bsps/lm32/milkymist/include/bsp.h

    ra6e39d4a r212663be  
    3030 * @defgroup lm32_milkymist Milkymist Support
    3131 *
    32  * @ingroup bsp_lm32
     32 * @ingroup RTEMSBSPsLM32
    3333 *
    3434 * @brief Milkymist support package.
  • bsps/lm32/shared/doxygen.h

    ra6e39d4a r212663be  
    1   /**
    2   *  @defgroup bsp_lm32 Lattice Mico32
    3   *
    4   *  @ingroup bsp_kit
    5   *
    6   *  @brief Lattice Mico32 Board Support Packages
    7   */
     1/**
     2 * @defgroup RTEMSBSPsLM32 LatticeMicro32 (lm32)
     3 *
     4 * @ingroup RTEMSBSPs
     5 *
     6 * @brief LatticeMicro32 Board Support Packages.
     7 */
    88
    99 /**
    1010  *  @defgroup lm32_shared Lattice Mico32 Shared Modules
    1111  *
    12   *  @ingroup bsp_lm32
     12  *  @ingroup RTEMSBSPsLM32
    1313  *
    1414  *  @brief Lattice Mico32 Shared Modules
  • bsps/m68k/av5282/include/bsp.h

    ra6e39d4a r212663be  
    1414 * @defgroup m68k_av5282 AV5282 Support
    1515 *
    16  * @ingroup bsp_m68k
     16 * @ingroup RTEMSBSPsM68k
    1717 *
    1818 * @brief AV5282 support.
  • bsps/m68k/csb360/include/bsp.h

    ra6e39d4a r212663be  
    3232 * @defgroup m68k_csb360 CSB360 Support
    3333 *
    34  * @ingroup bsp_m68k
     34 * @ingroup RTEMSBSPsM68k
    3535 *
    3636 * @brief CSB360 support.
  • bsps/m68k/gen68340/include/bsp.h

    ra6e39d4a r212663be  
    4141 * @defgroup m68k_gen68340 Motorola MC68340 Support
    4242 *
    43  * @ingroup bsp_m68k
     43 * @ingroup RTEMSBSPsM68k
    4444 *
    4545 * @brief Motorola MC68340 support.
  • bsps/m68k/genmcf548x/include/bsp.h

    ra6e39d4a r212663be  
    6161 * @defgroup m68k_genmcf548x MCF548X Support
    6262 *
    63  * @ingroup bsp_m68k
     63 * @ingroup RTEMSBSPsM68k
    6464 *
    6565 * @brief MCT548X support.
  • bsps/m68k/mcf52235/include/bsp.h

    ra6e39d4a r212663be  
    8282 * @defgroup m68k_mcf52235 MCF52235 Support
    8383 *
    84  * @ingroup bsp_m68k
     84 * @ingroup RTEMSBSPsM68k
    8585 *
    8686 * @brief MCF52235 Support Package
  • bsps/m68k/shared/doxygen.h

    ra6e39d4a r212663be  
    11/**
    2   *  @defgroup bsp_m68k M68K
    3   *
    4   *  @ingroup bsp_kit
    5   *
    6   *  @brief M68K Board Support Packages
    7   */
     2 * @defgroup RTEMSBSPsM68k Motorola 68000 and NXP ColdFire (m68k)
     3 *
     4 * @ingroup RTEMSBSPs
     5 *
     6 * @brief Motorola 68000 and NXP ColdFire Board Support Packagess.
     7 */
    88
    99/**
    1010  *  @defgroup m68k_shared M68K Shared Modules
    1111  *
    12   *  @ingroup bsp_m68k
     12  *  @ingroup RTEMSBSPsM68k
    1313  *
    1414  *  @brief M68K Shared Modules
  • bsps/mips/shared/doxygen.h

    ra6e39d4a r212663be  
    1   /**
    2   *  @defgroup bsp_mips MIPS
    3   *  @ingroup bsp_kit
    4   *  @brief MIPS Board Support Packages
    5   */
     1/**
     2 * @defgroup RTEMSBSPsMIPS MIPS
     3 *
     4 * @ingroup RTEMSBSPs
     5 *
     6 * @brief MIPS Board Support Packages.
     7 */
    68
    79 /**
    810  *  @defgroup mips_shared MIPS Shared Modules
    9   *  @ingroup bsp_mips
     11  *  @ingroup RTEMSBSPsMIPS
    1012  *  @brief mips Shared Modules
    1113  */
  • bsps/powerpc/include/bsp/vmeUniverse.h

    ra6e39d4a r212663be  
    5757/**
    5858 *  @defgroup shared_vmeuniverse Register definitions
    59  *
    60  *  @ingroup bsp_shared
    6159 *
    6260 *  @brief all registers contents in PCI space are LITTLE ENDIAN
  • bsps/powerpc/shared/doxygen.h

    ra6e39d4a r212663be  
    1   /**
    2   *  @defgroup bsp_powerpc PowerPC
    3   *
    4   *  @ingroup bsp_kit
    5   *
    6   *  @brief PowerPC Board Support Packages
    7   */
     1/**
     2 * @defgroup RTEMSBSPsPowerPc PowerPC
     3 *
     4 * @ingroup RTEMSBSPs
     5 *
     6 * @brief PowerPC Board Support Packages.
     7 */
    88
    99 /**
  • bsps/powerpc/shared/vme/doxygen.h

    ra6e39d4a r212663be  
    22 *  @defgroup shared_vmeuniverse SHARED VMEUNIVERSE Modules
    33 *
    4  *  @ingroup bsp_shared
    5  *
    64 *  @brief SHARED VMEUNIVERSE Modules
    75 */
  • bsps/shared/dev/clock/clockimpl.h

    ra6e39d4a r212663be  
    3333 * @defgroup bsp_clock Clock Support
    3434 *
    35  * @ingroup bsp_shared
     35 * @ingroup RTEMSBSPsShared
    3636 *
    3737 * @brief Clock support
  • bsps/shared/doxygen.h

    ra6e39d4a r212663be  
    11/**
    2  *  @defgroup bsp_shared SHARED
     2 * @defgroup RTEMSBSPs Board Support Packages
    33 *
    4  *  @ingroup bsp_kit
    5  *
    6  *  @brief SHARED Board Support Packages
     4 * @brief Board Support Packages and Support Modules
     5 * (BSPs).
    76 */
    87
    98/**
    10  *  @defgroup shared_tod SHARED TOD Modules
     9 * @defgroup RTEMSBSPsShared Shared
    1110 *
    12  *  @ingroup bsp_shared
     11 * @ingroup RTEMSBSPs
    1312 *
    14  *  @brief SHARED TOD Modules
     13 * @brief Shared Support for Board Support Packages
    1514 */
  • bsps/shared/start/bootcard.c

    ra6e39d4a r212663be  
    22 * @file
    33 *
    4  * @ingroup bsp_bootcard
    5  *
    6  * @brief Standard system startup.
    7  *
    8  *  This is the C entry point for ALL RTEMS BSPs.  It is invoked
    9  *  from the assembly language initialization file usually called
    10  *  start.S.  It provides the framework for the BSP initialization
    11  *  sequence.  For the basic flow of initialization see RTEMS C User's Guide,
    12  *  Initialization Manager.
    13  *
    14  *  This style of initialization ensures that the C++ global
    15  *  constructors are executed after RTEMS is initialized.
    16  *  Thanks to Chris Johns <cjohns@plessey.com.au> for the idea
    17  *  to move C++ global constructors into the first task.
     4 * @ingroup RTEMSBSPsSharedStartup
    185 */
    196
  • bsps/shared/start/stackalloc.c

    ra6e39d4a r212663be  
    22 * @file
    33 *
    4  * @ingroup bsp_shared
     4 * @ingroup bsp_stack
    55 *
    66 * @brief Stack initialization, allocation and free functions.
  • bsps/sparc/erc32/include/bsp.h

    ra6e39d4a r212663be  
    4040 * @defgroup sparc_erc32 ERC32 Support
    4141 *
    42  * @ingroup bsp_sparc
     42 * @ingroup RTEMSBSPsSPARC
    4343 *
    4444 * @brief ERC32 Support Package
  • bsps/sparc/leon2/include/bsp.h

    ra6e39d4a r212663be  
    4343 *  @defgroup sparc_leon2 LEON2 Support
    4444 *
    45  *  @ingroup bsp_sparc
     45 *  @ingroup RTEMSBSPsSPARC
    4646 *
    4747 *  @brief LEON2 Support Package
  • bsps/sparc/leon3/include/bsp.h

    ra6e39d4a r212663be  
    4343 *  @defgroup sparc_leon3 LEON3 Support
    4444 *
    45  *  @ingroup bsp_sparc
     45 *  @ingroup RTEMSBSPsSPARC
    4646 *
    4747 *  @brief LEON3 support package
  • bsps/sparc/shared/doxygen.h

    ra6e39d4a r212663be  
    1  /**
    2   *  @defgroup bsp_sparc SPARC
    3   *
    4   *  @ingroup bsp_kit
    5   *
    6   *  @brief SPARC Board Support Packages
    7   */
     1/**
     2 * @defgroup RTEMSBSPsSPARC SPARC
     3 *
     4 * @ingroup RTEMSBSPs
     5 *
     6 * @brief SPARC Board Support Packages.
     7 */
    88
    99 /**
    1010  *  @defgroup sparc_shared SPARC Shared Modules
    1111  *
    12   *  @ingroup bsp_sparc
     12  *  @ingroup RTEMSBSPsSPARC
    1313  *
    1414  *  @brief SPARC Shared Modules
Note: See TracChangeset for help on using the changeset viewer.