Changeset b403c67 in rtems


Ignore:
Timestamp:
Jan 9, 2013, 7:39:11 PM (7 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
4.11, master
Children:
25ba0cd
Parents:
e82fcb4
git-author:
Sebastian Huber <sebastian.huber@…> (01/09/13 19:39:11)
git-committer:
Sebastian Huber <sebastian.huber@…> (01/09/13 19:42:58)
Message:

libcsupport: Documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/libcsupport/include/rtems/libio_.h

    re82fcb4 rb403c67  
    186186 * The caller must hold the file system instance lock.
    187187 *
    188  * @param[out] clone will contain the cloned location.
    189  * @param[in] master is the master location.
     188 * @param[out] clone The cloned location.
     189 * @param[in] master The master location.
    190190 *
    191191 * @see rtems_filesystem_instance_lock().
     
    201201 * This function obtains and releases the file system instance lock.
    202202 *
    203  * @param[in] loc is the location of the node.
     203 * @param[in] loc The location of the node.
    204204 *
    205205 * @retval type The node type.
     
    216216 * This function may block on a mutex and may complete an unmount process.
    217217 *
    218  * @param[in] loc is the location to free.
    219  *
    220  * NOTE: The file system root location is released by the file system instance
    221  * destruction handler (see @ref rtems_filesystem_fsunmount_me_t).
     218 * @param[in] loc The location to free.
     219 *
     220 * @note The file system root location is released by the file system
     221 * instance destruction handler (see @ref rtems_filesystem_fsunmount_me_t).
    222222 *
    223223 * @see rtems_filesystem_freenode_t.
     
    361361 * current location.  The previous start and current locations are released.
    362362 *
    363  * @param[in, out] ctx is the path evaluation context.
    364  * @param[in, out] newstartloc_ptr is a pointer to the new start location.
     363 * @param[in, out] ctx The path evaluation context.
     364 * @param[in, out] newstartloc_ptr Pointer to the new start location.
    365365 */
    366366void rtems_filesystem_eval_path_restart(
     
    378378 * @brief Tests if the current location is a directory.
    379379 *
    380  * @param[in, out] ctx is the path evaluation context.
    381  * @param[in, out] arg is the handler argument.
     380 * @param[in, out] ctx The path evaluation context.
     381 * @param[in, out] arg The handler argument.
    382382 *
    383383 * @retval true The current location is a directory.
     
    394394 * @brief Evaluates a token.
    395395 *
    396  * @param[in, out] ctx is the path evaluation context.
    397  * @param[in, out] arg is the handler argument.
    398  * @param[in] token is the token contents.
    399  * @param[in] tokenlen is the token length in characters.
     396 * @param[in, out] ctx The path evaluation context.
     397 * @param[in, out] arg The handler argument.
     398 * @param[in] token The token contents.
     399 * @param[in] tokenlen The token length in characters.
    400400 *
    401401 * @retval status The generic path evaluation status.
     
    416416} rtems_filesystem_eval_path_generic_config;
    417417
    418 /**
    419  * @brief Evaluates a generic path.
    420  */
    421418void rtems_filesystem_eval_path_generic(
    422419  rtems_filesystem_eval_path_context_t *ctx,
     
    433430 * corresponding mount entry.
    434431 *
    435  * @param[out] dst is the destination location.
    436  * @param[in] src is the  source location.
     432 * @param[out] dst The destination location.
     433 * @param[in] src The  source location.
    437434 *
    438435 * @retval dst The destination location.
     
    464461 * @brief Assigns a global file system location.
    465462 *
    466  * @param[in, out] lhs_global_loc_ptr is a pointer to the global
    467  * left hand side file system location.  The current left hand side location
    468  * will be released.
    469  * @param[in] rhs_global_loc is the global right hand side file system location.
     463 * @param[in, out] lhs_global_loc_ptr Pointer to the global left hand side file
     464 * system location.  The current left hand side location will be released.
     465 * @param[in] rhs_global_loc The global right hand side file system location.
    470466 */
    471467void rtems_filesystem_global_location_assign(
     
    482478 * mutex.  Thread dispatching is disabled to protect some critical sections.
    483479 *
    484  * @param[in] global_loc_ptr is a pointer to the global file system location.
     480 * @param[in] global_loc_ptr Pointer to the global file system location.
    485481 *
    486482 * @return A global file system location.  It returns always a valid object.
     
    508504 * deferred.  The next obtain call will do the actual release.
    509505 *
    510  * @param[in] global_loc is the global file system location.  It must not
    511  * be NULL.
     506 * @param[in] global_loc The global file system location.  It must not be NULL.
    512507 *
    513508 * @see rtems_filesystem_global_location_obtain().
     
    557552  }
    558553}
    559 /**
    560  * @brief Create a file.
    561  */
     554
    562555int rtems_filesystem_mknod(
    563556  const rtems_filesystem_location_info_t *parentloc,
     
    570563int rtems_filesystem_chdir( rtems_filesystem_location_info_t *loc );
    571564
    572 /**
    573  * @brief Change the owner and the group of a file.
    574  */
    575565int rtems_filesystem_chown(
    576566  const char *path,
     
    702692}
    703693
    704 /**
    705  * @brief Evaluates an eat delimiter path.
    706  */
    707694void rtems_filesystem_eval_path_eat_delimiter(
    708695  rtems_filesystem_eval_path_context_t *ctx
Note: See TracChangeset for help on using the changeset viewer.