Changeset f58fd970 in rtems for cpukit/libblock


Ignore:
Timestamp:
Dec 21, 2012, 7:28:24 PM (7 years ago)
Author:
Sebastian Huber <sebastian.huber@…>
Branches:
4.11, master
Children:
9fd4d0d1
Parents:
e5e1d8f
Message:

libblock: Use @brief in documentation

File:
1 edited

Legend:

Unmodified
Added
Removed
  • cpukit/libblock/include/rtems/bdpart.h

    re5e1d8f rf58fd970  
    206206
    207207/**
    208  * Reads the partition information from the physical disk device with name
    209  * @a disk_name.
     208 * @brief Reads the partition information from the physical disk device with
     209 * name @a disk_name.
    210210 *
    211211 * The partition information will be stored in the partition table
     
    223223
    224224/**
    225  * Sorts the partition table @a partitions with @a count partitions to have
    226  * ascending begin blocks
     225 * @brief Sorts the partition table @a partitions with @a count partitions to
     226 * have ascending begin blocks
    227227 */
    228228void rtems_bdpart_sort( rtems_bdpart_partition *partitions, size_t count);
    229229
    230230/**
    231  * Writes the partition table to the physical disk device with name
     231 * @brief Writes the partition table to the physical disk device with name
    232232 * @a disk_name.
    233233 *
     
    249249
    250250/**
    251  * Creates a partition table in @a partitions with @a count partitions for the
    252  * physical disk device with name @a disk_name.
     251 * @brief Creates a partition table in @a partitions with @a count partitions
     252 * for the physical disk device with name @a disk_name.
    253253 *
    254254 * The array of positive integer weights in @a distribution must have exactly
     
    267267
    268268/**
    269  * Registers the partitions as logical disks for the physical disk device with
    270  * name @a disk_name.
     269 * @brief Registers the partitions as logical disks for the physical disk
     270 * device with name @a disk_name.
    271271 *
    272272 * For each partition of the partition table @a partitions with @a count
     
    274274 * partition table index plus one.  The name of the logical disk device is the
    275275 * concatenation of the physical disk device name and the partition number.
     276 *
     277 * @see rtems_blkdev_create_partition().
    276278 */
    277279rtems_status_code rtems_bdpart_register(
     
    282284
    283285/**
    284  * Reads the partition table from the disk device with name @a disk_name and
    285  * registers the partitions as logical disks.
     286 * @a brief Reads the partition table from the disk device with name @a
     287 * disk_name and registers the partitions as logical disks.
    286288 *
    287289 * @see rtems_bdpart_register() and rtems_fsmount().
     
    290292
    291293/**
    292  * Deletes the logical disks associated with the partitions of the disk device
    293  * with name @a disk_name.
     294 * @brief Deletes the logical disks associated with the partitions of the disk
     295 * device with name @a disk_name.
    294296 *
    295297 * The partition table @a partitions with @a count partitions will be used to
     
    304306
    305307/**
    306  * Mounts all supported file systems inside the logical disks derived from the
    307  * partitions of the physical disk device with name @a disk_name.
     308 * @brief Mounts all supported file systems inside the logical disks derived
     309 * from the partitions of the physical disk device with name @a disk_name.
    308310 *
    309311 * For each partition in the partition table @a partitions with @a count
     
    325327
    326328/**
    327  * Unmounts all file systems mounted with rtems_bdpart_mount().
     329 * @brief Unmounts all file systems mounted with rtems_bdpart_mount().
    328330 */
    329331rtems_status_code rtems_bdpart_unmount(
     
    335337
    336338/**
    337  * @brief The Partition Table @a Partitions with @a Count Partitions is printed.
    338  *
    339  * Prints the partition table @a partitions with @a count partitions to
     339 * @brief Prints the partition table @a partitions with @a count partitions to
    340340 * standard output.
    341341 */
     
    343343
    344344/**
    345  * Returns the partition type for the MBR partition type value @a mbr_type in
    346  * @a type.
     345 * @brief Returns the partition type for the MBR partition type value
     346 * @a mbr_type in @a type.
    347347 */
    348348void rtems_bdpart_to_partition_type( uint8_t mbr_type, uuid_t type);
    349349
    350350/**
    351  * Converts the partition type in @a type to the MBR partition type.
     351 * @brief Converts the partition type in @a type to the MBR partition type.
    352352 *
    353353 * The result will be stored in @a mbr_type.  Returns @c true in case of a
Note: See TracChangeset for help on using the changeset viewer.