summaryrefslogtreecommitdiffstats
path: root/cpukit/include/rtems/io.h
diff options
context:
space:
mode:
authorSebastian Huber <sebastian.huber@embedded-brains.de>2021-06-14 09:57:51 +0200
committerSebastian Huber <sebastian.huber@embedded-brains.de>2021-06-15 10:39:47 +0200
commit6abdd89f191a5e6d64055093f68a4fce10554f82 (patch)
treec8861a2f162c906862fde844c8b56487f259b6f1 /cpukit/include/rtems/io.h
parentfad01e6cf95f98adaca3157faa8b96c19296a68e (diff)
downloadrtems-6abdd89f191a5e6d64055093f68a4fce10554f82.tar.bz2
Use a common phrase for pointer parameters
Mention the type of the pointer in the parameter description. Use the more general term "object" instead of "variable". Update #3993.
Diffstat (limited to '')
-rw-r--r--cpukit/include/rtems/io.h7
1 files changed, 4 insertions, 3 deletions
diff --git a/cpukit/include/rtems/io.h b/cpukit/include/rtems/io.h
index d8ce527b0e..181da9fe4f 100644
--- a/cpukit/include/rtems/io.h
+++ b/cpukit/include/rtems/io.h
@@ -194,9 +194,10 @@ typedef struct {
*
* @param driver_table is the device driver address table.
*
- * @param[out] registered_major is the pointer to a device major number
- * variable. When the directive call is successful, the device major number
- * of the registered device will be stored in this variable.
+ * @param[out] registered_major is the pointer to an
+ * ::rtems_device_major_number object. When the directive call is
+ * successful, the device major number of the registered device will be
+ * stored in this object.
*
* @retval ::RTEMS_SUCCESSFUL The requested operation was successful.
*