Changes between Version 26 and Version 27 of Developer/Coding/Conventions


Ignore:
Timestamp:
May 29, 2014, 11:57:56 PM (5 years ago)
Author:
Gedare
Comment:

/* File Issues */ Relocate to new page "Boilerplate File Header"

Legend:

Unmodified
Added
Removed
Modified
  • Developer/Coding/Conventions

    v26 v27  
    99 *  Use /* */ comments.
    1010 *  Start each file with a brief description followed by a license. See [wiki:Developer/Coding/Boilerplate_File_Header Boilerplate File Header].
    11 = File Issues =
    12 
    13 
    14  *  Every file should include two comment header blocks, one for the Doxygen output and a copyright notice.  This is a typical example:
    15 {{{
    16 /**
    17  * @file
    18  *
    19  * @ingroup TheGroupForThisFile
    20  *
    21  * @brief Short "Table of Contents" Description of File Contents
    22  *
    23  * A short description of the purpose of this file.
    24  */
    25 
    26 /*
    27  * COPYRIGHT (c) 1989-2012.
    28  * On-Line Applications Research Corporation (OAR).
    29  *
    30  * The license and distribution terms for this file may be
    31  * found in the file LICENSE in this distribution or at
    32  * http://www.rtems.com/license/LICENSE.
    33  */
    34 }}}
    35 
    36  *  Use exactly one blank line between the Doxygen header and copyright notice. Leave the first line of the copyright notice blank.
    37  *  Separate the Doxygen header and copyright notice so the copyright notice is not included in the Doxygen output.
    38  *  The copyright owner and specific license terms may vary.
    3911= Licenses =
    4012