[rtems-docs commit] coding-file-hdr: Convert TBD to Rest Format (GCI 2018)

[Joel Sherrill]

Module:    rtems-docs
Branch:    master
Commit:    e55248d229f1325d54a90fa2f64554d82dc2ce30
Changeset: http://git.rtems.org/rtems-docs/commit/?id=e55248d229f1325d54a90fa2f64554d82dc2ce30

Author:    Pritish Jain <pritishjain2001 at gmail.com>
Date:      Sun Dec  2 02:04:35 2018 +0530

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

---

 eng/coding-file-hdr.rst | 36 +++++++++++++++++++++++++++++++++---
 1 file changed, 33 insertions(+), 3 deletions(-)

diff --git a/eng/coding-file-hdr.rst b/eng/coding-file-hdr.rst
index 67c177f..23e5db0 100644
--- a/eng/coding-file-hdr.rst
+++ b/eng/coding-file-hdr.rst
@@ -3,8 +3,38 @@
 .. 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 - 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.
+ */
+
+
 
-TBD  - Convert the following to Rest and insert into this file
-TBD - https://devel.rtems.org/wiki/Developer/Coding/Boilerplate_File_Header
+ *  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.