[RTEMS Project] #4811: Non-compliant Comments with Templates

[RTEMS trac]

#4811: Non-compliant Comments with Templates
----------------------------+--------------------
  Reporter:  Daniel Páscoa  |      Owner:  (none)
      Type:  defect         |     Status:  new
  Priority:  normal         |  Milestone:
 Component:  admin          |    Version:
  Severity:  normal         |   Keywords:
Blocked By:                 |   Blocking:
----------------------------+--------------------
 **Description:**
 It has been identified that the comments are not compliant with the
 established template. Additionally, there is missing @param information
 for non-const pointer parameters. To ensure adherence to the guidelines
 outlined in section 6.3.4.5 of the RTEMS Software Engineering, it is
 recommended to utilize the provided template for commenting.

 The attached excel lists in a systematic way the sources where this issue
 applies.

 **Additional Notes:**
 This ticket was raised as an outcome of the Independent SW Verification
 and Validation (ISVV) for ESA-promoted RTEMS SMP Qualification Data Packs
 (https://rtems-qual.io.esa.int). Original ISVV reference for this issue is
 RTEMS-SMP-CODE-VER-022.

 **File list (please check the attached excel for more information):**
 bsps\include\bsp\bootcard.h
 bsps\include\bsp\default-initial-extension.h
 bsps\include\bsp\fatal.h
 bsps\sparc\shared\irq\bsp_isr_handler.c
 bsps\shared\cache\cacheimpl.h
 bsps\shared\dev\clock\clockimpl.h
 bsps\sparc\leon3\include\tm27.h
 bsps\shared\start\bootcard.c
 cpukit\include\machine\_kernel_time.h
 cpukit\libc\search\qsort.c
 cpukit\libc\string\memcmp.c

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