rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-07-03 03:08:27 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Pritish Jain 2018-12-02 01:46:35 +05:30 committed by Joel Sherrill
parent 0184167233
commit e55248d229
1 changed files with 34 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

38
eng/coding-file-hdr.rst
View File

@ -3,8 +3,38 @@
.. COMMENT: COPYRIGHT (c) 2018.
.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project
Boilerplate File Header
***********************
TBD - Convert the following to Rest and insert into this file
TBD - https://devel.rtems.org/wiki/Developer/Coding/Boilerplate_File_Header
.. COMMENT:TBD - Convert the following to Rest and insert into this file
.. COMMENT:TBD - https://devel.rtems.org/wiki/Developer/Coding/Boilerplate_File_Header
Boilerplate File Header
==========================================
Every file should include two comment header blocks, one for the Doxygen output and a copyright notice. This is a typical example:
.. code block:: shell
/**
* @file
*
* @ingroup TheGroupForThisFile
*
* @brief Short "Table of Contents" Description of File Contents
*
* A short description of the purpose of this file.
*/
/*
* Copyright (c) 20XX Your Name Or Your Company.
*
* The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at
* https://www.rtems.org/license/LICENSE.
*/
* Use exactly one blank line between the Doxygen header and copyright notice. Leave the first line of the copyright notice blank.
* Separate the Doxygen header and copyright notice so the copyright notice is not included in the Doxygen output.
* The copyright owner and specific license terms may vary.