From 3110c08277c743bb9ada3e99f3934a7fd69019f2 Mon Sep 17 00:00:00 2001 From: jpascualsana <52431518+jpascualsana@users.noreply.github.com> Date: Tue, 2 Jul 2019 13:26:20 -0500 Subject: [PATCH] Add @brief and [out] missing parameter #1591 --- libretroshare/src/retroshare/rsfiles.h | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/libretroshare/src/retroshare/rsfiles.h b/libretroshare/src/retroshare/rsfiles.h index e1661d8df..91102d0f1 100644 --- a/libretroshare/src/retroshare/rsfiles.h +++ b/libretroshare/src/retroshare/rsfiles.h @@ -208,7 +208,7 @@ public: virtual ~RsFiles() {} /** - * Provides file data for the gui, media streaming or rpc clients. + * @brief Provides file data for the gui, media streaming or rpc clients. * It may return unverified chunks. This allows streaming without having to * wait for hashes or completion of the file. * This function returns an unspecified amount of bytes. Either as much data @@ -224,7 +224,7 @@ public: * @param[in] offset where the desired block starts * @param[inout] requested_size size of pre-allocated data. Will be updated * by the function. - * @param data pre-allocated memory chunk of size 'requested_size' by the + * @param[out] data pre-allocated memory chunk of size 'requested_size' by the * client * @return Returns false in case * - the files is not available on the local node