summaryrefslogtreecommitdiffstats
path: root/tmk_core/common/action_tapping.c
diff options
context:
space:
mode:
authorskullydazed <skullydazed@users.noreply.github.com>2018-03-22 07:50:38 +0100
committerJack Humbert <jack.humb@gmail.com>2018-03-22 07:50:38 +0100
commit7c9d5ace143d3cc6d767a354acde814926d566fd (patch)
tree1f2b581b6c9f6278a9e180bfcc8dd86b0a7fd2ef /tmk_core/common/action_tapping.c
parentf0932a8716dc946322c5ebae7f75eaa275c6220c (diff)
downloadqmk_firmware-7c9d5ace143d3cc6d767a354acde814926d566fd.tar.gz
qmk_firmware-7c9d5ace143d3cc6d767a354acde814926d566fd.tar.xz
Generate API docs from source code comments (#2491)
* Generate api docs from source code * Add a bunch of doxygen comments * more doxygen comments * Add the in-progress api docs * script to generate docs from travis * Add doc generation to the travis job * make travis_docs.sh commit the work it does * make sure the docs script exits cleanly
Diffstat (limited to 'tmk_core/common/action_tapping.c')
-rw-r--r--tmk_core/common/action_tapping.c37
1 files changed, 31 insertions, 6 deletions
diff --git a/tmk_core/common/action_tapping.c b/tmk_core/common/action_tapping.c
index 6280c6c36..8adf013e1 100644
--- a/tmk_core/common/action_tapping.c
+++ b/tmk_core/common/action_tapping.c
@@ -36,6 +36,10 @@ static void debug_tapping_key(void);
static void debug_waiting_buffer(void);
+/** \brief Action Tapping Process
+ *
+ * FIXME: Needs doc
+ */
void action_tapping_process(keyrecord_t record)
{
if (process_tapping(&record)) {
@@ -70,7 +74,7 @@ void action_tapping_process(keyrecord_t record)
}
-/* Tapping
+/** \brief Tapping
*
* Rule: Tap key is typed(pressed and released) within TAPPING_TERM.
* (without interfering by typing other key)
@@ -289,8 +293,9 @@ bool process_tapping(keyrecord_t *keyp)
}
-/*
- * Waiting buffer
+/** \brief Waiting buffer enq
+ *
+ * FIXME: Needs docs
*/
bool waiting_buffer_enq(keyrecord_t record)
{
@@ -310,12 +315,20 @@ bool waiting_buffer_enq(keyrecord_t record)
return true;
}
+/** \brief Waiting buffer clear
+ *
+ * FIXME: Needs docs
+ */
void waiting_buffer_clear(void)
{
waiting_buffer_head = 0;
waiting_buffer_tail = 0;
}
+/** \brief Waiting buffer typed
+ *
+ * FIXME: Needs docs
+ */
bool waiting_buffer_typed(keyevent_t event)
{
for (uint8_t i = waiting_buffer_tail; i != waiting_buffer_head; i = (i + 1) % WAITING_BUFFER_SIZE) {
@@ -326,6 +339,10 @@ bool waiting_buffer_typed(keyevent_t event)
return false;
}
+/** \brief Waiting buffer has anykey pressed
+ *
+ * FIXME: Needs docs
+ */
__attribute__((unused))
bool waiting_buffer_has_anykey_pressed(void)
{
@@ -335,7 +352,10 @@ bool waiting_buffer_has_anykey_pressed(void)
return false;
}
-/* scan buffer for tapping */
+/** \brief Scan buffer for tapping
+ *
+ * FIXME: Needs docs
+ */
void waiting_buffer_scan_tap(void)
{
// tapping already is settled
@@ -359,14 +379,19 @@ void waiting_buffer_scan_tap(void)
}
-/*
- * debug print
+/** \brief Tapping key debug print
+ *
+ * FIXME: Needs docs
*/
static void debug_tapping_key(void)
{
debug("TAPPING_KEY="); debug_record(tapping_key); debug("\n");
}
+/** \brief Waiting buffer debug print
+ *
+ * FIXME: Needs docs
+ */
static void debug_waiting_buffer(void)
{
debug("{ ");