Changeset e55248d in rtems-docs


Ignore:
Timestamp:
Dec 1, 2018, 8:16:35 PM (5 months ago)
Author:
Pritish Jain <pritishjain2001@…>
Branches:
master
Children:
9c75517
Parents:
0184167
git-author:
Pritish Jain <pritishjain2001@…> (12/01/18 20:16:35)
git-committer:
Joel Sherrill <joel@…> (12/18/18 00:45:49)
Message:

coding-file-hdr: Convert TBD to Rest Format (GCI 2018)

File:
1 edited

Legend:

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

    r0184167 re55248d  
    44.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project
    55
     6
     7.. COMMENT:TBD  - Convert the following to Rest and insert into this file
     8.. COMMENT:TBD - https://devel.rtems.org/wiki/Developer/Coding/Boilerplate_File_Header
     9
     10
    611Boilerplate File Header
    7 ***********************
     12==========================================
    813
    9 TBD  - Convert the following to Rest and insert into this file
    10 TBD - https://devel.rtems.org/wiki/Developer/Coding/Boilerplate_File_Header
     14
     15Every file should include two comment header blocks, one for the Doxygen output and a copyright notice.  This is a typical example:
     16
     17.. code block:: shell
     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 */
     27
     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 */
     35
     36
     37
     38 *  Use exactly one blank line between the Doxygen header and copyright notice. Leave the first line of the copyright notice blank.
     39 *  Separate the Doxygen header and copyright notice so the copyright notice is not included in the Doxygen output.
     40 *  The copyright owner and specific license terms may vary.
Note: See TracChangeset for help on using the changeset viewer.