Git-Mirrors/RetroShare
1
0
Fork 0
mirror of https://github.com/RetroShare/RetroShare.git synced 2025-01-14 08:59:50 -05:00
Code Issues Actions Packages Projects Releases Wiki Activity

Add @brief and [out] missing parameter #1591

Browse Source
This commit is contained in:
jpascualsana 2019-07-02 13:26:20 -05:00 committed by GitHub
parent 10eeb818c8
commit 3110c08277
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
libretroshare/src/retroshare/rsfiles.h
View File

@ -208,7 +208,7 @@ public:
virtual ~RsFiles() {} 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 * It may return unverified chunks. This allows streaming without having to
* wait for hashes or completion of the file. * wait for hashes or completion of the file.
* This function returns an unspecified amount of bytes. Either as much data * 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[in] offset where the desired block starts
* @param[inout] requested_size size of pre-allocated data. Will be updated * @param[inout] requested_size size of pre-allocated data. Will be updated
* by the function. * 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 * client
* @return Returns false in case * @return Returns false in case
* - the files is not available on the local node * - the files is not available on the local node