[rtems commit] cpukit: Use Consistent Beginning of Doxygen Group Notation

[Joel Sherrill]

On 01/11/2013 07:49 AM, Sebastian Huber wrote:
> On 01/11/2013 12:02 AM, Joel Sherrill wrote:
>> diff --git a/cpukit/include/rtems/irq-extension.h b/cpukit/include/rtems/irq-extension.h
>> index 644091b..ff2c6da 100644
>> --- a/cpukit/include/rtems/irq-extension.h
>> +++ b/cpukit/include/rtems/irq-extension.h
>> @@ -38,9 +38,8 @@ extern "C" {
>>     * In addition to the Classic API interrupt handler with a handle are
>>     * supported.  You can also install multiple shared handler for one interrupt
>>     * vector.
>> - *
>> - * @{
>>     */
>> +/**@{**/
>>
>>    /**
>>     * @brief Makes the interrupt handler unique.  Prevents other handler from
> I think this change should be reversed.  A single @{ without a preceding
> @defgroup or @addtogroup makes no sense.  Thus is should be also part of the
> corresponding comment block.
>
>
The inclusion of the opening was inconsistent across the files.
I saw three patterns and wasn't sure there were not more:

/**@{*/

  * TEXT
  *
  * @{
  */


  * TEXT
  * @{
  */

I thought it got lost in the comment block and that the single
line by itself stood out more. Plus it matches the ending block
marker. Plus it is what is documented in the Doxygen manual

http://www.star.bnl.gov/public/comp/sofi/doxygen/grouping.html

FWIW the extern C, ending block and inclusion prevention
stuff at the bottom of the files is also very inconsistent
in precise formatting.

-- 
Joel Sherrill, Ph.D.             Director of Research&  Development
joel.sherrill at OARcorp.com        On-Line Applications Research
Ask me about RTEMS: a free RTOS  Huntsville AL 35806
Support Available               (256) 722-9985

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/devel/attachments/20130111/d5d8b4a5/attachment-0001.html>