aboutsummaryrefslogtreecommitdiff
path: root/lib/csapi/typing.h
diff options
context:
space:
mode:
Diffstat (limited to 'lib/csapi/typing.h')
-rw-r--r--lib/csapi/typing.h8
1 files changed, 4 insertions, 4 deletions
diff --git a/lib/csapi/typing.h b/lib/csapi/typing.h
index dbf17a3e..f5b67baf 100644
--- a/lib/csapi/typing.h
+++ b/lib/csapi/typing.h
@@ -4,14 +4,10 @@
#pragma once
-#include "converters.h"
-
#include "jobs/basejob.h"
namespace Quotient {
-// Operations
-
/*! \brief Informs the server that the user has started or stopped typing.
*
* This tells the server that the user is typing for the next N
@@ -23,13 +19,17 @@ class SetTypingJob : public BaseJob {
public:
/*! \brief Informs the server that the user has started or stopped typing.
*
+ *
* \param userId
* The user who has started to type.
+ *
* \param roomId
* The room in which the user is typing.
+ *
* \param typing
* Whether the user is typing or not. If ``false``, the ``timeout``
* key can be omitted.
+ *
* \param timeout
* The length of time in milliseconds to mark this user as typing.
*/