Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

DAOS-623 doc: Fix some doxygen formatting issues. #12980

Merged
merged 4 commits into from
Oct 16, 2023
Merged
Show file tree
Hide file tree
Changes from 2 commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 8 additions & 8 deletions src/bio/bio_config.c
Original file line number Diff line number Diff line change
Expand Up @@ -639,9 +639,9 @@ check_vmd_status(struct json_config_ctx *ctx, struct spdk_json_val *vmd_ss, bool
* Set allowed bdev PCI addresses in provided SPDK environment options based on attach bdev RPCs
* in the JSON config file.
*
* \param[IN] nvme_conf JSON config file path
* \param[OUT] opts SPDK environment options
* \param[OUT] roles global nvme bdev roles
* \param[in] nvme_conf JSON config file path
* \param[out] opts SPDK environment options
* \param[out] roles global nvme bdev roles
*
* \returns Zero on success, negative on failure (DER)
*/
Expand Down Expand Up @@ -833,7 +833,7 @@ hotplug_filter_fn(const struct spdk_pci_addr *addr)
/**
* Set hotplug bus-ID ranges in SPDK filter based on values read from JSON config file.
*
* \param[IN] nvme_conf JSON config file path
* \param[in] nvme_conf JSON config file path
*
* \returns Zero on success, negative on failure (DER)
*/
Expand All @@ -854,7 +854,7 @@ bio_set_hotplug_filter(const char *nvme_conf)
/**
* Read optional acceleration properties from JSON config file.
*
* \param[IN] nvme_conf JSON config file path
* \param[in] nvme_conf JSON config file path
*
* \returns Zero on success, negative on failure (DER)
*/
Expand Down Expand Up @@ -894,9 +894,9 @@ bio_read_accel_props(const char *nvme_conf)
/**
* Set output parameters based on JSON config settings for option SPDK JSON-RPC server.
*
* \param[IN] nvme_conf JSON config file path
* \param[OUT] enable Flag to enable the RPC server
* \param[OUT] sock_addr Path in which to create socket file
* \param[in] nvme_conf JSON config file path
* \param[out] enable Flag to enable the RPC server
* \param[out] sock_addr Path in which to create socket file
*
* \returns Zero on success, negative on failure (DER)
*/
Expand Down
7 changes: 3 additions & 4 deletions src/cart/crt_group.c
Original file line number Diff line number Diff line change
Expand Up @@ -1180,12 +1180,11 @@ crt_grp_priv_destroy(struct crt_grp_priv *grp_priv)
}

/**
* Validates an input group id string. Checks both length and for presence of
* invalid characters.
* Validates an input group id string. Checks both length and for presence of invalid characters.
*
* \param grpid [IN] unique group ID.
* \param[in] grpid unique group ID.
*
* \return zero if grpid is valid, -DER_INVAL otherwise
* \return zero if grpid is valid, -DER_INVAL otherwise
*/
int
crt_validate_grpid(const crt_group_id_t grpid) {
Expand Down
Loading