summaryrefslogtreecommitdiffstats log msg author committer range
path: root/eng/coding-file-hdr.rst
blob: 7104d062000094deb6245f0e38403e5ce60e2084 (plain) (blame)
 ```1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 ``` ``````.. comment SPDX-License-Identifier: CC-BY-SA-4.0 .. 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:: 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. .. COMMENT: TBD - TBD Add link to license requirements section and show variant licenses. ``````