Improve documentation

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

View file

@ -292,7 +292,7 @@ int main(int argc, char *argv[])
callbackParams = callbackParams.split('(')[1]; callbackParams = callbackParams.split('(')[1];
callbackParams = callbackParams.split(')')[0]; callbackParams = callbackParams.split(')')[0];
cbs += "RsGenericSerializer::SerializeContext ctx;\n"; cbs += "\t\t\tRsGenericSerializer::SerializeContext ctx;\n";
for (QString cbPar : callbackParams.split(',')) for (QString cbPar : callbackParams.split(','))
{ {

View file

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