From: Andrew Deason Date: Tue, 8 Jun 2010 22:19:46 +0000 (-0500) Subject: Cleanup and doxygen-ify the comments for GetVolume X-Git-Tag: openafs-devel-1_5_75~120 X-Git-Url: https://git.michaelhowe.org/gitweb/?a=commitdiff_plain;h=7620e48414e7826f50a5dba86c5544512ac8a879;p=packages%2Fo%2Fopenafs.git Cleanup and doxygen-ify the comments for GetVolume Change-Id: I54788acd83779b986e78575bde11347952293be6 Reviewed-on: http://gerrit.openafs.org/2123 Reviewed-by: Tom Keiser Reviewed-by: Derrick Brashear Tested-by: Derrick Brashear --- diff --git a/src/vol/volume.c b/src/vol/volume.c index b3e29d78d..59bd530a6 100644 --- a/src/vol/volume.c +++ b/src/vol/volume.c @@ -3486,12 +3486,21 @@ VGetVolumeByVp_r(Error * ec, Volume * vp) return GetVolume(ec, NULL, vp->hashid, vp, 0); } -/* private interface for getting a volume handle - * volumeId must be provided. - * hint is an optional parameter to speed up hash lookups - * flags is not used at this time +/** + * private interface for getting a volume handle + * + * @param[out] ec error code (0 if no error) + * @param[out] client_ec wire error code to be given to clients + * @param[in] volumeId ID of the volume we want + * @param[in] hint optional hint for hash lookups, or NULL + * @param[in] flags unused; always 0 + * + * @return a volume handle for the specified volume + * @retval NULL an error occurred, or the volume is in such a state that + * we cannot load a header or return any volume struct + * + * @note for DAFS, caller must NOT hold a ref count on 'hint' */ -/* for demand attach fs, caller MUST NOT hold a ref count on hint */ static Volume * GetVolume(Error * ec, Error * client_ec, VolId volumeId, Volume * hint, int flags) {