Changeset c389f5b7 in rtems


Ignore:
Timestamp:
Apr 10, 2019, 8:29:08 AM (6 months ago)
Author:
Andreas Dachsberger <andreas.dachsberger@…>
Branches:
master
Children:
316894e6
Parents:
ae8be3f
git-author:
Andreas Dachsberger <andreas.dachsberger@…> (04/10/19 08:29:08)
git-committer:
Sebastian Huber <sebastian.huber@…> (05/13/19 05:42:03)
Message:

doxygen: score: adjust doc in objectimpl.h to doxygen guidelines

Update #3706.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/include/rtems/score/objectimpl.h

    rae8be3f rc389f5b7  
    11/**
    22 * @file
     3 *
     4 * @ingroup RTEMSScoreObject
    35 *
    46 * @brief Inlined Routines in the Object Handler
     
    9496
    9597/**
    96  *  This function extends an object class information record.
    97  *
    98  *  @param[in] information points to an object class information block.
     98 * @brief Extends an object class information record.
     99 *
     100 * @param information Points to an object class information block.
    99101 */
    100102void _Objects_Extend_information(
     
    103105
    104106/**
    105  *  @brief Shrink an object class information record
    106  *
    107  *  This function shrink an object class information record.
    108  *  The object's name and object space are released. The local_table
    109  *  etc block does not shrink. The InActive list needs to be scanned
    110  *  to find the objects are remove them.
    111  *
    112  *  @param[in] information points to an object class information block.
     107 * @brief Shrinks an object class information record.
     108 *
     109 * This function shrinks an object class information record.
     110 * The object's name and object space are released. The local_table
     111 * etc block does not shrink. The InActive list needs to be scanned
     112 * to find the objects are remove them.
     113 *
     114 * @param information Points to an object class information block.
    113115 */
    114116void _Objects_Shrink_information(
     
    121123 * The objects information must be statically pre-initialized with the
    122124 * OBJECTS_INFORMATION_DEFINE() macro before this function is called.
     125 *
     126 * @param information The object information to be initialized.
    123127 */
    124128void _Objects_Initialize_information( Objects_Information *information );
    125129
    126130/**
    127  *  @brief Object API Maximum Class
    128  *
    129  *  This function returns the highest numeric value of a valid
    130  *  API for the specified @a api.
    131  *
    132  *  @param[in] api is the API of interest
    133  *
    134  *  @retval A positive integer on success and 0 otherwise.
     131 * @brief Returns highest numeric value of a valid API for the specified API.
     132 *
     133 * This function returns the highest numeric value of a valid
     134 * API for the specified @a api.
     135 *
     136 * @param api The API of interest.
     137 *
     138 * @retval some_value Positive integer on success.
     139 * @retval 0 The method failed.
    135140 */
    136141unsigned int _Objects_API_maximum_class(
     
    146151 *   initialization.
    147152 *
    148  * @param[in] information The object information block.
    149  *
     153 * @param[in, out] information The object information block.
     154 *
     155 * @retval object The allocated object.
    150156 * @retval NULL No object available.
    151  * @retval object The allocated object.
    152157 *
    153158 * @see _Objects_Allocate() and _Objects_Free().
     
    189194 * @endcode
    190195 *
    191  * @param[in] information The object information block.
    192  *
     196 * @param[in, out] information The object information block.
     197 *
     198 * @retval object The allocated object.
    193199 * @retval NULL No object available.
    194  * @retval object The allocated object.
    195200 *
    196201 * @see _Objects_Free().
     
    203208 * Appends the object to the chain of inactive objects.
    204209 *
    205  * @param[in] information The object information block.
    206  * @param[in] the_object The object to free.
     210 * @param information The object information block.
     211 * @param[out] the_object The object to free.
    207212 *
    208213 * @see _Objects_Allocate().
     
    278283
    279284/**
    280  *  @brief Converts an object name to an Id.
    281  *
    282  *  This method converts an object name to an Id.  It performs a look up
    283  *  using the object information block for this object class.
    284  *
    285  *  @param[in] information points to an object class information block.
    286  *  @param[in] name is the name of the object to find.
    287  *  @param[in] node is the set of nodes to search.
    288  *  @param[in] id will contain the Id if the search is successful.
    289  *
    290  *  @retval This method returns one of the values from the
    291  *          @ref Objects_Name_or_id_lookup_errors enumeration to indicate
    292  *          successful or failure.  On success @a id will contain the Id of
    293  *          the requested object.
     285 * @brief Converts an object name to an Id.
     286 *
     287 * This method converts an object name to an Id.  It performs a look up
     288 * using the object information block for this object class.
     289 *
     290 * @param information points to an object class information block.
     291 * @param name is the name of the object to find.
     292 * @param node is the set of nodes to search.
     293 * @param[out] id will contain the Id if the search is successful.
     294 *
     295 * @retval OBJECTS_NAME_OR_ID_LOOKUP_SUCCESSFUL The operations was successful
     296 *      @a id contains the ID.
     297 * @retval OBJECTS_INVALID_NAME The name was invalid.
     298 * @retval OBJECTS_INVALID_ID The id is not 0 before the operation.
    294299 */
    295300Objects_Name_or_id_lookup_errors _Objects_Name_to_id_u32(
     
    313318 * @param information The object information.  Must not be NULL.
    314319 * @param name The object name.
    315  * @param name_length_p Optional parameter to return the name length.
    316  * @param error The error indication in case of failure.  Must not be NULL.
    317  *
     320 * @param[out] name_length_p Optional parameter to return the name length.
     321 * @param[out] error The error indication in case of failure.  Must not be NULL.
     322 *
     323 * @retval pointer The first object according to object index associated with
     324 *      this name.
    318325 * @retval NULL No object exists for this name or invalid parameters.
    319  * @retval other The first object according to object index associated with
    320  * this name.
    321326 */
    322327Objects_Control *_Objects_Get_by_name(
     
    328333
    329334/**
    330  *  @brief Implements the common portion of the object Id to name directives.
    331  *
    332  *  This function implements the common portion of the object Id
    333  *  to name directives.  This function returns the name
    334  *  associated with object id.
    335  *
    336  *  @param[in] id is the Id of the object whose name we are locating.
    337  *  @param[in] name will contain the name of the object, if found.
    338  *
    339  *  @retval This method returns one of the values from the
    340  *          @ref Objects_Name_or_id_lookup_errors enumeration to indicate
    341  *          successful or failure.  On success @a name will contain the name of
    342  *          the requested object.
    343  *
    344  *  @note This function currently does not support string names.
     335 * @brief Returns the name associated with object id.
     336 *
     337 * This function implements the common portion of the object Id
     338 * to name directives.  This function returns the name
     339 * associated with object id.
     340 *
     341 * @param id is the Id of the object whose name we are locating.
     342 * @param[out] name will contain the name of the object, if found.
     343 *
     344 * @retval OBJECTS_NAME_OR_ID_LOOKUP_SUCCESSFUL The operation succeeded.  @a name
     345 *      contains the name of the object.
     346 * @retval OBJECTS_INVALID_ID The id is invalid, the operation failed.
     347 *
     348 * @note This function currently does not support string names.
    345349 */
    346350Objects_Name_or_id_lookup_errors _Objects_Id_to_name (
     
    358362 *
    359363 * @param id The object identifier.  This is the first parameter since usual
    360  *   callers get the object identifier as the first parameter themself.
     364 *      callers get the object identifier as the first parameter themself.
    361365 * @param lock_context The interrupt lock context.  This is the second
    362  *   parameter since usual callers get the interrupt lock context as the second
    363  *   parameter themself.
     366 *      parameter since usual callers get the interrupt lock context as the second
     367 *      parameter themself.
    364368 * @param information The object class information block.
    365369 *
     370 * @retval pointer The pointer to the associated object control block.
     371 *      Interrupts are now disabled and must be restored using the specified lock
     372 *      context via _ISR_lock_ISR_enable() or _ISR_lock_Release_and_ISR_enable().
    366373 * @retval NULL No associated object exists.
    367  * @retval other The pointer to the associated object control block.
    368  * Interrupts are now disabled and must be restored using the specified lock
    369  * context via _ISR_lock_ISR_enable() or _ISR_lock_Release_and_ISR_enable().
    370374 */
    371375Objects_Control *_Objects_Get(
     
    376380
    377381/**
    378  *  @brief  Maps object ids to object control blocks.
    379  *
    380  *  This function maps object ids to object control blocks.
    381  *  If id corresponds to a local object, then it returns
    382  *  the_object control pointer which maps to id and location
    383  *  is set to OBJECTS_LOCAL.  If the object class supports global
    384  *  objects and the object id is global and resides on a remote
    385  *  node, then location is set to OBJECTS_REMOTE, and the_object
    386  *  is undefined.  Otherwise, location is set to OBJECTS_ERROR
    387  *  and the_object is undefined.
    388  *
    389  *  @param[in] id is the Id of the object whose name we are locating.
    390  *    This is the first parameter since usual callers get the object identifier
    391  *    as the first parameter themself.
    392  *  @param[in] information points to an object class information block.
    393  *
    394  *  @retval This method returns one of the values from the
    395  *          @ref Objects_Name_or_id_lookup_errors enumeration to indicate
    396  *          successful or failure.  On success @a id will contain the Id of
    397  *          the requested object.
     382 * @brief  Maps object ids to object control blocks.
     383 *
     384 * This function maps object ids to object control blocks.
     385 * If id corresponds to a local object, then it returns
     386 * the_object control pointer which maps to id and location
     387 * is set to OBJECTS_LOCAL.  If the object class supports global
     388 * objects and the object id is global and resides on a remote
     389 * node, then location is set to OBJECTS_REMOTE, and the_object
     390 * is undefined.  Otherwise, location is set to OBJECTS_ERROR
     391 * and the_object is undefined.
     392 *
     393 * @param id The Id of the object whose name we are locating.
     394 *   This is the first parameter since usual callers get the object identifier
     395 *   as the first parameter themself.
     396 * @param information Points to an object class information block.
     397 *
     398 * @retval pointer The local object corresponding to the given id.
     399 * @retval NULL The object to the given id was not found locally.
    398400 */
    399401Objects_Control *_Objects_Get_no_protection(
     
    403405
    404406/**
    405  * Gets the next open object after the specified object identifier.
    406  *
    407  *  Locks the object allocator mutex in case a next object exists.
    408  *
    409  *  @param[in] id is the Id of the object whose name we are locating.
    410  *    This is the first parameter since usual callers get the object identifier
    411  *    as the first parameter themself.
    412  *  @param[in] information points to an object class information block.
    413  *  @param[in] next_id_p is the Id of the next object we will look at.
    414  *
    415  *  @retval This method returns the pointer to the object located or
    416  *          NULL on error.
     407 * @brief Gets the next open object after the specified object identifier.
     408 *
     409 * Locks the object allocator mutex in case a next object exists.
     410 *
     411 * @param id The Id of the object whose name we are locating.
     412 *   This is the first parameter since usual callers get the object identifier
     413 *   as the first parameter themself.
     414 * @param information Points to an object class information block.
     415 * @param[in, out] next_id_p The Id of the next object we will look at.
     416 *
     417 * @retval pointer Pointer to the located object.
     418 * @retval NULL An error occured.
    417419 */
    418420Objects_Control *_Objects_Get_next(
     
    423425
    424426/**
    425  *  @brief Get object information.
    426  *
    427  *  This function return the information structure given
    428  *  an the API and Class.  This can be done independent of
    429  *  the existence of any objects created by the API.
    430  *
    431  *  @param[in] the_api indicates the API for the information we want
    432  *  @param[in] the_class indicates the Class for the information we want
    433  *
    434  *  @retval This method returns a pointer to the Object Information Table
    435  *          for the class of objects which corresponds to this object ID.
     427 * @brief Gets object information.
     428 *
     429 * This function returns the information structure given
     430 * an API and Class.  This can be done independent of the
     431 * existence of any objects created by the API.
     432 *
     433 * @param the_api Indicates the API for the information we want
     434 * @param the_class Indicates the Class for the information we want
     435 *
     436 * @retval pointer Pointer to the Object Information Table
     437 *         for the class of objects which corresponds to this object ID.
     438 * @retval NULL An error occured.
    436439 */
    437440Objects_Information *_Objects_Get_information(
     
    441444
    442445/**
    443  *  @brief Get information of an object from an ID.
    444  *
    445  *  This function return the information structure given
    446  *  an @a id of an object.
    447  *
    448  *  @param[in] id is the object ID to get the information from
    449  *
    450  *  @retval This method returns a pointer to the Object Information Table
    451  *          for the class of objects which corresponds to this object ID.
     446 * @brief Gets information of an object from an ID.
     447 *
     448 * This function returns the information structure given
     449 * an @a id of an object.
     450 *
     451 * @param id The object ID to get the information from.
     452 *
     453 * @retval pointer Pointer to the Object Information Table
     454 *         for the class of objects which corresponds to this object ID.
     455 * @retval NULL An error occured.
    452456 */
    453457Objects_Information *_Objects_Get_information_id(
     
    456460
    457461/**
    458  *  @brief Gets object name in the form of a C string.
    459  *
    460  *  This method objects the name of an object and returns its name
    461  *  in the form of a C string.  It attempts to be careful about
    462  *  overflowing the user's string and about returning unprintable characters.
    463  *
    464  *  @param[in] id is the object to obtain the name of
    465  *  @param[in] length indicates the length of the caller's buffer
    466  *  @param[in] name points a string which will be filled in.
    467  *
    468  *  @retval This method returns @a name or NULL on error. @a *name will
    469  *          contain the name if successful.
     462 * @brief Gets object name in the form of a C string.
     463 *
     464 * This method gets the name of an object and returns its name
     465 * in the form of a C string.  It attempts to be careful about
     466 * overflowing the user's string and about returning unprintable characters.
     467 *
     468 * @param id The object to obtain the name of.
     469 * @param length Indicates the length of the caller's buffer.
     470 * @param[out] name A string which will be filled in.
     471 *
     472 * @retval @a name The operation was succeeded and the string was correctly filled in.
     473 * @retval NULL An error occured.
    470474 */
    471475char *_Objects_Get_name_as_string(
     
    480484 * Non-printable characters according to isprint() are converted to '*'.
    481485 *
    482  * @param[in] name The object name.
    483  * @param[in] is_string Indicates if the object name is a string or a four
     486 * @param name The object name.
     487 * @param is_string Indicates if the object name is a string or a four
    484488 *   character array (32-bit unsigned integer).
    485  * @param[in] buffer The string buffer for the text representation.
    486  * @param[in] buffer_size The buffer size in characters.
    487  *
    488  * @retval The length of the text representation.  May be greater than or equal
     489 * @param[out] buffer The string buffer for the text representation.
     490 * @param buffer_size The buffer size in characters.
     491 *
     492 * @return The length of the text representation.  May be greater than or equal
    489493 * to the buffer size if truncation occurred.
    490494 */
     
    497501
    498502/**
    499  *  @brief Set objects name.
    500  *
    501  *  This method sets the object name to either a copy of a string
    502  *  or up to the first four characters of the string based upon
    503  *  whether this object class uses strings for names.
    504  *
    505  *  @param[in] information points to the object information structure
    506  *  @param[in] the_object is the object to operate upon
    507  *  @param[in] name is a pointer to the name to use
    508  *
    509  *  @retval If successful, true is returned.  Otherwise false is returned.
     503 * @brief Sets objects name.
     504 *
     505 * This method sets the object name to either a copy of a string
     506 * or up to the first four characters of the string based upon
     507 * whether this object class uses strings for names.
     508 *
     509 * @param information points to the object information structure
     510 * @param[out] the_object is the object to operate upon
     511 * @param name is a pointer to the name to use
     512 *
     513 * @retval true The operation succeeded.
     514 * @retval false The operation failed.
    510515 */
    511516bool _Objects_Set_name(
     
    518523 * @brief Removes object with a 32-bit integer name from its namespace.
    519524 *
    520  * @param[in] information The corresponding object information table.
    521  * @param[in] the_object The object.
     525 * @param information The corresponding object information table.
     526 * @param[out] the_object The object to operate upon.
    522527 */
    523528void _Objects_Namespace_remove_u32(
     
    529534 * @brief Removes object with a string name from its namespace.
    530535 *
    531  * @param[in] information The corresponding object information table.
    532  * @param[in] the_object The object.
     536 * @param information The corresponding object information table.
     537 * @param[out] the_object The object the object to operate upon.
    533538 */
    534539void _Objects_Namespace_remove_string(
     
    538543
    539544/**
    540  *  @brief Close object.
    541  *
    542  *  This function removes the_object control pointer and object name
    543  *  in the Local Pointer and Local Name Tables.
    544  *
    545  *  @param[in] information points to an Object Information Table
    546  *  @param[in] the_object is a pointer to an object
     545 * @brief Closes object.
     546 *
     547 * This function removes the_object control pointer and object name
     548 * in the Local Pointer and Local Name Tables.
     549 *
     550 * @param information Points to an Object Information Table.
     551 * @param[out] the_object A pointer to an object.
    547552 */
    548553void _Objects_Close(
     
    554559 * @brief Returns the count of active objects.
    555560 *
    556  * @param[in] information The object information table.
    557  *
    558  * @retval The count of active objects.
     561 * @param information The object information table.
     562 *
     563 * @return The count of active objects.
    559564 */
    560565Objects_Maximum _Objects_Active_count(
     
    562567);
    563568
     569/**
     570 * @brief Returns if the object has a string name.
     571 *
     572 * @param information The object information table.
     573 *
     574 * @retval true The object has a string name.
     575 * @retval false The object does not have a string name.
     576 */
    564577RTEMS_INLINE_ROUTINE bool _Objects_Has_string_name(
    565578  const Objects_Information *information
     
    569582}
    570583
     584/**
     585 * @brief Returns the object's objects per block.
     586 *
     587 * @param information The object information table.
     588 *
     589 * @return The number of objects per block of @a information.
     590 */
    571591RTEMS_INLINE_ROUTINE Objects_Maximum _Objects_Extend_size(
    572592  const Objects_Information *information
     
    577597
    578598/**
    579  * This function returns true if the api is valid.
    580  *
    581  * @param[in] the_api is the api portion of an object ID.
    582  *
    583  * @return This method returns true if the specified api value is valid
    584  *         and false otherwise.
     599 * @brief Checks if the api is valid.
     600 *
     601 * @param the_api is the api portion of an object ID.
     602 *
     603 * @retval true The specified api value is valid.
     604 * @retval false The specified api value is not valid.
    585605 */
    586606RTEMS_INLINE_ROUTINE bool _Objects_Is_api_valid(
     
    594614
    595615/**
    596  * This function returns true if the node is of the local object, and
    597  * false otherwise.
    598  *
    599  * @param[in] node is the node number and corresponds to the node number
     616 * @brief Checks if the node is of the local object.
     617 *
     618 * @param node The node number and corresponds to the node number
    600619 *        portion of an object ID.
    601620 *
    602  * @return This method returns true if the specified node is the local node
    603  *         and false otherwise.
     621 * @retval true The specified node is the local node.
     622 * @retval false The specified node is not the local node.
    604623 */
    605624RTEMS_INLINE_ROUTINE bool _Objects_Is_local_node(
     
    611630
    612631/**
    613  * This function returns true if the id is of a local object, and
    614  * false otherwise.
    615  *
    616  * @param[in] id is an object ID
    617  *
    618  * @return This method returns true if the specified object Id is local
    619  *         and false otherwise.
     632 * @brief Checks if the id is of a local object.
     633 *
     634 * @param id The object ID.
     635 *
     636 * @retval true The specified object Id is local.
     637 * @retval false The specified object Id is not local.
    620638 *
    621639 * @note On a single processor configuration, this always returns true.
     
    637655
    638656/**
    639  * This function returns true if left and right are equal,
    640  * and false otherwise.
    641  *
    642  * @param[in] left is the Id on the left hand side of the comparison
    643  * @param[in] right is the Id on the right hand side of the comparison
    644  *
    645  * @return This method returns true if the specified object IDs are equal
    646  *         and false otherwise.
     657 * @brief Checks if two object IDs are equal.
     658 *
     659 * @param left The Id on the left hand side of the comparison.
     660 * @param right The Id on the right hand side of the comparison.
     661 *
     662 * @retval true The specified object IDs are equal.
     663 * @retval false The specified object IDs are not equal.
    647664 */
    648665RTEMS_INLINE_ROUTINE bool _Objects_Are_ids_equal(
     
    655672
    656673/**
    657  * Returns the identifier with the minimum index for the specified identifier.
     674 * @brief Returns the identifier with the minimum index for the specified identifier.
    658675 *
    659676 * The specified identifier must have valid API, class and node fields.
    660677 *
    661  * @param[in] id The identifier to be processed.
     678 * @param id The identifier to be processed.
    662679 *
    663680 * @return The corresponding ID with the minimum index.
     
    671688
    672689/**
    673  * Returns the maximum index of the specified object class.
    674  *
    675  * @param[in] information The object information.
     690 * @brief Returns the maximum index of the specified object class.
     691 *
     692 * @param information The object information.
    676693 *
    677694 * @return The maximum index of the specified object class.
     
    685702
    686703/**
    687  * @brief Returns true if the automatic object extension (unlimited objects) is
    688  * enabled, otherwise false.
    689  *
    690  * @param[in] information The object information.
     704 * @brief Checks if the automatic object extension (unlimited objects) is
     705 * enabled.
     706 *
     707 * @param information The object information.
    691708 *
    692709 * @retval true The automatic object extension (unlimited objects) is enabled.
    693  * @retval false Otherwise.
     710 * @retval false The automatic object extension (unlimited objects) is not enabled.
    694711 */
    695712RTEMS_INLINE_ROUTINE Objects_Maximum _Objects_Is_auto_extend(
     
    701718
    702719/**
    703  * This function sets the pointer to the local_table object
     720 * @brief Sets the pointer to the local_table object
    704721 * referenced by the index.
    705722 *
    706  * @param[in] information points to an Object Information Table
    707  * @param[in] index is the index of the object the caller wants to access
    708  * @param[in] the_object is the local object pointer
     723 * @param[in, out] information Points to an Object Information Table.
     724 * @param index The index of the object the caller wants to access.
     725 * @param the_object The local object pointer.
    709726 *
    710727 * @note This routine is ONLY to be called in places where the
     
    732749
    733750/**
     751 * @brief Invalidates an object Id.
     752 *
    734753 * This function sets the pointer to the local_table object
    735  * referenced by the index to a NULL so the object Id is invalid
     754 * referenced by the index to NULL so the object Id is invalid
    736755 * after this call.
    737756 *
    738  * @param[in] information points to an Object Information Table
    739  * @param[in] the_object is the local object pointer
     757 * @param[in, out] information points to an Object Information Table.
     758 * @param the_object The local object pointer.
    740759 *
    741760 * @note This routine is ONLY to be called in places where the
     
    761780
    762781/**
    763  * This function places the_object control pointer and object name
    764  * in the Local Pointer and Local Name Tables, respectively.
    765  *
    766  * @param[in] information points to an Object Information Table
    767  * @param[in] the_object is a pointer to an object
    768  * @param[in] name is the name of the object to make accessible
     782 * @brief Places the_object control pointer and object name
     783 *      in the Local Pointer and Local Name Tables, respectively.
     784 *
     785 * This method uses Objects_Name for the object name.
     786 *
     787 * @param[in, out] information Points to an Object Information Table.
     788 * @param the_object Pointer to an object.
     789 * @param name The name of the object to make accessible.
    769790 */
    770791RTEMS_INLINE_ROUTINE void _Objects_Open(
     
    787808
    788809/**
    789  * This function places the_object control pointer and object name
    790  * in the Local Pointer and Local Name Tables, respectively.
    791  *
    792  * @param[in] information points to an Object Information Table
    793  * @param[in] the_object is a pointer to an object
    794  * @param[in] name is the name of the object to make accessible
     810 * @brief Places the_object control pointer and object name
     811 *      in the Local Pointer and Local Name Tables, respectively.
     812 *
     813 * This method uses uint32_t for the object name.
     814 *
     815 * @param[in, out] information Points to an Object Information Table.
     816 * @param the_object Pointer to an object.
     817 * @param name The name of the object to make accessible.
    795818 */
    796819RTEMS_INLINE_ROUTINE void _Objects_Open_u32(
     
    811834
    812835/**
    813  * This function places the_object control pointer and object name
    814  * in the Local Pointer and Local Name Tables, respectively.
    815  *
    816  * @param[in] information points to an Object Information Table
    817  * @param[in] the_object is a pointer to an object
    818  * @param[in] name is the name of the object to make accessible
     836 * @brief Places the_object control pointer and object name
     837 *      in the Local Pointer and Local Name Tables, respectively.
     838 *
     839 * This method uses a String for the object name.
     840 *
     841 * @param[in, out] information Points to an Object Information Table.
     842 * @param the_object Pointer to an object.
     843 * @param name The name of the object to make accessible.
    819844 */
    820845RTEMS_INLINE_ROUTINE void _Objects_Open_string(
     
    865890}
    866891
     892/**
     893 * @brief Checks if the allocator is the owner of the object allocator mutex
     894 *
     895 * @retval true The allocator is the owner of the object allocator mutex.
     896 * @retval false The allocato is not the owner of the object allocator mutex.
     897 */
    867898RTEMS_INLINE_ROUTINE bool _Objects_Allocator_is_owner( void )
    868899{
Note: See TracChangeset for help on using the changeset viewer.