Doc.

Author: Francois Best

doc/Doxyfile

@@ -12,8 +12,8 @@ cd "`dirname "${0}"`"
 root="${PWD}/.."
 build="$root/build/MIDI"
 
-echo root  $root
-echo build $build
+echo "root:  $root"
+echo "build: $build"
 
 # Create a temporary destination folder
 mkdir -p "$build"
@@ -34,3 +34,7 @@ cp -r * "$build/examples"
 # Generate package
 cd "$build/.."
 zip -r Arduino_MIDI_Library.zip MIDI
+
+# Generate doc
+cd "$root/doc"
+doxygen .

res/packaging.command

@@ -179,7 +179,6 @@ class MidiInterface
     inline void turnThruOff();
     inline void setThruFilterMode(MidiFilterMode inThruFilterMode);
 
-
 private:
     void thruFilter(byte inChannel);
 

src/MIDI.h

@@ -1,5 +1,5 @@
 /*!
- *  @file       midi_Inline.hpp
+ *  @file       MIDI.hpp
  *  Project     Arduino MIDI Library
  *  @brief      MIDI Library for the Arduino - Inline implementations
  *  @version    4.2
@@ -1201,6 +1201,4 @@ void MidiInterface<SerialPort, Settings>::thruFilter(Channel inChannel)
     }
 }
 
-// -----------------------------------------------------------------------------
-
 END_MIDI_NAMESPACE

src/MIDI.hpp

@@ -34,8 +34,6 @@ typedef uint8_t byte;
 
 BEGIN_MIDI_NAMESPACE
 
-// -----------------------------------------------------------------------------
-
 #define MIDI_CHANNEL_OMNI       0
 #define MIDI_CHANNEL_OFF        17 // and over
 

src/midi_Defs.h

@@ -27,16 +27,20 @@
 
 BEGIN_MIDI_NAMESPACE
 
-/*! \brief Default Settings Traits struct
+/*! \brief Default Settings for the MIDI Library.
+
  To change the default settings, don't edit them there, create a subclass and
  override the values in that subclass, then use the MIDI_CREATE_CUSTOM_INSTANCE
  macro to create your instance. The settings you don't override will keep their
  default value. Eg:
+ \code{.cpp}
  struct MySettings : public midi::DefaultSettings
  {
     static const bool UseRunningStatus = false; // Messes with my old equipment!
  };
+
  MIDI_CREATE_CUSTOM_INSTANCE(HardwareSerial, Serial2, midi, MySettings);
+ \endcode
  */
 struct DefaultSettings
 {