From d883ce2eff04beda2b061edf29bd0b5455ce9b02 Mon Sep 17 00:00:00 2001 From: Mathew Kallada Date: Thu, 20 Dec 2012 08:22:52 -0600 Subject: libfs: Doxygen Enhancement Task #6" --- cpukit/libfs/src/devfs/devclose.c | 7 +++++ cpukit/libfs/src/devfs/devfs.h | 6 ++++ cpukit/libfs/src/devfs/devfs_show.c | 7 +++++ cpukit/libfs/src/devfs/devstat.c | 7 +++++ cpukit/libfs/src/dosfs/fat_fat_operations.c | 11 ++++--- cpukit/libfs/src/dosfs/fat_fat_operations.h | 8 ++++- cpukit/libfs/src/dosfs/fat_file.c | 11 ++++--- cpukit/libfs/src/dosfs/fat_file.h | 8 ++++- cpukit/libfs/src/dosfs/msdos.h | 46 ++++++++++++++++++++++++++-- cpukit/libfs/src/dosfs/msdos_conv.c | 12 ++++++-- cpukit/libfs/src/dosfs/msdos_create.c | 9 ++++-- cpukit/libfs/src/dosfs/msdos_dir.c | 9 ++++-- cpukit/libfs/src/dosfs/msdos_file.c | 9 ++++-- cpukit/libfs/src/dosfs/msdos_format.c | 42 ++++++++++++------------- cpukit/libfs/src/dosfs/msdos_free.c | 10 ++++-- cpukit/libfs/src/dosfs/msdos_fsunmount.c | 9 ++++-- cpukit/libfs/src/dosfs/msdos_handlers_dir.c | 9 ++++-- cpukit/libfs/src/dosfs/msdos_handlers_file.c | 9 ++++-- cpukit/libfs/src/dosfs/msdos_init.c | 9 ++++-- cpukit/libfs/src/dosfs/msdos_initsupp.c | 9 ++++-- cpukit/libfs/src/dosfs/msdos_misc.c | 9 ++++-- cpukit/libfs/src/dosfs/msdos_node_type.c | 9 ++++-- cpukit/libfs/src/dosfs/msdos_rename.c | 9 ++++-- cpukit/libfs/src/dosfs/msdos_rmnod.c | 9 ++++-- 24 files changed, 219 insertions(+), 64 deletions(-) diff --git a/cpukit/libfs/src/devfs/devclose.c b/cpukit/libfs/src/devfs/devclose.c index 83646c7619..505554f216 100644 --- a/cpukit/libfs/src/devfs/devclose.c +++ b/cpukit/libfs/src/devfs/devclose.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Maps Close Operation to rtems_io_close + * @ingroup DevFsDeviceTable Define Device Table Type + */ + /* * The license and distribution terms for this file may be * found in the file LICENSE in this distribution or at diff --git a/cpukit/libfs/src/devfs/devfs.h b/cpukit/libfs/src/devfs/devfs.h index 3fd1fab036..2317b10852 100644 --- a/cpukit/libfs/src/devfs/devfs.h +++ b/cpukit/libfs/src/devfs/devfs.h @@ -88,6 +88,8 @@ extern int devFS_open( /** + * @brief Maps Close Operation to rtems_io_close + * * This handler maps close operation to rtems_io_close. * @param iop This is the RTEMS's internal representation of file * @retval the same as close @@ -153,6 +155,8 @@ extern int devFS_ioctl( /** + * @brief Gets the Device File Information + * * This handler gets the device file information. This routine only set the following member of struct stat: * st_dev : device number * st_mode: device file creation mode, only two mode are accepted: @@ -227,6 +231,8 @@ extern int devFS_initialize( /** + * @brief Retrieves and Prints all the Device Registered in System + * * This routine retrieves all the device registered in system, and * prints out their detail information. For example, on one system, * devFS_show will print out following message: diff --git a/cpukit/libfs/src/devfs/devfs_show.c b/cpukit/libfs/src/devfs/devfs_show.c index 56badb1207..43cb02dfea 100644 --- a/cpukit/libfs/src/devfs/devfs_show.c +++ b/cpukit/libfs/src/devfs/devfs_show.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Retrieves and Prints all the Device Registered in System + * @ingroup DevFsDeviceTable Define Device Table Type + */ + /* * The license and distribution terms for this file may be * found in the file LICENSE in this distribution or at diff --git a/cpukit/libfs/src/devfs/devstat.c b/cpukit/libfs/src/devfs/devstat.c index f988448f70..f2b3de1840 100644 --- a/cpukit/libfs/src/devfs/devstat.c +++ b/cpukit/libfs/src/devfs/devstat.c @@ -1,3 +1,10 @@ +/** + * @file + * + * @brief Gets the Device File Information + * @ingroup DevFsDeviceTable Define Device Table Type + */ + /* * The license and distribution terms for this file may be * found in the file LICENSE in this distribution or at diff --git a/cpukit/libfs/src/dosfs/fat_fat_operations.c b/cpukit/libfs/src/dosfs/fat_fat_operations.c index 7496c09272..e558cec427 100644 --- a/cpukit/libfs/src/dosfs/fat_fat_operations.c +++ b/cpukit/libfs/src/dosfs/fat_fat_operations.c @@ -1,8 +1,11 @@ -/* - * fat_fat_operations.c - * - * General operations on File Allocation Table +/** + * @file * + * @brief General operations on File Allocation Table + * @ingroup libfs_ffo Fat Fat Operations + */ + +/* * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia * Author: Eugeny S. Mints */ diff --git a/cpukit/libfs/src/dosfs/fat_fat_operations.h b/cpukit/libfs/src/dosfs/fat_fat_operations.h index f9c124d055..278947ffca 100644 --- a/cpukit/libfs/src/dosfs/fat_fat_operations.h +++ b/cpukit/libfs/src/dosfs/fat_fat_operations.h @@ -19,6 +19,12 @@ #include +/** + * @defgroup libfs_ffo Fat Fat Operations + * + * @ingroup libfs + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif @@ -54,5 +60,5 @@ fat_free_fat_clusters_chain( #ifdef __cplusplus } #endif - +/**@}*/ #endif /* __DOSFS_FAT_FAT_OPERATIONS_H__ */ diff --git a/cpukit/libfs/src/dosfs/fat_file.c b/cpukit/libfs/src/dosfs/fat_file.c index 43826c9205..3e2d60967c 100644 --- a/cpukit/libfs/src/dosfs/fat_file.c +++ b/cpukit/libfs/src/dosfs/fat_file.c @@ -1,8 +1,11 @@ -/* - * fat_file.c - * - * General operations on "fat-file" +/** + * @file * + * @brief General operations on "fat-file" + * @ingroup libfs_ff Fat File + */ + +/* * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia * Author: Eugeny S. Mints * diff --git a/cpukit/libfs/src/dosfs/fat_file.h b/cpukit/libfs/src/dosfs/fat_file.h index 2018e995d7..0e22c90e60 100644 --- a/cpukit/libfs/src/dosfs/fat_file.h +++ b/cpukit/libfs/src/dosfs/fat_file.h @@ -20,6 +20,12 @@ #include "fat.h" +/** + * @defgroup libfs_ff Fat File + * + * @ingroup libfs + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif @@ -182,5 +188,5 @@ fat_file_mark_removed(fat_fs_info_t *fs_info, #ifdef __cplusplus } #endif - +/**@}*/ #endif /* __DOSFS_FAT_FILE_H__ */ diff --git a/cpukit/libfs/src/dosfs/msdos.h b/cpukit/libfs/src/dosfs/msdos.h index 26bf906173..ad0841297c 100644 --- a/cpukit/libfs/src/dosfs/msdos.h +++ b/cpukit/libfs/src/dosfs/msdos.h @@ -19,6 +19,12 @@ #include "fat.h" #include "fat_file.h" +/** + * @defgroup libfs_msdos MSDOS FileSystem + * + * @ingroup libfs + */ +/**@{*/ #ifdef __cplusplus extern "C" { #endif @@ -73,6 +79,12 @@ extern const rtems_filesystem_file_handlers_r msdos_file_handlers; #define MSDOS_REGULAR_FILE RTEMS_FILESYSTEM_MEMORY_FILE #define MSDOS_HARD_LINK RTEMS_FILESYSTEM_HARD_LINK /* pseudo type */ +/** + * @brief Type of Node that Loc Refers To + * + * The following returns the type of node that the loc refers to. + * + */ typedef rtems_filesystem_node_types_t msdos_node_type_t; /* @@ -220,11 +232,20 @@ typedef enum msdos_token_types_e */ #define MSDOS_DPS512_NUM 16 -/* Prototypes */ +/** + * @brief Shut Down MSDOS FileSystem + * + * MSDOS shut down handler implementation + */ void msdos_shut_down(rtems_filesystem_mount_table_entry_t *temp_mt_entry); void msdos_eval_path(rtems_filesystem_eval_path_context_t *ctx); +/** + * @brief Call Fat-File Close Routine + * + * Free node handler implementation for the filesystem operations table. + */ void msdos_free_node_info(const rtems_filesystem_location_info_t *pathloc); rtems_filesystem_node_types_t msdos_node_type( @@ -239,11 +260,21 @@ int msdos_mknod( dev_t dev ); +/** + * @brief Remove Node from MSDOS Directory + * + * MSDOS Directory Handlers Implementation + */ int msdos_rmnod( const rtems_filesystem_location_info_t *parentloc, const rtems_filesystem_location_info_t *loc ); +/** + * @brief Rename a MSDOS FileSystem Node + * + * Routine to rename a MSDOS filesystem node + */ int msdos_rename( const rtems_filesystem_location_info_t *old_parent_loc, const rtems_filesystem_location_info_t *old_loc, @@ -256,6 +287,11 @@ void msdos_lock(const rtems_filesystem_mount_table_entry_t *mt_entry); void msdos_unlock(const rtems_filesystem_mount_table_entry_t *mt_entry); +/** + * @brief MSDOS Filesystem Initialization + * + * MSDOS Initialization support routine implementation + */ int msdos_initialize_support( rtems_filesystem_mount_table_entry_t *temp_mt_entry, const rtems_filesystem_operations_table *op_table, @@ -305,6 +341,12 @@ int msdos_dir_stat( struct stat *buf ); +/** + * @brief Implements wake up version of the "signal" operation + * + * Routine to create a new MSDOS filesystem node + * + */ int msdos_creat_node(const rtems_filesystem_location_info_t *parent_loc, msdos_node_type_t type, const char *name, @@ -402,5 +444,5 @@ int msdos_sync(rtems_libio_t *iop); #ifdef __cplusplus } #endif - +/**@}*/ #endif /* __DOSFS_MSDOS_H__ */ diff --git a/cpukit/libfs/src/dosfs/msdos_conv.c b/cpukit/libfs/src/dosfs/msdos_conv.c index 95b25814db..7549c42e56 100644 --- a/cpukit/libfs/src/dosfs/msdos_conv.c +++ b/cpukit/libfs/src/dosfs/msdos_conv.c @@ -1,7 +1,10 @@ -/* - * Adaptation of NetBSD code for RTEMS by Victor V. Vengerov +/** + * @file + * + * @brief MDOS Date Conversion + * @ingroup libfs_msdos MSDOS FileSystem */ -/* $NetBSD: msdosfs_conv.c,v 1.10 1994/12/27 18:36:24 mycroft Exp $ */ + /* * Written by Paul Popelka (paulp@uts.amdahl.com) * @@ -15,6 +18,9 @@ * functioning of this software in any circumstances and is not liable for * any damages caused by this software. * + * Adaptation of NetBSD code for RTEMS by Victor V. Vengerov + * $NetBSD: msdosfs_conv.c,v 1.10 1994/12/27 18:36:24 mycroft Exp $ + * * October 1992 */ diff --git a/cpukit/libfs/src/dosfs/msdos_create.c b/cpukit/libfs/src/dosfs/msdos_create.c index f8e1a9e19d..886dd404cc 100644 --- a/cpukit/libfs/src/dosfs/msdos_create.c +++ b/cpukit/libfs/src/dosfs/msdos_create.c @@ -1,6 +1,11 @@ -/* - * Routine to create a new MSDOS filesystem node +/** + * @file * + * @brief Create a new MSDOS FileSystem node + * @ingroup libfs_msdos MSDOS FileSystem + */ + +/* * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia * Author: Eugeny S. Mints * diff --git a/cpukit/libfs/src/dosfs/msdos_dir.c b/cpukit/libfs/src/dosfs/msdos_dir.c index 961568e47d..fd9ca40461 100644 --- a/cpukit/libfs/src/dosfs/msdos_dir.c +++ b/cpukit/libfs/src/dosfs/msdos_dir.c @@ -1,6 +1,11 @@ -/* - * MSDOS directory handlers implementation +/** + * @file * + * @brief MSDOS Directory Handlers Implementation + * @ingroup libfs_msdos MSDOS FileSystem + */ + +/* * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia * Author: Eugeny S. Mints * diff --git a/cpukit/libfs/src/dosfs/msdos_file.c b/cpukit/libfs/src/dosfs/msdos_file.c index a5b9c7abb2..b19b848786 100644 --- a/cpukit/libfs/src/dosfs/msdos_file.c +++ b/cpukit/libfs/src/dosfs/msdos_file.c @@ -1,6 +1,11 @@ -/* - * MSDOS file handlers implementation +/** + * @file * + * @brief MSDOS File Handlers Implementation + * @ingroup libfs + */ + +/* * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia * Author: Eugeny S. Mints * diff --git a/cpukit/libfs/src/dosfs/msdos_format.c b/cpukit/libfs/src/dosfs/msdos_format.c index 0b30caf030..49015e8fbd 100644 --- a/cpukit/libfs/src/dosfs/msdos_format.c +++ b/cpukit/libfs/src/dosfs/msdos_format.c @@ -1,25 +1,23 @@ -/*===============================================================*\ -| Project: RTEMS msdos format functionality | -+-----------------------------------------------------------------+ -| File: msdos_format.c | -+-----------------------------------------------------------------+ -| Copyright (c) 2004 IMD | -| Ingenieurbuero fuer Microcomputertechnik Th. Doerfler | -| | -| all rights reserved | -+-----------------------------------------------------------------+ -| this file contains msdos_format function. This function | -| formats a disk partition conforming to MS-DOS conventions | -| | -| The license and distribution terms for this file may be | -| found in the file LICENSE in this distribution or at | -| http://www.rtems.com/license/LICENSE. | -| | -+-----------------------------------------------------------------+ -| date history ID | -| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ | -| 29.10.04 creation doe | -\*===============================================================*/ +/** + * @file + * + * @brief RTEMS MSDOS Format Functionality + * @ingroup libfs + * + * This function formats a disk partition conforming to MS-DOS conventions + */ + +/* + * Copyright (C) 2004 IMD + * Ingenieurbuero fuer Microcomputertechnik Th. Doerfler + * + * + * All rights reserved. + * + * The license and distribution terms for this file may be + * found in the file LICENSE in this distribution or at + * http://www.rtems.com/license/LICENSE. + */ #if HAVE_CONFIG_H #include "config.h" diff --git a/cpukit/libfs/src/dosfs/msdos_free.c b/cpukit/libfs/src/dosfs/msdos_free.c index 4dc26b7e9e..44db35d3ee 100644 --- a/cpukit/libfs/src/dosfs/msdos_free.c +++ b/cpukit/libfs/src/dosfs/msdos_free.c @@ -1,7 +1,11 @@ -/* - * Free node handler implementation for the filesystem - * operations table. +/** + * @file * + * @brief Call Fat-File Close Routine + * @ingroup libfs_msdos MSDOS FileSystem + */ + +/* * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia * Author: Eugeny S. Mints * diff --git a/cpukit/libfs/src/dosfs/msdos_fsunmount.c b/cpukit/libfs/src/dosfs/msdos_fsunmount.c index e23daaab4e..90a8073bf8 100644 --- a/cpukit/libfs/src/dosfs/msdos_fsunmount.c +++ b/cpukit/libfs/src/dosfs/msdos_fsunmount.c @@ -1,6 +1,11 @@ -/* - * MSDOS shut down handler implementation +/** + * @file * + * @brief Shut Down MSDOS FileSystem + * @ingroup libfs_msdos MSDOS FileSystem + */ + +/* * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia * Author: Eugeny S. Mints * diff --git a/cpukit/libfs/src/dosfs/msdos_handlers_dir.c b/cpukit/libfs/src/dosfs/msdos_handlers_dir.c index a56353b5fd..41efdb439d 100644 --- a/cpukit/libfs/src/dosfs/msdos_handlers_dir.c +++ b/cpukit/libfs/src/dosfs/msdos_handlers_dir.c @@ -1,6 +1,11 @@ -/* - * Directory Handlers Table for MSDOS filesystem +/** + * @file * + * @brief Directory Handlers Table for MSDOS FileSystem + * @ingroup libfs + */ + +/* * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia * Author: Eugeny S. Mints * diff --git a/cpukit/libfs/src/dosfs/msdos_handlers_file.c b/cpukit/libfs/src/dosfs/msdos_handlers_file.c index e6edae0636..2a3938d02a 100644 --- a/cpukit/libfs/src/dosfs/msdos_handlers_file.c +++ b/cpukit/libfs/src/dosfs/msdos_handlers_file.c @@ -1,6 +1,11 @@ -/* - * File Operations Table for MSDOS filesystem +/** + * @file * + * @brief File Operations Table for MSDOS FileSystem + * @ingroup libfs + */ + +/* * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia * Author: Eugeny S. Mints * diff --git a/cpukit/libfs/src/dosfs/msdos_init.c b/cpukit/libfs/src/dosfs/msdos_init.c index 544fef49be..eb46141503 100644 --- a/cpukit/libfs/src/dosfs/msdos_init.c +++ b/cpukit/libfs/src/dosfs/msdos_init.c @@ -1,6 +1,11 @@ -/* - * Init routine for MSDOS +/** + * @file * + * @brief Init Routine for MSDOS + * @ingroup libfs + */ + +/* * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia * Author: Eugeny S. Mints * diff --git a/cpukit/libfs/src/dosfs/msdos_initsupp.c b/cpukit/libfs/src/dosfs/msdos_initsupp.c index cf24d4bb64..08441869b4 100644 --- a/cpukit/libfs/src/dosfs/msdos_initsupp.c +++ b/cpukit/libfs/src/dosfs/msdos_initsupp.c @@ -1,6 +1,11 @@ -/* - * MSDOS Initialization support routine implementation +/** + * @file * + * @brief MSDOS Filesystem Initialization + * @ingroup libfs_msdos MSDOS FileSystem + */ + +/* * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia * Author: Eugeny S. Mints * diff --git a/cpukit/libfs/src/dosfs/msdos_misc.c b/cpukit/libfs/src/dosfs/msdos_misc.c index 5ebf257b5a..a1979b1e2c 100644 --- a/cpukit/libfs/src/dosfs/msdos_misc.c +++ b/cpukit/libfs/src/dosfs/msdos_misc.c @@ -1,6 +1,11 @@ -/* - * Miscellaneous routines implementation for MSDOS filesystem +/** + * @file * + * @brief Miscellaneous Routines Implementation for MSDOS FileSystem + * @ingroup libfs + */ + +/* * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia * Author: Eugeny S. Mints * diff --git a/cpukit/libfs/src/dosfs/msdos_node_type.c b/cpukit/libfs/src/dosfs/msdos_node_type.c index 27b5189af4..c1b83d0709 100644 --- a/cpukit/libfs/src/dosfs/msdos_node_type.c +++ b/cpukit/libfs/src/dosfs/msdos_node_type.c @@ -1,6 +1,11 @@ -/* - * The following returns the type of node that the loc refers to. +/** + * @file * + * @brief Type of Node that Loc Refers To + * @ingroup libfs_msdos MSDOS FileSystem + */ + +/* * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia * Author: Eugeny S. Mints * diff --git a/cpukit/libfs/src/dosfs/msdos_rename.c b/cpukit/libfs/src/dosfs/msdos_rename.c index 5423cdbf77..c6d1f560f3 100644 --- a/cpukit/libfs/src/dosfs/msdos_rename.c +++ b/cpukit/libfs/src/dosfs/msdos_rename.c @@ -1,6 +1,11 @@ -/* - * Routine to rename a MSDOS filesystem node +/** + * @file * + * @brief Rename a MSDOS FileSystem Node + * @ingroup libfs_msdos MSDOS FileSystem + */ + +/* * Copyright (C) 2010 Chris Johns * * The license and distribution terms for this file may be diff --git a/cpukit/libfs/src/dosfs/msdos_rmnod.c b/cpukit/libfs/src/dosfs/msdos_rmnod.c index 099b9287e5..36408e15a1 100644 --- a/cpukit/libfs/src/dosfs/msdos_rmnod.c +++ b/cpukit/libfs/src/dosfs/msdos_rmnod.c @@ -1,6 +1,11 @@ -/* - * MSDOS directory handlers implementation +/** + * @file * + * @brief Remove Node from MSDOS Directory + * @ingroup libfs_msdos MSDOS FileSystem + */ + +/* * Copyright (C) 2001 OKTET Ltd., St.-Petersburg, Russia * Author: Eugeny S. Mints * -- cgit v1.2.3