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.h13
1 files changed, 6 insertions, 7 deletions
diff --git a/lib/csapi/typing.h b/lib/csapi/typing.h
index 350c209d..dbf17a3e 100644
--- a/lib/csapi/typing.h
+++ b/lib/csapi/typing.h
@@ -8,22 +8,21 @@
#include "jobs/basejob.h"
-namespace Quotient
-{
+namespace Quotient {
// Operations
-/// Informs the server that the user has started or stopped typing.
-/*!
+/*! \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
* milliseconds where N is the value specified in the ``timeout`` key.
* Alternatively, if ``typing`` is ``false``, it tells the server that the
* user has stopped typing.
*/
-class SetTypingJob : public BaseJob
-{
+class SetTypingJob : public BaseJob {
public:
- /*! Informs the server that the user has started or stopped typing.
+ /*! \brief Informs the server that the user has started or stopped typing.
+ *
* \param userId
* The user who has started to type.
* \param roomId