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
This commit is contained in:
parent
f0932a8716
commit
7c9d5ace14
41 changed files with 1892 additions and 97 deletions
|
@ -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("{ ");
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue