Update docs and fix bugs (#149)

Improved the docs for the 3 main Tactility projects. I also fixed some inaccuracies and bugs in certain APIs as I went through the code.
This commit is contained in:
Ken Van Hoeylandt
2025-01-07 20:45:23 +01:00
committed by GitHub
parent ff4287e2ce
commit 415096c3b2
62 changed files with 503 additions and 517 deletions
+3 -2
View File
@@ -36,7 +36,8 @@ public:
~MessageQueue();
/** Put message into queue
/** Post a message to the queue.
* The message is queued by copy, not by reference.
* @param[in] message A pointer to a message. The message will be copied into a buffer.
* @param[in] timeoutTicks
* @return success result
@@ -44,7 +45,7 @@ public:
bool put(const void* message, uint32_t timeoutTicks);
/** Get message from queue
* @param message A pointer to an already allocated message object
* @param[out] message A pointer to an already allocated message object
* @param[in] timeoutTicks
* @return success result
*/