Changeset b8b4f14 in rtems-docs


Ignore:
Timestamp:
Dec 4, 2018, 7:29:43 PM (6 months ago)
Author:
Sal <mcomajoancara@…>
Branches:
master
Children:
cc826d7
Parents:
f5c20a6
git-author:
Sal <mcomajoancara@…> (12/04/18 19:29:43)
git-committer:
Joel Sherrill <joel@…> (12/18/18 00:45:50)
Message:

eng/coding-file-hdr.rst: Fix file formatting (GCI 2018)

File:
1 edited

Legend:

Unmodified
Added
Removed
  • eng/coding-file-hdr.rst

    rf5c20a6 rb8b4f14  
    44.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project
    55
    6 
    7 .. COMMENT:TBD  - Convert the following to Rest and insert into this file
     6.. COMMENT:TBD - Convert the following to Rest and insert into this file
    87.. COMMENT:TBD - https://devel.rtems.org/wiki/Developer/Coding/Boilerplate_File_Header
    98
     
    1211=======================
    1312
    14 Every file should include two comment header blocks, one for the Doxygen output and a copyright notice.  This is a typical example:
     13Every file should include two comment header blocks, one for the Doxygen
     14output and a copyright notice.  This is a typical example:
    1515
    16     .. code-block:: c
     16.. code-block:: c
    1717
    18         /**
    19          * @file
    20          *
    21          * @ingroup TheGroupForThisFile
    22          *
    23          * @brief Short "Table of Contents" Description of File Contents
    24          *
    25          * A short description of the purpose of this file.
    26          */
     18  /**
     19   * @file
     20   *
     21   * @ingroup TheGroupForThisFile
     22   *
     23   * @brief Short "Table of Contents" Description of File Contents
     24   *
     25   * A short description of the purpose of this file.
     26   */
    2727
    28         /*
    29          * Copyright (c) 20XX Your Name Or Your Company.
    30          *
    31          * The license and distribution terms for this file may be
    32          * found in the file LICENSE in this distribution or at
    33          * https://www.rtems.org/license/LICENSE.
    34          */
     28  /*
     29   * Copyright (c) 20XX Your Name Or Your Company.
     30   *
     31   * The license and distribution terms for this file may be
     32   * found in the file LICENSE in this distribution or at
     33   * https://www.rtems.org/license/LICENSE.
     34   */
    3535
    3636
    37 * Use exactly one blank line between the Doxygen header and copyright notice. Leave the first line of the copyright notice blank.
     37* Use exactly one blank line between the Doxygen header and copyright notice.
     38  Leave the first line of the copyright notice blank.
    3839
    39 * Separate the Doxygen header and copyright notice so the copyright notice is not included in the Doxygen output.
     40* Separate the Doxygen header and copyright notice so the copyright notice is
     41  not included in the Doxygen output.
    4042
    4143* The copyright owner and specific license terms may vary.
    4244
    43 TBD Add link to license requirements section and show variant licenses.
     45.. COMMENT: TBD - TBD Add link to license requirements section and show variant licenses.
Note: See TracChangeset for help on using the changeset viewer.