mirror of
https://git.rtems.org/rtems-docs/
synced 2025-05-14 21:29:35 +08:00
eng: Clarify "Source Documentation" section
This commit is contained in:
parent
c694df1330
commit
dc345cf7fd
@ -18,17 +18,24 @@ for examples that illustrate style rules and Doxygen usage.
|
||||
Source Documentation
|
||||
--------------------
|
||||
|
||||
* Use Doxygen according to our `Doxygen Recommendations <https://devel.rtems.org/wiki/Developer/Coding/Doxygen>`_..
|
||||
* Start each file with a brief description followed by a license.
|
||||
See `Boilerplate File Header <https://devel.rtems.org/wiki/Developer/Coding/Boilerplate_File_Header>`_..
|
||||
* Use Doxygen according to our :ref:`DoxygenGuidelines`.
|
||||
|
||||
* Use the file templates, see :ref:`FileTemplates`.
|
||||
|
||||
* Use ``/* */`` comments.
|
||||
* Use comments wisely within function bodies, to explain
|
||||
or draw attention without being verbose.
|
||||
* Use English prose and strive for good grammar,
|
||||
spelling, and punctuation.
|
||||
* Use TODO: with a comment to indicate code that needs improvement.
|
||||
Make it clear what there is to do.
|
||||
* Use XXX or FIXME to indicate an error/bug/broken code.
|
||||
|
||||
* Do not use ``//`` comments.
|
||||
|
||||
* Use comments wisely within function bodies, to explain or draw attention
|
||||
without being verbose.
|
||||
|
||||
* Use English prose and strive for good grammar, spelling, and punctuation.
|
||||
|
||||
* Use ``TODO`` with a comment to indicate code that needs improvement. Make
|
||||
it clear what there is to do. Add a ticket and add a link to it.
|
||||
|
||||
* Use ``XXX`` or ``FIXME`` to indicate an error/bug/broken code. Add a ticket
|
||||
and add a link to it.
|
||||
|
||||
Licenses
|
||||
--------
|
||||
|
@ -3,6 +3,8 @@
|
||||
.. Copyright (C) 2018, 2020 embedded brains GmbH (http://www.embedded-brains.de)
|
||||
.. Copyright (C) 2018, 2020 Sebastian Huber
|
||||
|
||||
.. _FileTemplates:
|
||||
|
||||
File Templates
|
||||
==============
|
||||
|
||||
|
Loading…
x
Reference in New Issue
Block a user