diff options
Diffstat (limited to 'cpukit/include/rtems/rtems/part.h')
-rw-r--r-- | cpukit/include/rtems/rtems/part.h | 28 |
1 files changed, 14 insertions, 14 deletions
diff --git a/cpukit/include/rtems/rtems/part.h b/cpukit/include/rtems/rtems/part.h index 7a829d96af..8c7b0b5ef3 100644 --- a/cpukit/include/rtems/rtems/part.h +++ b/cpukit/include/rtems/rtems/part.h @@ -9,7 +9,7 @@ */ /* - * 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 @@ -112,9 +112,9 @@ extern "C" { * * @param attribute_set is the attribute set of the partition. * - * @param[out] id is the pointer to an object identifier variable. When the - * directive call is successful, the identifier of the created partition will - * be stored in this variable. + * @param[out] id is the pointer to an ::rtems_id object. When the directive + * call is successful, the identifier of the created partition will be stored + * in this object. * * This directive creates a partition of fixed size buffers from a physically * contiguous memory space which starts at ``starting_address`` and is @@ -168,13 +168,13 @@ extern "C" { * * @retval ::RTEMS_TOO_MANY There was no inactive object available to create a * partition. The number of partitions available to the application is - * configured through the #CONFIGURE_MAXIMUM_PARTITIONS application + * configured through the @ref CONFIGURE_MAXIMUM_PARTITIONS application * configuration option. * * @retval ::RTEMS_TOO_MANY In multiprocessing configurations, there was no * inactive global object available to create a global semaphore. The number * of global objects available to the application is configured through the - * #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration option. + * @ref CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration option. * * @par Notes * @parblock @@ -220,7 +220,7 @@ extern "C" { * message to remote nodes. This may preempt the calling task. * * * The number of partitions available to the application is configured - * through the #CONFIGURE_MAXIMUM_PARTITIONS application configuration + * through the @ref CONFIGURE_MAXIMUM_PARTITIONS application configuration * option. * * * Where the object class corresponding to the directive is configured to use @@ -228,8 +228,8 @@ extern "C" { * Workspace. * * * The number of global objects available to the application is configured - * through the #CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application configuration - * option. + * through the @ref CONFIGURE_MP_MAXIMUM_GLOBAL_OBJECTS application + * configuration option. * @endparblock */ rtems_status_code rtems_partition_create( @@ -252,9 +252,9 @@ rtems_status_code rtems_partition_create( * * @param node is the node or node set to search for a matching object. * - * @param[out] id is the pointer to an object identifier variable. When the - * directive call is successful, the object identifier of an object with the - * specified name will be stored in this variable. + * @param[out] id is the pointer to an ::rtems_id object. When the directive + * call is successful, the object identifier of an object with the specified + * name will be stored in this object. * * This directive obtains a partition identifier associated with the partition * name specified in ``name``. @@ -388,9 +388,9 @@ rtems_status_code rtems_partition_delete( rtems_id id ); * * @param id is the partition identifier. * - * @param[out] buffer is the pointer to a buffer pointer variable. When the + * @param[out] buffer is the pointer to a ``void`` pointer object. When the * directive call is successful, the pointer to the allocated buffer will be - * stored in this variable. + * stored in this object. * * This directive allows a buffer to be obtained from the partition specified * by ``id``. The address of the allocated buffer is returned through the |