mirror of
https://gitlab.rtems.org/rtems/rtos/rtems.git
synced 2026-09-21 19:15:44 +08:00
libblock: Doxygen Enhancement Task #1
This commit is contained in:
Mathew Kallada
committed by
Jennifer Averett
Jennifer Averett
parent
f5f2676824
commit
f6c7bcfe99
@@ -33,6 +33,7 @@ extern "C" {
|
||||
#endif /* __cplusplus */
|
||||
|
||||
/**
|
||||
* @brief Manage Partitions of a Disk Device
|
||||
* @defgroup rtems_bdpart Block Device Partition Management
|
||||
*
|
||||
* @ingroup rtems_libblock
|
||||
@@ -334,6 +335,8 @@ rtems_status_code rtems_bdpart_unmount(
|
||||
);
|
||||
|
||||
/**
|
||||
* @brief Prints the Partition Table @a Partitions with @a Count Partitions
|
||||
*
|
||||
* Prints the partition table @a partitions with @a count partitions to
|
||||
* standard output.
|
||||
*/
|
||||
|
||||
@@ -276,7 +276,7 @@ static inline int rtems_disk_fd_reset_device_stats(int fd)
|
||||
/** @} */
|
||||
|
||||
/**
|
||||
* @brief Common IO control primitive.
|
||||
* @brief Common IO Control Primitive
|
||||
*
|
||||
* Use this in all block devices to handle the common set of IO control
|
||||
* requests.
|
||||
@@ -344,7 +344,7 @@ rtems_status_code rtems_blkdev_create_partition(
|
||||
);
|
||||
|
||||
/**
|
||||
* @brief Prints the block device statistics.
|
||||
* @brief Prints the Block Device Statistics
|
||||
*/
|
||||
void rtems_blkdev_print_stats(
|
||||
const rtems_blkdev_stats *stats,
|
||||
@@ -353,7 +353,7 @@ void rtems_blkdev_print_stats(
|
||||
);
|
||||
|
||||
/**
|
||||
* @brief Block device statistics command.
|
||||
* @brief Block Device Statistics Command
|
||||
*/
|
||||
void rtems_blkstats(
|
||||
FILE *output,
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Manage Partitions of a Disk Device
|
||||
* @ingroup rtems_bdpart
|
||||
*
|
||||
* Block device partition management.
|
||||
*/
|
||||
|
||||
/*
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Prints the Partition Table @a Partitions with @a Count Partitions
|
||||
* @ingroup rtems_bdpart
|
||||
*
|
||||
* Block device partition management.
|
||||
*/
|
||||
|
||||
/*
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Block Device Partition Management
|
||||
* @ingroup rtems_bdpart
|
||||
*
|
||||
* Block device partition management.
|
||||
*/
|
||||
|
||||
/*
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Block Device Partition Management
|
||||
* @ingroup rtems_bdpart
|
||||
*
|
||||
* Block device partition management.
|
||||
*/
|
||||
|
||||
/*
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Block Device Partition Management
|
||||
* @ingroup rtems_bdpart
|
||||
*
|
||||
* Block device partition management.
|
||||
*/
|
||||
|
||||
/*
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Block Device Partition Management
|
||||
* @ingroup rtems_bdpart
|
||||
*
|
||||
* Block device partition management.
|
||||
*/
|
||||
|
||||
/*
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Block Device Partition Management
|
||||
* @ingroup rtems_bdpart
|
||||
*
|
||||
* Block device partition management.
|
||||
*/
|
||||
|
||||
/*
|
||||
|
||||
@@ -1,3 +1,10 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Block Device Statistics Command
|
||||
* @ingroup rtems_blkdev Block Device Management
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
|
||||
*
|
||||
|
||||
@@ -1,3 +1,10 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Block Device IMFS
|
||||
* @ingroup libblock
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
|
||||
*
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Common IO Control Primitive
|
||||
* @ingroup rtems_blkdev
|
||||
*
|
||||
* Block device management.
|
||||
*/
|
||||
|
||||
/*
|
||||
|
||||
@@ -1,3 +1,10 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Prints the Block Device Statistics
|
||||
* @ingroup rtems_blkdev Block Device Management
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
|
||||
*
|
||||
|
||||
@@ -1,9 +1,8 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Block Device Management
|
||||
* @ingroup rtems_blkdev
|
||||
*
|
||||
* Block device management.
|
||||
*/
|
||||
|
||||
/*
|
||||
|
||||
@@ -1,3 +1,10 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Block Device Disk Management Initialize
|
||||
* @ingroup rtems_disk Block Device Disk Management
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2012 embedded brains GmbH. All rights reserved.
|
||||
*
|
||||
|
||||
@@ -1,6 +1,11 @@
|
||||
/*
|
||||
* flashdisk.c -- Flash disk block device implementation
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Flash Disk Block Device Implementation
|
||||
* @ingroup libblock
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2007 Chris Johns
|
||||
*
|
||||
* The license and distribution terms for this file may be
|
||||
|
||||
@@ -1,10 +1,11 @@
|
||||
/*****************************************************************************
|
||||
*
|
||||
* ide_part_table.c
|
||||
*
|
||||
* The implementation of library supporting "MS-DOS-style" partition table
|
||||
*
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Library supporting "MS-DOS-style" Partition Table
|
||||
* @ingroup libblock
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2002 OKTET Ltd., St.-Petersburg, Russia
|
||||
*
|
||||
* Author: Konstantin Abramenko <Konstantin.Abramenko@oktet.ru>
|
||||
@@ -14,7 +15,7 @@
|
||||
* found in the file LICENSE in this distribution or at
|
||||
* http://www.rtems.com/license/LICENSE.
|
||||
*
|
||||
*****************************************************************************/
|
||||
*/
|
||||
|
||||
#if HAVE_CONFIG_H
|
||||
#include "config.h"
|
||||
|
||||
@@ -1,11 +1,15 @@
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Provide SRAM support for the NV Disk
|
||||
* @ingroup libblock
|
||||
*/
|
||||
|
||||
/*
|
||||
* RTEMS Project (http://www.rtems.org/)
|
||||
*
|
||||
* Copyright 2007 Chris Johns (chrisj@rtems.org)
|
||||
*/
|
||||
/**
|
||||
* Provide SRAM support for the NV Disk.
|
||||
*/
|
||||
|
||||
#if HAVE_CONFIG_H
|
||||
#include "config.h"
|
||||
|
||||
@@ -1,6 +1,11 @@
|
||||
/*
|
||||
* nvdisk.c -- Non-volatile disk block device implementation
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Non-Volatile Disk Block Device Implementation
|
||||
* @ingroup libblock
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (C) 2007 Chris Johns
|
||||
*
|
||||
* The license and distribution terms for this file may be
|
||||
|
||||
@@ -1,38 +1,28 @@
|
||||
/*===============================================================*\
|
||||
| Project: RTEMS bdbuf inspector |
|
||||
+-----------------------------------------------------------------+
|
||||
| File: show_bdbuf.c
|
||||
+-----------------------------------------------------------------+
|
||||
| Copyright (c) 2005 |
|
||||
| Embedded Brains GmbH |
|
||||
| Obere Lagerstr. 30 |
|
||||
| D-82178 Puchheim |
|
||||
| Germany |
|
||||
| rtems@embedded-brains.de |
|
||||
+-----------------------------------------------------------------+
|
||||
| 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. |
|
||||
| |
|
||||
+-----------------------------------------------------------------+
|
||||
| this file contains functions to enable the monitor |
|
||||
| to show bdbuf information |
|
||||
| |
|
||||
| XXX!!! ATTETION!!! XXX!!! |
|
||||
| |
|
||||
| This module inspects the bdbuf data structures, |
|
||||
| assuming they are static, but in fact they are used very |
|
||||
| dynamically. Therefore the results show MAY BE INCORRECT in |
|
||||
| some cases. And, to cure this a bit, this module may block |
|
||||
| preemption for a rather long time and therefore it may |
|
||||
| BREAK THE REALTIME BEHAVIOUR OF YOUR SYSTEM (when in use) |
|
||||
+-----------------------------------------------------------------+
|
||||
| date history ID |
|
||||
| ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ |
|
||||
| 26.09.06 creation doe |
|
||||
|*****************************************************************|
|
||||
\*===============================================================*/
|
||||
/**
|
||||
* @file
|
||||
*
|
||||
* @brief Enable the Monitor to Show bdbuf Information
|
||||
* @ingroup rtems_bdpart
|
||||
*
|
||||
* This module inspects the bdbuf data structures,
|
||||
* assuming they are static, but in fact they are used very
|
||||
* dynamically. Therefore the results show MAY BE INCORRECT in
|
||||
* some cases. And, to cure this a bit, this module may block
|
||||
* preemption for a rather long time and therefore it may
|
||||
* BREAK THE REALTIME BEHAVIOUR OF YOUR SYSTEM (when in use)
|
||||
*/
|
||||
|
||||
/*
|
||||
* Copyright (c) 2005
|
||||
* Embedded Brains GmbH
|
||||
* Obere Lagerstr. 30
|
||||
* D-82178 Puchheim
|
||||
* Germany
|
||||
* rtems@embedded-brains.de
|
||||
* 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"
|
||||
|
||||
Reference in New Issue
Block a user