doc: standardize @param (not @parma, @parmam, @params)

Signed-off-by: Nathan Cutler <ncutler@suse.com>

diff --git a/qa/workunits/ceph-helpers.sh b/qa/workunits/ceph-helpers.sh
index 2c1f7a47e355fcc81dd711f10a294b72e4ff16be..157888864972f5094c6d977560549e5e4be212dc 100755 (executable)
--- a/qa/workunits/ceph-helpers.sh
+++ b/qa/workunits/ceph-helpers.sh
@@ -188,7 +188,7 @@ function test_teardown() {
 # @param dir path name of the environment
 # @param signal name of the first signal (defaults to TERM)
 # @param name_prefix only kill match daemons (defaults to all)
-# @params delays sequence of sleep times before failure
+# @param delays sequence of sleep times before failure
 # @return 0 on success, 1 on error
 #
 function kill_daemons() {
@@ -729,7 +729,7 @@ function test_get_config() {
 # of the admin socket of **daemon**.**id**
 #
 # @param daemon mon or osd
-# @parma id mon or osd ID
+# @param id mon or osd ID
 # @param config the configuration variable name as found in config_opts.h
 # @param value the config value
 # @return 0 on success, 1 on error

diff --git a/src/cls/rbd/cls_rbd.cc b/src/cls/rbd/cls_rbd.cc
index 36271dab4443eb8f039079f5ad90410ccd88a2f5..cc8be065b9cef4b2b85b586d54aedde184940bca 100644 (file)
--- a/src/cls/rbd/cls_rbd.cc
+++ b/src/cls/rbd/cls_rbd.cc
@@ -356,8 +356,8 @@ int get_features(cls_method_context_t hctx, bufferlist *in, bufferlist *out)
  * set the image features
  *
  * Input:
- * @params features image features
- * @params mask image feature mask
+ * @param features image features
+ * @param mask image feature mask
  *
  * Output:
  * none
@@ -845,9 +845,9 @@ int get_flags(cls_method_context_t hctx, bufferlist *in, bufferlist *out)
  * set the image flags
  *
  * Input:
- * @params flags image flags
- * @params mask image flag mask
- * @params snap_id which snapshot to update, or CEPH_NOSNAP (uint64_t)
+ * @param flags image flags
+ * @param mask image flag mask
+ * @param snap_id which snapshot to update, or CEPH_NOSNAP (uint64_t)
  *
  * Output:
  * none

diff --git a/src/include/rbd/librbd.hpp b/src/include/rbd/librbd.hpp
index 7a4a2c7bdda6dfdbc869f78bbcd279f5deb4168e..daaa235e58ba64736685ba3b9f1e5a00aee3eba5 100644 (file)
--- a/src/include/rbd/librbd.hpp
+++ b/src/include/rbd/librbd.hpp
@@ -226,7 +226,7 @@ public:
 
   /* I/O */
   ssize_t read(uint64_t ofs, size_t len, ceph::bufferlist& bl);
-  /* @parmam op_flags see librados.h constants beginning with LIBRADOS_OP_FLAG */
+  /* @param op_flags see librados.h constants beginning with LIBRADOS_OP_FLAG */
   ssize_t read2(uint64_t ofs, size_t len, ceph::bufferlist& bl, int op_flags);
   int64_t read_iterate(uint64_t ofs, size_t len,
                       int (*cb)(uint64_t, size_t, const char *, void *), void *arg);
@@ -262,12 +262,12 @@ public:
                    int (*cb)(uint64_t, size_t, int, void *), void *arg);
 
   ssize_t write(uint64_t ofs, size_t len, ceph::bufferlist& bl);
-  /* @parmam op_flags see librados.h constants beginning with LIBRADOS_OP_FLAG */
+  /* @param op_flags see librados.h constants beginning with LIBRADOS_OP_FLAG */
   ssize_t write2(uint64_t ofs, size_t len, ceph::bufferlist& bl, int op_flags);
   int discard(uint64_t ofs, uint64_t len);
 
   int aio_write(uint64_t off, size_t len, ceph::bufferlist& bl, RBD::AioCompletion *c);
-  /* @parmam op_flags see librados.h constants beginning with LIBRADOS_OP_FLAG */
+  /* @param op_flags see librados.h constants beginning with LIBRADOS_OP_FLAG */
   int aio_write2(uint64_t off, size_t len, ceph::bufferlist& bl,
                  RBD::AioCompletion *c, int op_flags);
   /**
@@ -288,7 +288,7 @@ public:
    * @param c aio completion to notify when read is complete
    */
   int aio_read(uint64_t off, size_t len, ceph::bufferlist& bl, RBD::AioCompletion *c);
-  /* @parmam op_flags see librados.h constants beginning with LIBRADOS_OP_FLAG */
+  /* @param op_flags see librados.h constants beginning with LIBRADOS_OP_FLAG */
   int aio_read2(uint64_t off, size_t len, ceph::bufferlist& bl,
                  RBD::AioCompletion *c, int op_flags);
   int aio_discard(uint64_t off, uint64_t len, RBD::AioCompletion *c);