Git-Mirrors/RetroShare
1
0
Fork 0
mirror of https://github.com/RetroShare/RetroShare.git synced 2025-05-02 06:06:10 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve documentation

Browse source
This commit is contained in:
Gioacchino Mazzurco 2018-08-26 11:39:26 +02:00
parent 8fd903ac90
commit 1dfe64443f
No known key found for this signature in database
GPG key ID: A1FBCA3872E87051
2 changed files with 6 additions and 5 deletions
Download patch file Download diff file Expand all files Collapse all files

9
libretroshare/src/retroshare/rsinit.h
View file

@ -247,15 +247,16 @@ struct RsLoginHelper
void getLocations(std::vector<RsLoginHelper::Location>& locations);
/**
* @brief Creates a new RetroShare location
* @brief Creates a new RetroShare location, and log in once is created
* @jsonapi{development}
* @param[inout] location provide input information to generate the location
* and storage to output the data of the generated location
* @param[in] password to protect and unlock the associated PGP key
* @param[in] makeHidden pass true to create an hidden location
* @param[in] makeHidden pass true to create an hidden location. UNTESTED!
* @param[in] makeAutoTor pass true to create an automatically configured
* Tor hidden location
* @param[out] errorMessage
* Tor hidden location. UNTESTED!
* @param[out] errorMessage if some error occurred human readable error
* message
* @return true if success, false otherwise
*/
bool createLocation( RsLoginHelper::Location& location,