volinfo: fix documenting comments
authorStephan Wiesand <stephan.wiesand@desy.de>
Wed, 23 Jul 2014 11:57:50 +0000 (13:57 +0200)
committerD Brashear <shadow@your-file-system.com>
Wed, 6 Aug 2014 14:28:41 +0000 (10:28 -0400)
As pointed by Andrew deason during review of the 1.6 pullup of
commit ae27283550dab33704f30e18975722e0ed2c5424, psize is not
a parameter of HandleHeaderFiles, and in function HandleSpecialFile
it is of type inout since the value is first read by the += operation.
Fix this, and try to improve the description of psize too.

Change-Id: Ia728b20475f0c44b6104dc954aaa04d5f0f098b5
Reviewed-on: http://gerrit.openafs.org/11319
Tested-by: BuildBot <buildbot@rampaginggeek.com>
Reviewed-by: Chas Williams - CONTRACTOR <chas@cmf.nrl.navy.mil>
Reviewed-by: D Brashear <shadow@your-file-system.com>

src/vol/vol-info.c

index 956b738..e5b39fb 100644 (file)
@@ -871,11 +871,11 @@ HandlePart(struct VolInfoOpt *opt, struct DiskPartition64 *partP)
 /**
  * Inspect a volume header special file.
  *
- * @param[in]  name       descriptive name of the type of header special file
- * @param[in]  dp         partition object for this volume
- * @param[in]  header     header object for this volume
- * @param[in]  inode      fileserver inode number for this header special file
- * @param[out] psize      total of the header special file
+ * @param[in]    name       descriptive name of the type of header special file
+ * @param[in]    dp         partition object for this volume
+ * @param[in]    header     header object for this volume
+ * @param[in]    inode      fileserver inode number for this header special file
+ * @param[inout] psize      total of the header special file sizes
  *
  * @return none
  */
@@ -938,7 +938,6 @@ HandleSpecialFile(struct VolInfoOpt *opt, const char *name, struct DiskPartition
  * @param[in]  dp         partition object for this volume
  * @param[in]  header_fd  volume header file descriptor
  * @param[in]  header     volume header object
- * @param[out] psize      total of the header special file
  *
  * @return none
  */