[rtems commit] basedefs: Clarify RTEMS_STRING(), RTEMS_XSTRING()

[Sebastian Huber]

Module:    rtems
Branch:    master
Commit:    14bb077059fb64c88553a6f1958a21f375fe83b4
Changeset: http://git.rtems.org/rtems/commit/?id=14bb077059fb64c88553a6f1958a21f375fe83b4

Author:    Frank Kühndel <frank.kuehndel at embedded-brains.de>
Date:      Tue Mar  9 13:01:11 2021 +0100

basedefs: Clarify RTEMS_STRING(), RTEMS_XSTRING()

---

 cpukit/include/rtems/score/basedefs.h | 6 ++++--
 1 file changed, 4 insertions(+), 2 deletions(-)

diff --git a/cpukit/include/rtems/score/basedefs.h b/cpukit/include/rtems/score/basedefs.h
index c423c53..71dc182 100644
--- a/cpukit/include/rtems/score/basedefs.h
+++ b/cpukit/include/rtems/score/basedefs.h
@@ -362,7 +362,8 @@ extern "C" {
  *
  * @param ... are the arguments to stringify.
  *
- * @return Returns the stringification of the arguments.
+ * @return Returns the stringification of the arguments.  In case of several
+ *   arguments a single string is returned not several.
  */
 #define RTEMS_STRING( ... ) #__VA_ARGS__
 
@@ -936,7 +937,8 @@ extern "C" {
  *
  * @param ... are the arguments to expand and stringify.
  *
- * @return Returns the stringification of the expansion of the arguments.
+ * @return Returns the stringification of the expansion of the arguments.  In
+ *   case of several arguments a single string is returned not several.
  */
 #define RTEMS_XSTRING( ... ) RTEMS_STRING( __VA_ARGS__ )