summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/rtems/support.h
diff options
context:
space:
mode:
Diffstat (limited to 'cpukit/include/rtems/rtems/support.h')
-rw-r--r--cpukit/include/rtems/rtems/support.h22
1 files changed, 12 insertions, 10 deletions
diff --git a/cpukit/include/rtems/rtems/support.h b/cpukit/include/rtems/rtems/support.h
index 829548aae2..bb2e6e3633 100644
--- a/cpukit/include/rtems/rtems/support.h
+++ b/cpukit/include/rtems/rtems/support.h
@@ -3,11 +3,13 @@
/**
* @file
*
+ * @ingroup RTEMSImplClassic
+ *
* @brief This header file defines support services of the API.
*/
/*
- * Copyright (C) 2020, 2021 embedded brains GmbH (http://www.embedded-brains.de)
+ * Copyright (C) 2020, 2021 embedded brains GmbH & Co. KG
* Copyright (C) 1988, 2008 On-Line Applications Research Corporation (OAR)
*
* Redistribution and use in source and binary forms, with or without
@@ -113,8 +115,8 @@ static inline bool rtems_is_name_valid( rtems_name name )
* value.
*
* @par Notes
- * The number of clock ticks per second is defined by the
- * #CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
+ * The number of clock ticks per second is defined by the @ref
+ * CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
*
* @par Constraints
* @parblock
@@ -164,8 +166,8 @@ static inline bool rtems_is_name_valid( rtems_name name )
* @return Returns the number of clock ticks for the milliseconds value.
*
* @par Notes
- * The number of clock ticks per second is defined by the
- * #CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
+ * The number of clock ticks per second is defined by the @ref
+ * CONFIGURE_MICROSECONDS_PER_TICK application configuration option.
*
* @par Constraints
* @parblock
@@ -228,9 +230,9 @@ static inline void rtems_name_to_characters(
*
* @param bytes is the number of bytes to allocated.
*
- * @param[out] pointer is the pointer to a pointer variable. When the
+ * @param[out] pointer is the pointer to a ``void`` pointer object. When the
* directive call is successful, the begin address of the allocated memory
- * area will be stored in this variable.
+ * area will be stored in this object.
*
* @return Returns true, if the allocation was successful, otherwise false.
*
@@ -286,9 +288,9 @@ bool rtems_workspace_free( void *pointer );
*
* @brief Gets information about the RTEMS Workspace.
*
- * @param the_info is the pointer to a heap information variable. When the
- * directive call is successful, the heap information will be stored in this
- * variable.
+ * @param[out] the_info is the pointer to a Heap_Information_block object.
+ * When the directive call is successful, the heap information will be stored
+ * in this object.
*
* @return Returns true, if getting the information was successful, otherwise
* false.