From b403c670aeb06d4b145cf85643747398ad0506a4 Mon Sep 17 00:00:00 2001 From: Sebastian Huber Date: Wed, 9 Jan 2013 20:39:11 +0100 Subject: libcsupport: Documentation --- cpukit/libcsupport/include/rtems/libio_.h | 57 ++++++++++++------------------- 1 file changed, 22 insertions(+), 35 deletions(-) (limited to 'cpukit/libcsupport/include/rtems/libio_.h') diff --git a/cpukit/libcsupport/include/rtems/libio_.h b/cpukit/libcsupport/include/rtems/libio_.h index 80f83f939b..4a2d0f4c1a 100644 --- a/cpukit/libcsupport/include/rtems/libio_.h +++ b/cpukit/libcsupport/include/rtems/libio_.h @@ -185,8 +185,8 @@ extern rtems_filesystem_global_location_t rtems_filesystem_global_location_null; * * The caller must hold the file system instance lock. * - * @param[out] clone will contain the cloned location. - * @param[in] master is the master location. + * @param[out] clone The cloned location. + * @param[in] master The master location. * * @see rtems_filesystem_instance_lock(). */ @@ -200,7 +200,7 @@ void rtems_filesystem_location_clone( * * This function obtains and releases the file system instance lock. * - * @param[in] loc is the location of the node. + * @param[in] loc The location of the node. * * @retval type The node type. * @@ -215,10 +215,10 @@ rtems_filesystem_node_types_t rtems_filesystem_node_type( * * This function may block on a mutex and may complete an unmount process. * - * @param[in] loc is the location to free. + * @param[in] loc The location to free. * - * NOTE: The file system root location is released by the file system instance - * destruction handler (see @ref rtems_filesystem_fsunmount_me_t). + * @note The file system root location is released by the file system + * instance destruction handler (see @ref rtems_filesystem_fsunmount_me_t). * * @see rtems_filesystem_freenode_t. */ @@ -360,8 +360,8 @@ void rtems_filesystem_eval_path_cleanup_with_parent( * The function obtains the new start location and clones it to set the new * current location. The previous start and current locations are released. * - * @param[in, out] ctx is the path evaluation context. - * @param[in, out] newstartloc_ptr is a pointer to the new start location. + * @param[in, out] ctx The path evaluation context. + * @param[in, out] newstartloc_ptr Pointer to the new start location. */ void rtems_filesystem_eval_path_restart( rtems_filesystem_eval_path_context_t *ctx, @@ -377,8 +377,8 @@ typedef enum { /** * @brief Tests if the current location is a directory. * - * @param[in, out] ctx is the path evaluation context. - * @param[in, out] arg is the handler argument. + * @param[in, out] ctx The path evaluation context. + * @param[in, out] arg The handler argument. * * @retval true The current location is a directory. * @retval false Otherwise. @@ -393,10 +393,10 @@ typedef bool (*rtems_filesystem_eval_path_is_directory)( /** * @brief Evaluates a token. * - * @param[in, out] ctx is the path evaluation context. - * @param[in, out] arg is the handler argument. - * @param[in] token is the token contents. - * @param[in] tokenlen is the token length in characters. + * @param[in, out] ctx The path evaluation context. + * @param[in, out] arg The handler argument. + * @param[in] token The token contents. + * @param[in] tokenlen The token length in characters. * * @retval status The generic path evaluation status. * @@ -415,9 +415,6 @@ typedef struct { rtems_filesystem_eval_path_eval_token eval_token; } rtems_filesystem_eval_path_generic_config; -/** - * @brief Evaluates a generic path. - */ void rtems_filesystem_eval_path_generic( rtems_filesystem_eval_path_context_t *ctx, void *arg, @@ -432,8 +429,8 @@ void rtems_filesystem_initialize(void); * A bitwise copy is performed. The destination location will be added to the * corresponding mount entry. * - * @param[out] dst is the destination location. - * @param[in] src is the source location. + * @param[out] dst The destination location. + * @param[in] src The source location. * * @retval dst The destination location. * @@ -463,10 +460,9 @@ rtems_filesystem_location_transform_to_global( /** * @brief Assigns a global file system location. * - * @param[in, out] lhs_global_loc_ptr is a pointer to the global - * left hand side file system location. The current left hand side location - * will be released. - * @param[in] rhs_global_loc is the global right hand side file system location. + * @param[in, out] lhs_global_loc_ptr Pointer to the global left hand side file + * system location. The current left hand side location will be released. + * @param[in] rhs_global_loc The global right hand side file system location. */ void rtems_filesystem_global_location_assign( rtems_filesystem_global_location_t **lhs_global_loc_ptr, @@ -481,7 +477,7 @@ void rtems_filesystem_global_location_assign( * This function must be called from normal thread context and may block on a * mutex. Thread dispatching is disabled to protect some critical sections. * - * @param[in] global_loc_ptr is a pointer to the global file system location. + * @param[in] global_loc_ptr Pointer to the global file system location. * * @return A global file system location. It returns always a valid object. * In case of an error, the global null location will be returned. Each @@ -507,8 +503,7 @@ rtems_filesystem_global_location_t *rtems_filesystem_global_location_obtain( * sections of the operating system. In this case the release will be * deferred. The next obtain call will do the actual release. * - * @param[in] global_loc is the global file system location. It must not - * be NULL. + * @param[in] global_loc The global file system location. It must not be NULL. * * @see rtems_filesystem_global_location_obtain(). */ @@ -556,9 +551,7 @@ static inline void rtems_filesystem_location_error( errno = eno; } } -/** - * @brief Create a file. - */ + int rtems_filesystem_mknod( const rtems_filesystem_location_info_t *parentloc, const char *name, @@ -569,9 +562,6 @@ int rtems_filesystem_mknod( int rtems_filesystem_chdir( rtems_filesystem_location_info_t *loc ); -/** - * @brief Change the owner and the group of a file. - */ int rtems_filesystem_chown( const char *path, uid_t owner, @@ -701,9 +691,6 @@ static inline void rtems_filesystem_eval_path_put_back_token( ctx->tokenlen = 0; } -/** - * @brief Evaluates an eat delimiter path. - */ void rtems_filesystem_eval_path_eat_delimiter( rtems_filesystem_eval_path_context_t *ctx ); -- cgit v1.2.3