Changeset a89a2ec5 in rtems


Ignore:
Timestamp:
Jan 9, 2013, 7:52:44 PM (7 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
4.11, master
Children:
cf8a351
Parents:
25ba0cd
Message:

IMFS: Documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/libfs/src/imfs/imfs.h

    r25ba0cd ra89a2ec5  
    2222#include <rtems/pipe.h>
    2323
    24 /**
    25  * @defgroup IMFS POSIX In-Memory File System Support
    26  *
    27  * @brief In-Memory File System Support
    28  *
    29  * @{
    30  */
    31 
    3224#ifdef __cplusplus
    3325extern "C" {
    3426#endif
     27
     28/**
     29 * @defgroup IMFS POSIX In-Memory File System Support
     30 *
     31 * @brief In-Memory File System Support.
     32 *
     33 * @{
     34 */
    3535
    3636/*
     
    162162} IMFS_types_union;
    163163
     164/** @} */
     165
    164166/**
    165167 * @addtogroup IMFSGenericNodes
     
    171173 * @brief Initializes an IMFS node.
    172174 *
    173  * @param[in,out] node is the IMFS node.
    174  * @param[in] info is the IMFS type information.
     175 * @param[in,out] node The IMFS node.
     176 * @param[in] info The IMFS type information.
    175177 *
    176178 * @retval node Successful operation.
     
    189191 * @brief Returns the node and does nothing else.
    190192 *
    191  * @param[in,out] node is the IMFS node.
    192  * @param[in] info is the IMFS type information.
     193 * @param[in,out] node The IMFS node.
     194 * @param[in] info The IMFS type information.
    193195 *
    194196 * @retval node Returns always the node passed as parameter.
     
    204206 * @brief Returns the node and sets the generic node context.
    205207 *
    206  * @param[in,out] node is the IMFS node.
    207  * @param[in] info is the IMFS type information.
     208 * @param[in,out] node The IMFS node.
     209 * @param[in] info The IMFS type information.
    208210 *
    209211 * @retval node Returns always the node passed as parameter.
     
    219221 * @brief Prepares the removal of an IMFS node from its parent directory.
    220222 *
    221  * @param[in,out] node is the IMFS node.
     223 * @param[in,out] node The IMFS node.
    222224 *
    223225 * @retval node Successful operation.
     
    234236 * @brief Returns the node and does nothing else.
    235237 *
    236  * @param[in,out] node is the IMFS node.
     238 * @param[in,out] node The IMFS node.
    237239 *
    238240 * @retval node Returns always the node passed as parameter.
     
    247249 * @brief Destroys an IMFS node.
    248250 *
    249  * @param[in,out] node is the IMFS node.
     251 * @param[in,out] node The IMFS node.
    250252 *
    251253 * @retval node Returns always the node passed as parameter.
     
    258260 * @brief Returns the node and does nothing else.
    259261 *
    260  * @param[in,out] node is the IMFS node.
     262 * @param[in,out] node The IMFS node.
    261263 *
    262264 * @retval node Returns always the node passed as parameter.
     
    278280
    279281/** @} */
     282
     283/**
     284 * @addtogroup IMFS
     285 *
     286 * @{
     287 */
    280288
    281289/*
     
    595603);
    596604
     605/** @} */
    597606
    598607/**
     
    615624 * @brief Makes a generic IMFS node.
    616625 *
    617  * @param[in] path is a pointer to the new generic IMFS node.
    618  * @param[in] mode is the node mode.
    619  * @param[in] node_control is the node control.
    620  * @param[in] context is the node control handler context.
     626 * @param[in] path The path to the new generic IMFS node.
     627 * @param[in] mode The node mode.
     628 * @param[in] node_control The node control.
     629 * @param[in] context The node control handler context.
    621630 *
    622631 * @retval 0 Successful operation.
     
    660669
    661670/** @} */
     671
     672/**
     673 * @addtogroup IMFS
     674 *
     675 * @{
     676 */
    662677
    663678/**
     
    758773/** @} */
    759774
    760 
    761775/**
    762776 * @name IMFS Device Node Handlers
     
    767781 * @{
    768782 */
    769 
    770783
    771784extern int device_open(
     
    943956}
    944957
     958/** @} */
     959
    945960/**
    946961 * @addtogroup IMFSGenericNodes
     
    984999/** @} */
    9851000
    986 /** @} */
    987 
    9881001#ifdef __cplusplus
    9891002}
Note: See TracChangeset for help on using the changeset viewer.