[RTEMS Project] #4163: Error in documentation regarding C/C++ large comment styles

[RTEMS trac]

#4163: Error in documentation regarding C/C++ large comment styles
---------------------------------+--------------------
  Reporter:  Andrew Butterfield  |      Owner:  (none)
      Type:  defect              |     Status:  new
  Priority:  normal              |  Milestone:
 Component:  doc                 |    Version:  5
  Severity:  normal              |   Keywords:
Blocked By:                      |   Blocking:
---------------------------------+--------------------
 In the RTEMS Software Engineering manual, Sec 6.3.2.1

 https://docs.rtems.org/branches/master/eng/coding-80cols.html#breaking-
 long-lines

 it recommends excessively long comments be broken as follows:

 {{{
 /* first line
  * second line
  * third, and in this case last line */
 }}}

 After a discussion on the devel mailing list at

 https://lists.rtems.org/pipermail/devel/2020-October/062906.html

 it was agreed that it should be

 {{{
 /*
  * first line
  * second line
  * third line (no longer matters that it is last)
  */
 }}}

--
Ticket URL: <http://devel.rtems.org/ticket/4163>
RTEMS Project <http://www.rtems.org/>
RTEMS Project