Doc.
This commit is contained in:
parent
6c66adc885
commit
389aa8a62e
|
|
@ -31,7 +31,7 @@ PROJECT_NAME = "Arduino MIDI Library"
|
||||||
# This could be handy for archiving the generated documentation or
|
# This could be handy for archiving the generated documentation or
|
||||||
# if some version control system is used.
|
# if some version control system is used.
|
||||||
|
|
||||||
PROJECT_NUMBER = "Version 3.2"
|
PROJECT_NUMBER = "Version 4.0"
|
||||||
|
|
||||||
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
# Using the PROJECT_BRIEF tag one can provide an optional one line description
|
||||||
# for a project that appears at the top of each page and should give viewer
|
# for a project that appears at the top of each page and should give viewer
|
||||||
|
|
|
||||||
|
|
@ -0,0 +1,42 @@
|
||||||
|
/*!
|
||||||
|
\mainpage Arduino MIDI Library
|
||||||
|
|
||||||
|
\tableofcontents
|
||||||
|
|
||||||
|
|
||||||
|
\page howtodoc How to use this documentation
|
||||||
|
|
||||||
|
You can browse the classes
|
||||||
|
|
||||||
|
\page howtolib How to use the library
|
||||||
|
|
||||||
|
\section howtolib_section_callbacks Using callbacks
|
||||||
|
|
||||||
|
Callbacks can simplify the reception of input messages.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
\page
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
// -----------------------------------------------------------------------------
|
||||||
|
// Examples
|
||||||
|
|
||||||
|
/*!
|
||||||
|
\example MIDI_Basic_IO.ino
|
||||||
|
This example shows how to perform simple input and output MIDI. \n
|
||||||
|
\n
|
||||||
|
When any message arrives to the Arduino, the LED is turned on,
|
||||||
|
then we send a Note On message, wait for a second, then send
|
||||||
|
the Note Off and turn off the LED.
|
||||||
|
\n
|
||||||
|
\n
|
||||||
|
<em>
|
||||||
|
Note that instead of sending a Note Off, we could have sent a
|
||||||
|
Note On with velocity 0 to shorten the message. This is called Running
|
||||||
|
Status.
|
||||||
|
</em>
|
||||||
|
\n
|
||||||
|
*/
|
||||||
|
|
||||||
|
|
@ -2,7 +2,7 @@
|
||||||
* @file midi_Settings.h
|
* @file midi_Settings.h
|
||||||
* Project Arduino MIDI Library
|
* Project Arduino MIDI Library
|
||||||
* @brief MIDI Library for the Arduino - Settings
|
* @brief MIDI Library for the Arduino - Settings
|
||||||
* @version 3.5
|
* @version 4.0
|
||||||
* @author Francois Best
|
* @author Francois Best
|
||||||
* @date 24/02/11
|
* @date 24/02/11
|
||||||
* license GPL Forty Seven Effects - 2011
|
* license GPL Forty Seven Effects - 2011
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue