Commit 052c4aff authored by Jim Harris's avatar Jim Harris Committed by Ben Walker
Browse files

doc: fix a bunch of parameter-related Doxygen comments 



There are still a small handful of Doxygen warnings
remaining, but this fixes most of what was left.

Signed-off-by: default avatarJim Harris <james.r.harris@intel.com>
Change-Id: I3f8bf3efad2382faf1e6d09f85d802e0ce0bb23d

Reviewed-on: https://review.gerrithub.io/415857


Tested-by: default avatarSPDK Automated Test System <sys_sgsw@intel.com>
Reviewed-by: default avatarDaniel Verkamp <daniel.verkamp@intel.com>
Reviewed-by: default avatarBen Walker <benjamin.walker@intel.com>
parent cccc940e

include/spdk/bdev.h

+2 −1
Original line number Diff line number Diff line
@@ -858,7 +858,7 @@ int spdk_bdev_nvme_io_passthru(struct spdk_bdev_desc *bdev_desc, 
 * so that portion of the command may be left empty. Also, the namespace

 * id (nsid) will be populated automatically.

 *

 * \param bdev Block device

 * \param bdev_desc Block device descriptor

 * \param ch I/O channel. Obtained by calling spdk_bdev_get_io_channel().

 * \param cmd The raw NVMe command. Must be in the NVM command set.

 * \param buf Data buffer to written from.
@@ -905,6 +905,7 @@ void spdk_bdev_get_io_stat(struct spdk_bdev *bdev, struct spdk_io_channel *ch, 
 * via the callback function.

 *

 * \param bdev Block device to query.

 * \param stat Structure for aggregating collected statistics.  Passed as argument to cb.

 * \param cb Called when this operation completes.

 * \param cb_arg Argument passed to callback function.

 */

include/spdk/cpuset.h

+1 −1
Original line number Diff line number Diff line
@@ -138,7 +138,7 @@ uint32_t spdk_cpuset_count(const struct spdk_cpuset *set); 
/**

 * Convert a CPU set to hex string.

 *

 * \param CPU set.

 * \param set CPU set.

 *

 * \return a pointer to hexadecimal representation of CPU set. Buffer to store a

 * string is dynamically allocated internally and freed with CPU set object.

include/spdk/env.h

+1 −1
Original line number Diff line number Diff line
@@ -1033,7 +1033,7 @@ int spdk_mem_register(void *vaddr, size_t len); 
 * are completed or cancelled before calling this function.

 *

 * \param vaddr Virtual address to unregister.

 * \param leng Length in bytes of the vaddr.

 * \param len Length in bytes of the vaddr.

 *

 * \return 0 on success, negative errno on failure.

 */

include/spdk/log.h

+1 −1
Original line number Diff line number Diff line
@@ -144,7 +144,7 @@ int spdk_log_set_trace_flag(const char *flag); 
/**

 * Clear a trace flag.

 *

 * \flag Trace flag to clear.

 * \param flag Trace flag to clear.

 *

 * \return 0 on success, -1 on failure.

 */

include/spdk/nvme.h

+3 −2
Original line number Diff line number Diff line
@@ -886,7 +886,7 @@ int spdk_nvme_ctrlr_cmd_get_feature(struct spdk_nvme_ctrlr *ctrlr, 
 * \param payload_size The size of payload buffer.

 * \param cb_fn Callback function to invoke when the feature has been retrieved.

 * \param cb_arg Argument to pass to the callback function.

 * \param ns_is The namespace identifier.

 * \param ns_id The namespace identifier.

 *

 * \return 0 if successfully submitted, ENOMEM if resources could not be allocated

 * for this request
@@ -914,7 +914,7 @@ int spdk_nvme_ctrlr_cmd_get_feature_ns(struct spdk_nvme_ctrlr *ctrlr, uint8_t fe 
 * \param payload_size The size of payload buffer.

 * \param cb_fn Callback function to invoke when the feature has been set.

 * \param cb_arg Argument to pass to the callback function.

 * \param ns_is The namespace identifier.

 * \param ns_id The namespace identifier.

 *

 * \return 0 if successfully submitted, ENOMEM if resources could not be allocated

 * for this request.
@@ -1013,6 +1013,7 @@ int spdk_nvme_ctrlr_format(struct spdk_nvme_ctrlr *ctrlr, uint32_t nsid, 
/**

 * \brief Download a new firmware image.

 *

 * \param ctrlr NVMe controller to perform firmware operation on.

 * \param payload The data buffer for the firmware image.

 * \param size The data size will be downloaded.

 * \param slot The slot that the firmware image will be committed to.