From d100e53470c37a502b7b61827101117b514a267d Mon Sep 17 00:00:00 2001 From: b1rdG <61605133+b1rdG@users.noreply.github.com> Date: Fri, 17 Apr 2020 22:09:40 +0000 Subject: [PATCH] Improve parameter description --- libretroshare/src/retroshare/rsmsgs.h | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/libretroshare/src/retroshare/rsmsgs.h b/libretroshare/src/retroshare/rsmsgs.h index be00c0d5c..8ddba2d1c 100644 --- a/libretroshare/src/retroshare/rsmsgs.h +++ b/libretroshare/src/retroshare/rsmsgs.h @@ -991,11 +991,11 @@ virtual void getOwnAvatarData(unsigned char *& data,int& size) = 0 ; /** * @brief initiateDistantChatConnexion initiate a connexion for a distant chat * @jsonapi{development} - * @param[in] to_pid distant chat id - * @param[in] from_pid distant chat id + * @param[in] to_pid RsGxsId to start the connection + * @param[in] from_pid owned RsGxsId who start the connection * @param[out] pid distant chat id - * @param[out] error_code distant chat info - * @param[in] notify distant chat info + * @param[out] error_code if the connection can't be stablished + * @param[in] notify notify remote that the connection is stablished * @return true on success */ virtual bool initiateDistantChatConnexion( @@ -1015,7 +1015,7 @@ virtual void getOwnAvatarData(unsigned char *& data,int& size) = 0 ; /** * @brief closeDistantChatConnexion * @jsonapi{development} - * @param[in] pid distant chat id + * @param[in] pid distant chat id to close the connection * @return true on success */ virtual bool closeDistantChatConnexion(const DistantChatPeerId& pid)=0;