diff options
author | Sal <mcomajoancara@gmail.com> | 2018-12-04 13:29:43 -0600 |
---|---|---|
committer | Joel Sherrill <joel@rtems.org> | 2018-12-09 17:06:07 -0600 |
commit | b43d51279b1050d10b082e4cd6c3a19e80d7a58a (patch) | |
tree | 81bef1d52bfa571aa76aea6d1cc4230e799984fe | |
parent | 909054efc52304a585508e7afb41fe61b14359d6 (diff) |
eng/coding-file-hdr.rst: Fix file formatting (GCI 2018)
-rw-r--r-- | eng/coding-file-hdr.rst | 48 |
1 files changed, 25 insertions, 23 deletions
diff --git a/eng/coding-file-hdr.rst b/eng/coding-file-hdr.rst index 1ff16b8..7104d06 100644 --- a/eng/coding-file-hdr.rst +++ b/eng/coding-file-hdr.rst @@ -3,41 +3,43 @@ .. COMMENT: COPYRIGHT (c) 2018. .. 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 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 - * - * @ingroup TheGroupForThisFile - * - * @brief Short "Table of Contents" Description of File Contents - * - * A short description of the purpose of this file. - */ + /** + * @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. - */ + /* + * 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. +* 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. -TBD Add link to license requirements section and show variant licenses. +.. COMMENT: TBD - TBD Add link to license requirements section and show variant licenses. |