diff --git a/doc/Doxyfile b/doc/Doxyfile index 2aea847..0fc7659 100644 --- a/doc/Doxyfile +++ b/doc/Doxyfile @@ -31,7 +31,7 @@ PROJECT_NAME = "Arduino MIDI Library" # This could be handy for archiving the generated documentation or # 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 # for a project that appears at the top of each page and should give viewer diff --git a/doc/midi_DoxygenMainPage.h b/doc/midi_DoxygenMainPage.h new file mode 100644 index 0000000..421d1f2 --- /dev/null +++ b/doc/midi_DoxygenMainPage.h @@ -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 + + 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. + + \n + */ + diff --git a/src/midi_Settings.h b/src/midi_Settings.h index 217402a..debb00f 100644 --- a/src/midi_Settings.h +++ b/src/midi_Settings.h @@ -2,7 +2,7 @@ * @file midi_Settings.h * Project Arduino MIDI Library * @brief MIDI Library for the Arduino - Settings - * @version 3.5 + * @version 4.0 * @author Francois Best * @date 24/02/11 * license GPL Forty Seven Effects - 2011