mirror of
https://git.rtems.org/rtems-docs/
synced 2025-07-24 01:35:05 +08:00
eng/coding-file-hdr.rst: Fix file formatting (GCI 2018)
This commit is contained in:
parent
f5c20a6ad8
commit
b8b4f14973
@ -3,7 +3,6 @@
|
||||
.. 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
|
||||
|
||||
@ -11,7 +10,8 @@
|
||||
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
|
||||
|
||||
@ -34,10 +34,12 @@ Every file should include two comment header blocks, one for the Doxygen output
|
||||
*/
|
||||
|
||||
|
||||
* 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.
|
||||
|
Loading…
x
Reference in New Issue
Block a user