aboutsummaryrefslogtreecommitdiff
path: root/docs/api_midi_device_setup_process.md
diff options
context:
space:
mode:
authorskullydazed <skullydazed@users.noreply.github.com>2018-03-21 23:50:38 -0700
committerJack Humbert <jack.humb@gmail.com>2018-03-22 02:50:38 -0400
commit7c9d5ace143d3cc6d767a354acde814926d566fd (patch)
tree1f2b581b6c9f6278a9e180bfcc8dd86b0a7fd2ef /docs/api_midi_device_setup_process.md
parentf0932a8716dc946322c5ebae7f75eaa275c6220c (diff)
downloadqmk_firmware-7c9d5ace143d3cc6d767a354acde814926d566fd.tar.gz
qmk_firmware-7c9d5ace143d3cc6d767a354acde814926d566fd.zip
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 'docs/api_midi_device_setup_process.md')
-rw-r--r--docs/api_midi_device_setup_process.md31
1 files changed, 31 insertions, 0 deletions
diff --git a/docs/api_midi_device_setup_process.md b/docs/api_midi_device_setup_process.md
new file mode 100644
index 000000000..ae82197c5
--- /dev/null
+++ b/docs/api_midi_device_setup_process.md
@@ -0,0 +1,31 @@
1# group `midi_device_setup_process` {#group__midi__device__setup__process}
2
3These are method that you must use to initialize and run a device.
4
5## Summary
6
7 Members | Descriptions
8--------------------------------|---------------------------------------------
9`public void `[`midi_device_init`](#group__midi__device__setup__process_1gaf29deddc94ea98a59daa0bde1aefd9d9)`(`[`MidiDevice`](#struct__midi__device)` * device)` | Initialize a device.
10`public void `[`midi_device_process`](#group__midi__device__setup__process_1gaa3d5993d0e998a1b59bbf5ab9c7b492b)`(`[`MidiDevice`](#struct__midi__device)` * device)` | Process input data.
11
12## Members
13
14#### `public void `[`midi_device_init`](#group__midi__device__setup__process_1gaf29deddc94ea98a59daa0bde1aefd9d9)`(`[`MidiDevice`](#struct__midi__device)` * device)` {#group__midi__device__setup__process_1gaf29deddc94ea98a59daa0bde1aefd9d9}
15
16Initialize a device.
17
18You must call this before using the device in question.
19
20#### Parameters
21* `device` the device to initialize
22
23#### `public void `[`midi_device_process`](#group__midi__device__setup__process_1gaa3d5993d0e998a1b59bbf5ab9c7b492b)`(`[`MidiDevice`](#struct__midi__device)` * device)` {#group__midi__device__setup__process_1gaa3d5993d0e998a1b59bbf5ab9c7b492b}
24
25Process input data.
26
27This method drives the input processing, you must call this method frequently if you expect to have your input callbacks called.
28
29#### Parameters
30* `device` the device to process
31