rtems/rtems-docs
1
0
Fork 0
mirror of https://git.rtems.org/rtems-docs/ synced 2025-06-06 12:29:02 +08:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
Sal 2018-12-04 13:29:43 -06:00 committed by Joel Sherrill
parent f5c20a6ad8
commit b8b4f14973
1 changed files with 25 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

@ -3,41 +3,43 @@
.. COMMENT: COPYRIGHT (c) 2018. .. COMMENT: COPYRIGHT (c) 2018.
.. COMMENT: RTEMS Foundation, The RTEMS Documentation Project .. COMMENT: RTEMS Foundation, The RTEMS Documentation Project
.. COMMENT:TBD - Convert the following to Rest and insert into this file
.. COMMENT:TBD - Convert the following to Rest and insert into this file
.. COMMENT:TBD - https://devel.rtems.org/wiki/Developer/Coding/Boilerplate_File_Header .. COMMENT:TBD - https://devel.rtems.org/wiki/Developer/Coding/Boilerplate_File_Header
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: Every file should include two comment header blocks, one for the Doxygen
output and a copyright notice. This is a typical example:
.. code-block:: c .. code-block:: c
/** /**
* @file * @file
* *
* @ingroup TheGroupForThisFile * @ingroup TheGroupForThisFile
* *
* @brief Short "Table of Contents" Description of File Contents * @brief Short "Table of Contents" Description of File Contents
* *
* A short description of the purpose of this file. * A short description of the purpose of this file.
*/ */
/* /*
* Copyright (c) 20XX Your Name Or Your Company. * Copyright (c) 20XX Your Name Or Your Company.
* *
* The license and distribution terms for this file may be * The license and distribution terms for this file may be
* found in the file LICENSE in this distribution or at * found in the file LICENSE in this distribution or at
* https://www.rtems.org/license/LICENSE. * 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. * 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. * 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. * The copyright owner and specific license terms may vary.
TBD Add link to license requirements section and show variant licenses. .. COMMENT: TBD - TBD Add link to license requirements section and show variant licenses.