RTEMS | confdefs: Fix extensions.h (!187)

[Sebastian Huber (@sebhub)]

Sebastian Huber commented on a discussion on cpukit/include/rtems/confdefs/extensions.h: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/187#note_111177

 >  /* SPDX-License-Identifier: BSD-2-Clause */
 >  
 >  /**
 > - * @brief User Extensions Configuration Options Evaluator
 > + * @file
 > + *
 > + * @ingroup RTEMSImplApplConfig
 > + *
 > + * @brief This header file evaluates configuration options related to the user

The `@brief` comments should be proper sentences and not just head lines. In particular for `@file` blocks, see also the Doxygen guidelines:

https://docs.rtems.org/branches/master/eng/coding-doxygen.html#files

I spent a considerable amount of time to add these `@file` comments to quite a lot of files and it would be really nice if my work doesn't get reverted.

-- 
View it on GitLab: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/187#note_111177
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/20240817/d13b127a/attachment-0001.htm>