LU-4975 ofd: Fix Doxygen warnings for ofd files

After patches 10417 and 10586, some Doxygen warnings were created
due to incorrect syntax and missing function parameters in header.
This patch fixes those warnings.

Signed-off-by: Doug Oucharek <doug.s.oucharek@intel.com>
Change-Id: I6859d9cbe17f52562ae1e93ea4fa0afb08b3f547
Reviewed-on: http://review.whamcloud.com/12665
Tested-by: Jenkins
Reviewed-by: Richard Henwood <richard.henwood@intel.com>
Tested-by: Maloo <hpdd-maloo@intel.com>
Reviewed-by: Johann Lombardi <johann.lombardi@intel.com>

diff --git a/lustre/ofd/ofd_fs.c b/lustre/ofd/ofd_fs.c
index 0b7386d..66b9e39 100644 (file)
--- a/lustre/ofd/ofd_fs.c
+++ b/lustre/ofd/ofd_fs.c
@@ -54,7 +54,7 @@
  * value which shouldn't be exceeded.
  *
  * \param[in] ofd      OFD device
  * value which shouldn't be exceeded.
  *
  * \param[in] ofd      OFD device

- * \param[in] int      number of updates in the batch
+ * \param[in] batch    number of updates in the batch

  *
  * \retval             \a batch limited by ofd_device::ofd_precreate_batch
  */
  *
  * \retval             \a batch limited by ofd_device::ofd_precreate_batch
  */


@@ -157,7 +157,7 @@ static struct ofd_seq *ofd_seq_add(const struct lu_env *env,
 /**
  * Get last object ID for the given sequence.
  *
 /**
  * Get last object ID for the given sequence.
  *

- * \param[in] ofd_seq  OFD sequence structure
+ * \param[in] oseq     OFD sequence structure

  *
  * \retval             the last object ID for this sequence
  */
  *
  * \retval             the last object ID for this sequence
  */

diff --git a/lustre/ofd/ofd_grant.c b/lustre/ofd/ofd_grant.c
index b3e38bd..8471392 100644 (file)
--- a/lustre/ofd/ofd_grant.c
+++ b/lustre/ofd/ofd_grant.c
@@ -496,7 +496,7 @@ static inline int ofd_grant_rnb_size(struct obd_export *exp,
  * \param[in] oa       incoming obdo in which we should return the pack the
  *                     additional grant
  * \param[in,out] rnb  the list of network buffers
  * \param[in] oa       incoming obdo in which we should return the pack the
  *                     additional grant
  * \param[in,out] rnb  the list of network buffers

- * \param[in] niocont  the number of network buffers in the list
+ * \param[in] niocount the number of network buffers in the list

  * \param[in] left     the remaining free space with space already granted
  *                     taken out
  */
  * \param[in] left     the remaining free space with space already granted
  *                     taken out
  */


@@ -850,7 +850,7 @@ void ofd_grant_discard(struct obd_export *exp)
  *
  * \param[in] env      is the lu environment provided by the caller
  * \param[in] exp      is the export of the client which sent the request
  *
  * \param[in] env      is the lu environment provided by the caller
  * \param[in] exp      is the export of the client which sent the request

- * \paral[in,out] oa   is the incoming obdo sent by the client
+ * \param[in,out] oa   is the incoming obdo sent by the client

  */
 void ofd_grant_prepare_read(const struct lu_env *env,
                            struct obd_export *exp, struct obdo *oa)
  */
 void ofd_grant_prepare_read(const struct lu_env *env,
                            struct obd_export *exp, struct obdo *oa)


@@ -925,7 +925,7 @@ void ofd_grant_prepare_read(const struct lu_env *env,
  * \param[in] exp      export of the client which sent the request
  * \param[in] oa       incoming obdo sent by the client
  * \param[in] rnb      list of network buffers
  * \param[in] exp      export of the client which sent the request
  * \param[in] oa       incoming obdo sent by the client
  * \param[in] rnb      list of network buffers

- * \param[in] niocont  number of network buffers in the list
+ * \param[in] niocount number of network buffers in the list

  */
 void ofd_grant_prepare_write(const struct lu_env *env,
                             struct obd_export *exp, struct obdo *oa,
  */
 void ofd_grant_prepare_write(const struct lu_env *env,
                             struct obd_export *exp, struct obdo *oa,


@@ -1113,6 +1113,7 @@ int ofd_grant_create(const struct lu_env *env, struct obd_export *exp, int *nr)
  *
  * \param[in] env      LU environment provided by the caller
  * \param[in] exp      export of the client which sent the request
  *
  * \param[in] env      LU environment provided by the caller
  * \param[in] exp      export of the client which sent the request

+ * \param[in] rc       return code of pre-commit operations

  */
 void ofd_grant_commit(const struct lu_env *env, struct obd_export *exp,
                      int rc)
  */
 void ofd_grant_commit(const struct lu_env *env, struct obd_export *exp,
                      int rc)