Joel Sherrill commented on a discussion on testsuites/libtests/stackchk03/system.h: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/86#note_110204 > +/* SPDX-License-Identifier: BSD-2-Clause */ > + > +/* system.h Very close. The text for an @brief should be thought of as an entry in a table of contents not a full sentence. Usually when someone does this, it is easy to use the sentence that was the original @brief into the paragraph following the @brief. From... @brief This is a very long sentence which says this file is for raising the Titanic To... @brief Titanic Raiser Class Interface This very long sentence describes what the file contains and often isn't really saying much beyond the @brief above. "This file defines the class interface for the Raising the Titanic class." If it isn't adding anything, do not add the longer version. -- View it on GitLab: https://gitlab.rtems.org/rtems/rtos/rtems/-/merge_requests/86#note_110204 You're receiving this email because of your account on gitlab.rtems.org.
_______________________________________________ bugs mailing list [email protected] http://lists.rtems.org/mailman/listinfo/bugs
