From: Kefu Chai Date: Thu, 19 Mar 2015 03:36:44 +0000 (+0800) Subject: doc: fix doxygen warnings X-Git-Tag: v9.0.0~112^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=830752a528416b6d8e64dfe70166ee546e4d53b9;p=ceph.git doc: fix doxygen warnings Signed-off-by: Kefu Chai --- diff --git a/src/common/Initialize.h b/src/common/Initialize.h index 273a8710b8cf..35414d64be8f 100644 --- a/src/common/Initialize.h +++ b/src/common/Initialize.h @@ -59,8 +59,8 @@ class Initialize { /** * This form of constructor causes its function argument to be invoked * when the object is constructed. When used with a static Initialize - * object, this will cause #func to run before main() runs, so that - * #func can perform once-only initialization. + * object, this will cause \p func to run before main() runs, so that + * \p func can perform once-only initialization. * * \param func * This function is invoked with no arguments when the object is diff --git a/src/common/hobject.h b/src/common/hobject.h index 94aa6bf78286..c6123d4ff7f4 100644 --- a/src/common/hobject.h +++ b/src/common/hobject.h @@ -170,8 +170,8 @@ public: /** * Returns set S of strings such that for any object * h where h.match(bits, mask), there is some string - * s \in S such that s is a prefix of h.to_str(). - * Furthermore, for any s \in S, s is a prefix of + * s \f$\in\f$ S such that s is a prefix of h.to_str(). + * Furthermore, for any s $f\in\f$ S, s is a prefix of * h.str() implies that h.match(bits, mask). */ static set get_prefixes( diff --git a/src/crush/CrushWrapper.h b/src/crush/CrushWrapper.h index cfafab067dee..4e60d7ec42ca 100644 --- a/src/crush/CrushWrapper.h +++ b/src/crush/CrushWrapper.h @@ -621,7 +621,6 @@ public: * * Will return the weight for the first instance it finds. * - * @param cct cct * @param id item id to check * @return weight of item */ diff --git a/src/crush/mapper.c b/src/crush/mapper.c index b2e0bfd9266f..e9ca652fae3b 100644 --- a/src/crush/mapper.c +++ b/src/crush/mapper.c @@ -43,10 +43,10 @@ /** * crush_find_rule - find a crush_rule id for a given ruleset, type, and size. - * @map: the crush_map - * @ruleset: the storage ruleset id (user defined) - * @type: storage ruleset type (user defined) - * @size: output set size + * @param map: the crush_map + * @param ruleset: the storage ruleset id (user defined) + * @param type: storage ruleset type (user defined) + * @param size: output set size */ int crush_find_rule(const struct crush_map *map, int ruleset, int type, int size) { @@ -388,22 +388,22 @@ static int is_out(const struct crush_map *map, /** * crush_choose_firstn - choose numrep distinct items of given type - * @map: the crush_map - * @bucket: the bucket we are choose an item from - * @x: crush input value - * @numrep: the number of items to choose - * @type: the type of item to choose - * @out: pointer to output vector - * @outpos: our position in that vector - * @out_size: size of the out vector - * @tries: number of attempts to make - * @recurse_tries: number of attempts to have recursive chooseleaf make - * @local_retries: localized retries - * @local_fallback_retries: localized fallback retries - * @recurse_to_leaf: true if we want one device under each item of given type (chooseleaf instead of choose) - * @vary_r: pass r to recursive calls - * @out2: second output vector for leaf items (if @recurse_to_leaf) - * @parent_r: r value passed from the parent + * @param map: the crush_map + * @param bucket: the bucket we are choose an item from + * @param x: crush input value + * @param numrep: the number of items to choose + * @param type: the type of item to choose + * @param out: pointer to output vector + * @param outpos: our position in that vector + * @param out_size: size of the out vector + * @param tries: number of attempts to make + * @param recurse_tries: number of attempts to have recursive chooseleaf make + * @param local_retries: localized retries + * @param local_fallback_retries: localized fallback retries + * @param recurse_to_leaf: true if we want one device under each item of given type (chooseleaf instead of choose) + * @param vary_r: pass r to recursive calls + * @param out2: second output vector for leaf items (if @recurse_to_leaf) + * @param parent_r: r value passed from the parent */ static int crush_choose_firstn(const struct crush_map *map, struct crush_bucket *bucket, @@ -769,14 +769,14 @@ static void crush_choose_indep(const struct crush_map *map, /** * crush_do_rule - calculate a mapping with the given input and rule - * @map: the crush_map - * @ruleno: the rule id - * @x: hash input - * @result: pointer to result vector - * @result_max: maximum result size - * @weight: weight vector (for map leaves) - * @weight_max: size of weight vector - * @scratch: scratch vector for private use; must be >= 3 * result_max + * @param map: the crush_map + * @param ruleno: the rule id + * @param x: hash input + * @param result: pointer to result vector + * @param result_max: maximum result size + * @param weight: weight vector (for map leaves) + * @param weight_max: size of weight vector + * @param scratch: scratch vector for private use; must be >= 3 * result_max */ int crush_do_rule(const struct crush_map *map, int ruleno, int x, int *result, int result_max, diff --git a/src/include/rados/librados.h b/src/include/rados/librados.h index 15a225bf5ffc..9d372cedc4e9 100644 --- a/src/include/rados/librados.h +++ b/src/include/rados/librados.h @@ -624,7 +624,6 @@ CEPH_RADOS_API uint64_t rados_get_instance_id(rados_t cluster); * * @param cluster which cluster the pool is in * @param pool_name name of the pool - * @param pool_id unique id of the pool * @param ioctx where to store the io context * @returns 0 on success, negative error code on failure */ diff --git a/src/include/rados/librados.hpp b/src/include/rados/librados.hpp index 92aa9f66e3a2..74e970eaa6be 100644 --- a/src/include/rados/librados.hpp +++ b/src/include/rados/librados.hpp @@ -790,7 +790,7 @@ namespace librados /** * Retrieve hit set for a given hash, and time * - * @param uint32_t [in] hash position + * @param hash [in] hash position * @param c [in] completion * @param stamp [in] time interval that falls within the hit set's interval * @param pbl [out] buffer to store the result in diff --git a/src/include/radosstriper/libradosstriper.h b/src/include/radosstriper/libradosstriper.h index f8f0490ac758..70595c933d51 100644 --- a/src/include/radosstriper/libradosstriper.h +++ b/src/include/radosstriper/libradosstriper.h @@ -257,7 +257,7 @@ int rados_striper_setxattr(rados_striper_t striper, * Delete an extended attribute from a striped object. * * @param striper the striper in which the rmxattr will occur - * @param o the name of the object + * @param oid name of the object * @param name which xattr to delete * @returns 0 on success, negative error code on failure */ diff --git a/src/include/radosstriper/libradosstriper.hpp b/src/include/radosstriper/libradosstriper.hpp index 2da201cfe199..05179ffbc658 100644 --- a/src/include/radosstriper/libradosstriper.hpp +++ b/src/include/radosstriper/libradosstriper.hpp @@ -142,25 +142,25 @@ namespace libradosstriper /** * synchronously append data to the striped object - * NOTE: this call steals the contents of @param bl. + * NOTE: this call steals the contents of @p bl. */ int append(const std::string& soid, const ceph::bufferlist& bl, size_t len); /** * asynchronously write to the striped object at the specified offset. - * NOTE: this call steals the contents of @param bl. + * NOTE: this call steals the contents of @p bl. */ int aio_write(const std::string& soid, librados::AioCompletion *c, const ceph::bufferlist& bl, size_t len, uint64_t off); /** * asynchronously fill the striped object with the specified data - * NOTE: this call steals the contents of @param bl. + * NOTE: this call steals the contents of @p bl. */ int aio_write_full(const std::string& soid, librados::AioCompletion *c, const ceph::bufferlist& bl); /** * asynchronously append data to the striped object - * NOTE: this call steals the contents of @param bl. + * NOTE: this call steals the contents of @p bl. */ int aio_append(const std::string& soid, librados::AioCompletion *c, const ceph::bufferlist& bl, size_t len); diff --git a/src/include/rbd/librbd.hpp b/src/include/rbd/librbd.hpp index 67c9c74a72fe..a5a7bae045d4 100644 --- a/src/include/rbd/librbd.hpp +++ b/src/include/rbd/librbd.hpp @@ -234,9 +234,8 @@ public: int aio_flush(RBD::AioCompletion *c); /** - * Drop any cached data for an image + * Drop any cached data for this image * - * @param image the image to invalidate cached data for * @returns 0 on success, negative error code on failure */ int invalidate_cache(); diff --git a/src/key_value_store/kv_flat_btree_async.h b/src/key_value_store/kv_flat_btree_async.h index 6713bf6ec26b..46e8b357c741 100644 --- a/src/key_value_store/kv_flat_btree_async.h +++ b/src/key_value_store/kv_flat_btree_async.h @@ -689,7 +689,7 @@ protected: * * @param idata: the index data parsed from the index entry left by the dead * client. - * @param errno: the error that caused the client to realize the other client + * @param error: the error that caused the client to realize the other client * died (should be -ENOENT or -ETIMEDOUT) * @post: rolls forward if -ENOENT, otherwise rolls back. */ diff --git a/src/librbd/AsyncFlattenRequest.h b/src/librbd/AsyncFlattenRequest.h index 3f0c61262968..c2af903ef4da 100644 --- a/src/librbd/AsyncFlattenRequest.h +++ b/src/librbd/AsyncFlattenRequest.h @@ -34,6 +34,8 @@ private: * Flatten goes through the following state machine to copyup objects * from the parent image: * + * @verbatim + * * * | * v @@ -49,6 +51,8 @@ private: * . . * . . . . . . . . . . . . . . . . . . . * + * @endverbatim + * * The _UPDATE_CHILDREN state will be skipped if the image has one or * more snapshots. The _UPDATE_HEADER state will be skipped if the * image was concurrently flattened by another client. diff --git a/src/librbd/AsyncResizeRequest.h b/src/librbd/AsyncResizeRequest.h index a719c9d59c4c..277b39d2d768 100644 --- a/src/librbd/AsyncResizeRequest.h +++ b/src/librbd/AsyncResizeRequest.h @@ -38,6 +38,8 @@ private: * Resize goes through the following state machine to resize the image * and update the object map: * + * @verbatim + * * -------------> STATE_FINISHED -----------------------------\ * | . (no change) | * | . | @@ -60,6 +62,8 @@ private: * v v v * STATE_SHRINK_OBJECT_MAP ---> * + * @endverbatim + * * The _OBJECT_MAP states are skipped if the object map isn't enabled. * The state machine will immediately transition to _FINISHED if there * are no objects to trim. diff --git a/src/librbd/AsyncTrimRequest.h b/src/librbd/AsyncTrimRequest.h index 7a89a119bb95..9a000dfa93c6 100644 --- a/src/librbd/AsyncTrimRequest.h +++ b/src/librbd/AsyncTrimRequest.h @@ -25,6 +25,8 @@ protected: * Trim goes through the following state machine to remove whole objects, * clean partially trimmed objects, and update the object map: * + * @verbatim + * * . . . . > STATE_FINISHED . . . . . . . . . * | . . * | . . . . . . . . . . . . . @@ -40,6 +42,8 @@ protected: * . . * . . . . . . . . . . . . . . . . . . . . . . . * + * @endverbatim + * * The _PRE_REMOVE/_POST_REMOVE states are skipped if the object map * isn't enabled. The _REMOVE_OBJECTS state is skipped if no whole objects * are removed. The _CLEAN_BOUNDARY state is skipped if no boundary diff --git a/src/librbd/CopyupRequest.h b/src/librbd/CopyupRequest.h index 92714c2bc9a4..87a6b16efb4c 100644 --- a/src/librbd/CopyupRequest.h +++ b/src/librbd/CopyupRequest.h @@ -31,6 +31,9 @@ namespace librbd { * Copyup requests go through the following state machine to read from the * parent image, update the object map, and copyup the object: * + * + * @verbatim + * * * | * v @@ -40,6 +43,9 @@ namespace librbd { * . | * v v * + * + * @endverbatim + * * The _OBJECT_MAP state is skipped if the object map isn't enabled. */ enum State { diff --git a/src/mds/MDLog.cc b/src/mds/MDLog.cc index ebc474a8081b..8f23633b701b 100644 --- a/src/mds/MDLog.cc +++ b/src/mds/MDLog.cc @@ -585,7 +585,7 @@ class C_MaybeExpiredSegment : public MDSInternalContext { }; /** - * Like ::trim, but instead of trimming to max_segments, trim all but the latest + * Like MDLog::trim, but instead of trimming to max_segments, trim all but the latest * segment. */ int MDLog::trim_all() diff --git a/src/mon/LogMonitor.cc b/src/mon/LogMonitor.cc index 05bb73fd9b5d..ad3a422beb22 100644 --- a/src/mon/LogMonitor.cc +++ b/src/mon/LogMonitor.cc @@ -535,10 +535,10 @@ bool LogMonitor::_create_sub_summary(MLog *mlog, int level) } /** - * Create an incremental log message from version @sv to @summary.version + * Create an incremental log message from version \p sv to \p summary.version * * @param mlog Log message we'll send to the client with the messages received - * since version @sv, inclusive. + * since version \p sv, inclusive. * @param level The max log level of the messages the client is interested in. * @param sv The version the client is looking for. */ diff --git a/src/mon/MonClient.h b/src/mon/MonClient.h index 239d91b45872..4df8320bb883 100644 --- a/src/mon/MonClient.h +++ b/src/mon/MonClient.h @@ -288,7 +288,7 @@ public: * reply in @p result_reply. * * @param[in] mon_id Target monitor's ID - * @param[out] Resulting reply from mon.ID, if param != NULL + * @param[out] result_reply reply from mon.ID, if param != NULL * @returns 0 in case of success; < 0 in case of error, * -ETIMEDOUT if monitor didn't reply before timeout * expired (default: conf->client_mount_timeout). diff --git a/src/msg/Connection.h b/src/msg/Connection.h index 8961d6438f50..1539b39100de 100644 --- a/src/msg/Connection.h +++ b/src/msg/Connection.h @@ -113,7 +113,6 @@ public: * * @param m The Message to send. The Messenger consumes a single reference * when you pass it in. - * @param con The Connection to send the Message out on. * * @return 0 on success, or -errno on failure. */ diff --git a/src/os/FileStore.h b/src/os/FileStore.h index af1fb8d81212..bdd6761cf77d 100644 --- a/src/os/FileStore.h +++ b/src/os/FileStore.h @@ -635,7 +635,7 @@ public: * @param expected_num_objs - expected number of objects in this collection * @param spos - sequence position * - * @Return 0 on success, an error code otherwise + * @return 0 on success, an error code otherwise */ int _collection_hint_expected_num_objs(coll_t c, uint32_t pg_num, uint64_t expected_num_objs, diff --git a/src/os/IndexManager.h b/src/os/IndexManager.h index cf9ba898c478..6feafacd0185 100644 --- a/src/os/IndexManager.h +++ b/src/os/IndexManager.h @@ -77,7 +77,7 @@ public: * Reserve and return index for c * * @param [in] c Collection for which to get index - * @param [in] path Path to collection + * @param [in] baseDir base directory of collections * @param [out] index Index for c * @return error code */ diff --git a/src/os/ObjectStore.h b/src/os/ObjectStore.h index b45ae2879948..dd703743dcd4 100644 --- a/src/os/ObjectStore.h +++ b/src/os/ObjectStore.h @@ -2048,7 +2048,7 @@ public: * @param start list objects that sort >= this value * @param min return at least this many results, unless we reach the end * @param max return no more than this many results - * @param snapid return no objects with snap < snapid + * @param snap return no objects with snap < snapid * @param ls [out] result * @param next [out] next item sorts >= this value * @return zero on success, or negative error diff --git a/src/osd/ReplicatedPG.h b/src/osd/ReplicatedPG.h index f128c71e8d44..d44096a1e2e9 100644 --- a/src/osd/ReplicatedPG.h +++ b/src/osd/ReplicatedPG.h @@ -1309,7 +1309,6 @@ protected: * @param src: The source object * @param oloc: the source object locator * @param version: the version of the source object to copy (0 for any) - * @param temp_dest_oid: the temporary object to use for large objects */ void start_copy(CopyCallback *cb, ObjectContextRef obc, hobject_t src, object_locator_t oloc, version_t version, unsigned flags,