d/numam-spdk
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc: do not document void returns

Browse Source 
This patch enables WARN_NO_PARAMDOC in Doxygen and
resolves remaining issues.

Void return type does not require documentation.
Some of the removed docs were not even Doxygen type
comment, see lack of '\'.

Fixed errors were similar to below:
spdk/include/spdk/nvmf.h:1081: warning: documented empty return type of spdk_nvmf_tgt_add_transport

Signed-off-by: Tomasz Zawadzki <tomasz.zawadzki@intel.com>
Change-Id: I6bb282ead8dc918885f7a89ab8829e4f5c477247
Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/10387
Tested-by: SPDK CI Jenkins <sys_sgci@intel.com>
Community-CI: Broadcom CI <spdk-ci.pdl@broadcom.com>
Reviewed-by: Dong Yi <dongx.yi@intel.com>
Reviewed-by: Shuhei Matsumoto <shuhei.matsumoto.xt@hitachi.com>
Reviewed-by: Jim Harris <james.r.harris@intel.com>
Reviewed-by: Aleksey Marchuk <alexeymar@mellanox.com>
This commit is contained in:
Tomasz Zawadzki 2021-11-24 10:37:07 +01:00
parent 9ce2a8208e
commit 9e3ed3638d
3 changed files with 1 additions and 29 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
doc/Doxyfile
View File

@ -746,7 +746,7 @@ WARN_IF_DOC_ERROR = YES
# parameter documentation, but not about the absence of documentation.
# The default value is: NO.
WARN_NO_PARAMDOC = NO
WARN_NO_PARAMDOC = YES
# If the WARN_AS_ERROR tag is set to YES then doxygen will immediately stop when
# a warning is encountered.

25
include/spdk/blobfs.h
View File

@ -419,8 +419,6 @@ int spdk_file_get_id(struct spdk_file *file, void *id, size_t size);
* \param length The size in bytes of data to read.
* \param cb_fn Called when the request is complete.
* \param cb_arg Argument passed to cb_fn.
*
* \return None.
*/
void spdk_file_readv_async(struct spdk_file *file, struct spdk_io_channel *channel,
struct iovec *iovs, uint32_t iovcnt, uint64_t offset, uint64_t length,
@ -437,8 +435,6 @@ void spdk_file_readv_async(struct spdk_file *file, struct spdk_io_channel *chann
* \param length The size in bytes of data to write.
* \param cb_fn Called when the request is complete.
* \param cb_arg Argument passed to cb_fn.
*
* \return None.
*/
void spdk_file_writev_async(struct spdk_file *file, struct spdk_io_channel *channel,
struct iovec *iovs, uint32_t iovcnt, uint64_t offset, uint64_t length,
@ -451,8 +447,6 @@ void spdk_file_writev_async(struct spdk_file *file, struct spdk_io_channel *chan
* \param name The file name used to look up the matched file in the blobstore filesystem.
* \param cb_fn Called when the request is complete.
* \param cb_arg Argument passed to cb_fn.
*
* return None.
*/
void spdk_fs_file_stat_async(struct spdk_filesystem *fs, const char *name,
spdk_file_stat_op_complete cb_fn, void *cb_arg);
@ -464,8 +458,6 @@ void spdk_fs_file_stat_async(struct spdk_filesystem *fs, const char *name,
* \param name The file name for this new file.
* \param cb_fn Called when the request is complete.
* \param cb_arg Argument passed to cb_fn.
*
* return None.
*/
void spdk_fs_create_file_async(struct spdk_filesystem *fs, const char *name,
spdk_file_op_complete cb_fn, void *cb_arg);
@ -478,8 +470,6 @@ void spdk_fs_create_file_async(struct spdk_filesystem *fs, const char *name,
* \param flags This flags will be used to control the open mode.
* \param cb_fn Called when the request is complete.
* \param cb_arg Argument passed to cb_fn.
*
* return None.
*/
void spdk_fs_open_file_async(struct spdk_filesystem *fs, const char *name, uint32_t flags,
spdk_file_op_with_handle_complete cb_fn, void *cb_arg);
@ -490,8 +480,6 @@ void spdk_fs_open_file_async(struct spdk_filesystem *fs, const char *name, uint3
* \param file File to close.
* \param cb_fn Called when the request is complete.
* \param cb_arg Argument passed to cb_fn.
*
* return None.
*/
void spdk_file_close_async(struct spdk_file *file, spdk_file_op_complete cb_fn, void *cb_arg);
@ -507,8 +495,6 @@ void spdk_file_close_async(struct spdk_file *file, spdk_file_op_complete cb_fn,
* \param new_name New name of the file.
* \param cb_fn Called when the request is complete.
* \param cb_arg Argument passed to cb_fn.
*
* return None.
*/
void spdk_fs_rename_file_async(struct spdk_filesystem *fs, const char *old_name,
const char *new_name, spdk_fs_op_complete cb_fn,
@ -521,9 +507,6 @@ void spdk_fs_rename_file_async(struct spdk_filesystem *fs, const char *old_name,
* \param name The name of the file to be deleted.
* \param cb_fn Called when the request is complete.
* \param cb_arg Argument passed to cb_fn.
*
* return None.
*
*/
void spdk_fs_delete_file_async(struct spdk_filesystem *fs, const char *name,
spdk_file_op_complete cb_fn, void *cb_arg);
@ -535,8 +518,6 @@ void spdk_fs_delete_file_async(struct spdk_filesystem *fs, const char *name,
* \param length New size in bytes of the file.
* \param cb_fn Called when the request is complete.
* \param cb_arg Argument passed to cb_fn.
*
* return None.
*/
void spdk_file_truncate_async(struct spdk_file *file, uint64_t length,
spdk_file_op_complete cb_fn, void *cb_arg);
@ -551,8 +532,6 @@ void spdk_file_truncate_async(struct spdk_file *file, uint64_t length,
* \param length The size in bytes of data to write.
* \param cb_fn Called when the request is complete.
* \param cb_arg Argument passed to cb_fn.
*
* return None.
*/
void spdk_file_write_async(struct spdk_file *file, struct spdk_io_channel *channel,
void *payload, uint64_t offset, uint64_t length,
@ -568,8 +547,6 @@ void spdk_file_write_async(struct spdk_file *file, struct spdk_io_channel *chann
* \param length The size in bytes of data to read.
* \param cb_fn Called when the request is complete.
* \param cb_arg Argument passed to cb_fn.
*
* return None.
*/
void spdk_file_read_async(struct spdk_file *file, struct spdk_io_channel *channel,
void *payload, uint64_t offset, uint64_t length,
@ -586,8 +563,6 @@ void spdk_file_read_async(struct spdk_file *file, struct spdk_io_channel *channe
* \param channel I/O channel for asynchronous operations.
* \param cb_fn Called when the request is complete.
* \param cb_arg Argument passed to cb_fn.
*
* return None.
*/
void spdk_file_sync_async(struct spdk_file *file, struct spdk_io_channel *channel,
spdk_file_op_complete cb_fn, void *cb_arg);

3
include/spdk/nvmf.h
View File

@ -1074,9 +1074,6 @@ typedef void (*spdk_nvmf_tgt_add_transport_done_fn)(void *cb_arg, int status);
* \param transport The transport to add
* \param cb_fn A callback that will be called once the transport is created
* \param cb_arg A context argument passed to cb_fn.
*
* \return void. The callback status argument will be 0 on success
* or a negated errno on failure.
*/
void spdk_nvmf_tgt_add_transport(struct spdk_nvmf_tgt *tgt,
struct spdk_nvmf_transport *transport,