diff options
| author | Joel Sherrill <joel@rtems.org> | 2018-12-02 11:29:33 -0600 |
|---|---|---|
| committer | Joel Sherrill <joel@rtems.org> | 2018-12-17 18:45:49 -0600 |
| commit | 9c755172c22c2fe318f285b8b5041c2f8fb4b4d7 (patch) | |
| tree | 4df9e998672ffebfcfbc1f45738f06f6e43c8869 /eng/coding-file-hdr.rst | |
| parent | coding-file-hdr: Convert TBD to Rest Format (GCI 2018) (diff) | |
| download | rtems-docs-9c755172c22c2fe318f285b8b5041c2f8fb4b4d7.tar.bz2 | |
coding-doxygen-bsp.rst, coding-file-hdr.rst: Fix formatting
Diffstat (limited to '')
| -rw-r--r-- | eng/coding-file-hdr.rst | 55 |
1 files changed, 29 insertions, 26 deletions
diff --git a/eng/coding-file-hdr.rst b/eng/coding-file-hdr.rst index 23e5db0..1ff16b8 100644 --- a/eng/coding-file-hdr.rst +++ b/eng/coding-file-hdr.rst @@ -9,32 +9,35 @@ 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. + .. code-block:: c + + /** + * @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. + +TBD Add link to license requirements section and show variant licenses. |