From: Stephan Wiesand Date: Wed, 23 Jul 2014 11:57:50 +0000 (+0200) Subject: volinfo: fix documenting comments X-Git-Tag: upstream/1.8.0_pre1^2~626 X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=bf5685e537ea3991644ee5e79de0f88c34508c59;p=packages%2Fo%2Fopenafs.git volinfo: fix documenting comments 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 Reviewed-by: Chas Williams - CONTRACTOR Reviewed-by: D Brashear --- diff --git a/src/vol/vol-info.c b/src/vol/vol-info.c index 956b7380a..e5b39fbfc 100644 --- a/src/vol/vol-info.c +++ b/src/vol/vol-info.c @@ -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 */