summaryrefslogtreecommitdiffstats
path: root/eng
diff options
context:
space:
mode:
authorSal <mcomajoancara@gmail.com>2018-12-04 13:29:43 -0600
committerJoel Sherrill <joel@rtems.org>2018-12-17 18:45:50 -0600
commitb8b4f1497343649b529fb4d75cefa61f43153253 (patch)
treed3cb7629cfd23455821dabe1bbc9dbba1a0920f1 /eng
parentf5c20a6ad86cd32dc82c47edb9b1d42240bb9e7d (diff)
downloadrtems-docs-b8b4f1497343649b529fb4d75cefa61f43153253.tar.bz2
eng/coding-file-hdr.rst: Fix file formatting (GCI 2018)
Diffstat (limited to 'eng')
-rw-r--r--eng/coding-file-hdr.rst48
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.