RTEMS | bsps/powerpc/motorola_powerpc: Add missing Doxygen headers (!900)

Joel Sherrill (@joel) gitlab at rtems.org
Fri Jan 9 15:46:20 UTC 2026



Merge request https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/900 was reviewed by Joel Sherrill

--
  
Joel Sherrill started a new discussion on bsps/powerpc/motorola_powerpc/start/bspstart.c: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/900#note_138255

 > + * @brief This file contains the motorola_powerpc BSP startup and initialization.
 > + */
 >  /*

Missing the blank line between these two blocks.

--
  
Joel Sherrill started a new discussion on bsps/powerpc/motorola_powerpc/start/bspstart.c: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/900#note_138256

 > + */
 >  /*
 >   *  This routine does the bulk of the system initialization.

Make this comment part of the Doxygen block as a follow up paragraph. There should be no technical comments in the copyright/license block. When you spot them, move them into the @file Doxygen block.

--
  
Joel Sherrill started a new discussion on bsps/powerpc/motorola_powerpc/start/residual.c: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/900#note_138257

 > + * @brief This file contains the motorola_powerpc BSP startup and initialization.
 > + */
 >  /*

Missing the blank line between these two blocks.

Also has the same issue with technical comments in the license/copyright block.

--
  
Joel Sherrill started a new discussion on bsps/powerpc/motorola_powerpc/start/motorola.c: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/900#note_138258

 >   *  by rtems to identify motorola boards.
 >   *
 >   *  Copyright (C) 1999 eric.valette at free.fr

Eric Valette has given permission to relicense. Also use name and email address.

--
  
Joel Sherrill started a new discussion on bsps/powerpc/motorola_powerpc/start/motorola.c: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/900#note_138259

 >  #include <libcpu/cpuIdent.h>
 >  
 >  /*

Make this proper Doxygen.

--
  
Joel Sherrill started a new discussion on bsps/powerpc/motorola_powerpc/start/motorola.c: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/900#note_138260

 > + * @brief This file contains the motorola_powerpc BSP startup and initialization.
 > + */
 >  /* motorola.h

Missing the blank line between these two blocks.

Also has the same issue where it has technical commentary in the copyright/license block that should be to the @file Doxygen block.


-- 
View it on GitLab: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/900
You're receiving this email because of your account on gitlab.rtems.org.


-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.rtems.org/pipermail/bugs/attachments/20260109/8d44fe5a/attachment-0001.htm>


More information about the bugs mailing list