Add all examples to Doxygen

docs/Doxyfile

@@ -310,7 +310,7 @@ OPTIMIZE_OUTPUT_SLICE  = NO
 #
 # Note see also the list of default file extension mappings.
 
-EXTENSION_MAPPING      =
+EXTENSION_MAPPING      = ino=c
 
 # If the MARKDOWN_SUPPORT tag is enabled then doxygen pre-processes all comments
 # according to the Markdown format, which allows for more readable
@@ -865,6 +865,7 @@ WARN_LOGFILE           =
 # Note: If this tag is empty the current directory is searched.
 
 INPUT                  = ../src \
+                         ../examples \
                          ../README.md
 
 # This tag can be used to specify the character encoding of the source files
@@ -894,7 +895,52 @@ INPUT_ENCODING         = UTF-8
 # comment), *.py, *.pyw, *.f90, *.f95, *.f03, *.f08, *.f18, *.f, *.for, *.vhd,
 # *.vhdl, *.ucf, *.qsf and *.ice.
 
-FILE_PATTERNS          =
+FILE_PATTERNS          = *.c \
+                         *.cc \
+                         *.cxx \
+                         *.cpp \
+                         *.c++ \
+                         *.java \
+                         *.ii \
+                         *.ixx \
+                         *.ipp \
+                         *.i++ \
+                         *.inl \
+                         *.idl \
+                         *.ddl \
+                         *.odl \
+                         *.h \
+                         *.hh \
+                         *.hxx \
+                         *.hpp \
+                         *.h++ \
+                         *.cs \
+                         *.d \
+                         *.php \
+                         *.php4 \
+                         *.php5 \
+                         *.phtml \
+                         *.inc \
+                         *.m \
+                         *.markdown \
+                         *.md \
+                         *.mm \
+                         *.dox \
+                         *.py \
+                         *.pyw \
+                         *.f90 \
+                         *.f95 \
+                         *.f03 \
+                         *.f08 \
+                         *.f18 \
+                         *.f \
+                         *.for \
+                         *.vhd \
+                         *.vhdl \
+                         *.ucf \
+                         *.qsf \
+                         *.ice \
+                         *.ino
 
 # The RECURSIVE tag can be used to specify whether or not subdirectories should
 # be searched for input files as well.
@@ -942,14 +988,14 @@ EXCLUDE_SYMBOLS        =
 # that contain example code fragments that are included (see the \include
 # command).
 
-EXAMPLE_PATH           =
+EXAMPLE_PATH           = ../examples
 
 # If the value of the EXAMPLE_PATH tag contains directories, you can use the
 # EXAMPLE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp and
 # *.h) to filter out the source-files in the directories. If left blank all
 # files are included.
 
-EXAMPLE_PATTERNS       =
+EXAMPLE_PATTERNS       = *.ino
 
 # If the EXAMPLE_RECURSIVE tag is set to YES then subdirectories will be
 # searched for input files to be used with the \include or \dontinclude commands

examples/AnalogOutput/AnalogOutput.ino

@@ -1,3 +1,7 @@
+/// @file    AnalogOutput.ino
+/// @brief   Demonstrates how to use FastLED color functions even without a "pixel-addressible" smart LED strip.
+/// @example AnalogOutput.ino
+
 #include <FastLED.h>
 
 // Example showing how to use FastLED color functions

examples/Blink/Blink.ino

@@ -1,3 +1,7 @@
+/// @file    Blink.ino
+/// @brief   Blink the first LED of an LED strip
+/// @example Blink.ino
+
 #include <FastLED.h>
 
 // How many leds in your strip?

examples/ColorPalette/ColorPalette.ino

@@ -1,3 +1,7 @@
+/// @file    ColorPalette.ino
+/// @brief   Demonstrates how to use @ref ColorPalettes
+/// @example ColorPalette.ino
+
 #include <FastLED.h>
 
 #define LED_PIN     5

examples/ColorTemperature/ColorTemperature.ino

@@ -1,3 +1,7 @@
+/// @file    ColorTemperature.ino
+/// @brief   Demonstrates how to use @ref ColorTemperature based color correction
+/// @example ColorTemperature.ino
+
 #include <FastLED.h>
 
 #define LED_PIN     3
@@ -11,7 +15,7 @@ CRGB leds[NUM_LEDS];
 #define BRIGHTNESS  128
 
 
-// FastLED v2.1 provides two color-management controls:
+// FastLED provides two color-management controls:
 //   (1) color correction settings for each LED strip, and
 //   (2) master control of the overall output 'color temperature' 
 //

examples/Cylon/Cylon.ino

@@ -1,3 +1,7 @@
+/// @file    Cylon.ino
+/// @brief   An animation that moves a single LED back and forth (Larson Scanner effect)
+/// @example Cylon.ino
+
 #include <FastLED.h>
 
 // How many leds in your strip?

examples/DemoReel100/DemoReel100.ino

@@ -1,3 +1,7 @@
+/// @file    DemoReel100.ino
+/// @brief   FastLED "100 lines of code" demo reel, showing off some effects
+/// @example DemoReel100.ino
+
 #include <FastLED.h>
 
 FASTLED_USING_NAMESPACE

examples/Fire2012/Fire2012.ino

@@ -1,3 +1,7 @@
+/// @file    Fire2012.ino
+/// @brief   Simple one-dimensional fire animation
+/// @example Fire2012.ino
+
 #include <FastLED.h>
 
 #define LED_PIN     5

examples/Fire2012WithPalette/Fire2012WithPalette.ino

@@ -1,3 +1,7 @@
+/// @file    Fire2012WithPalette.ino
+/// @brief   Simple one-dimensional fire animation with a programmable color palette
+/// @example Fire2012WithPalette.ino
+
 #include <FastLED.h>
 
 #define LED_PIN     5

examples/FirstLight/FirstLight.ino

@@ -1,3 +1,7 @@
+/// @file    FirstLight.ino
+/// @brief   Animate a white dot moving along a strip of LEDs
+/// @example FirstLight.ino
+
 // Use if you want to force the software SPI subsystem to be used for some reason (generally, you don't)
 // #define FASTLED_FORCE_SOFTWARE_SPI
 // Use if you want to force non-accelerated pin access (hint: you really don't, it breaks lots of things)

examples/Multiple/ArrayOfLedArrays/ArrayOfLedArrays.ino

@@ -1,3 +1,7 @@
+/// @file    ArrayOfLedArrays.ino
+/// @brief   Set up three LED strips, all running from an array of arrays
+/// @example ArrayOfLedArrays.ino
+
 // ArrayOfLedArrays - see https://github.com/FastLED/FastLED/wiki/Multiple-Controller-Examples for more info on
 // using multiple controllers.  In this example, we're going to set up three NEOPIXEL strips on three
 // different pins, each strip getting its own CRGB array to be played with, only this time they're going

examples/Multiple/MirroringSample/MirroringSample.ino

@@ -1,3 +1,7 @@
+/// @file    MirroringSample.ino
+/// @brief   Demonstrates how to use multiple LED strips, each with the same data
+/// @example MirroringSample.ino
+
 // MirroringSample - see https://github.com/FastLED/FastLED/wiki/Multiple-Controller-Examples for more info on
 // using multiple controllers.  In this example, we're going to set up four NEOPIXEL strips on four
 // different pins, and show the same thing on all four of them, a simple bouncing dot/cyclon type pattern

examples/Multiple/MultiArrays/MultiArrays.ino

@@ -1,3 +1,7 @@
+/// @file    MultiArrays.ino
+/// @brief   Demonstrates how to use multiple LED strips, each with their own data
+/// @example MultiArrays.ino
+
 // MultiArrays - see https://github.com/FastLED/FastLED/wiki/Multiple-Controller-Examples for more info on
 // using multiple controllers.  In this example, we're going to set up three NEOPIXEL strips on three
 // different pins, each strip getting its own CRGB array to be played with

examples/Multiple/MultipleStripsInOneArray/MultipleStripsInOneArray.ino

@@ -1,3 +1,7 @@
+/// @file    MultipleStripsInOneArray.ino
+/// @brief   Demonstrates how to use multiple LED strips, each with their own data in one shared array
+/// @example MultipleStripsInOneArray.ino
+
 // MultipleStripsInOneArray - see https://github.com/FastLED/FastLED/wiki/Multiple-Controller-Examples for more info on
 // using multiple controllers.  In this example, we're going to set up four NEOPIXEL strips on three
 // different pins, each strip will be referring to a different part of the single led array

examples/Multiple/OctoWS2811Demo/OctoWS2811Demo.ino

@@ -1,3 +1,7 @@
+/// @file    OctoWS2811Demo.ino
+/// @brief   Demonstrates how to use OctoWS2811 output
+/// @example OctoWS2811Demo.ino
+
 #define USE_OCTOWS2811
 #include <OctoWS2811.h>
 #include <FastLED.h>

examples/Multiple/ParallelOutputDemo/ParallelOutputDemo.ino

@@ -1,3 +1,7 @@
+/// @file    ParallelOutputDemo.ino
+/// @brief   Demonstrates how to write to multiple strips simultaneously
+/// @example ParallelOutputDemo.ino
+
 #include <FastLED.h>
 
 #define NUM_LEDS_PER_STRIP 16

examples/Noise/Noise.ino

@@ -1,3 +1,7 @@
+/// @file    Noise.ino
+/// @brief   Demonstrates how to use noise generation on a 2D LED matrix
+/// @example Noise.ino
+
 #include <FastLED.h>
 
 //

examples/NoisePlayground/NoisePlayground.ino

@@ -1,3 +1,7 @@
+/// @file    NoisePlayground.ino
+/// @brief   Demonstrates how to use noise generation on a 2D LED matrix
+/// @example NoisePlayground.ino
+
 #include <FastLED.h>
 
 // Params for width and height

examples/NoisePlusPalette/NoisePlusPalette.ino

@@ -1,3 +1,7 @@
+/// @file    NoisePlusPalette.ino
+/// @brief   Demonstrates how to mix noise generation with color palettes on a 2D LED matrix
+/// @example NoisePlusPalette.ino
+
 #include <FastLED.h>
 
 #define LED_PIN     3

examples/Pacifica/Pacifica.ino

@@ -1,3 +1,7 @@
+/// @file    Pacifica.ino
+/// @brief   Gentle, blue-green ocean wave animation
+/// @example Pacifica.ino
+
 //
 //  "Pacifica"
 //  Gentle, blue-green ocean waves.

examples/Pintest/Pintest.ino

@@ -1,3 +1,6 @@
+/// @file    Pintest.ino
+/// @brief   Checks available pin outputs (for debugging)
+/// @example Pintest.ino
 
 #include <FastLED.h>
 

examples/Ports/PJRCSpectrumAnalyzer/PJRCSpectrumAnalyzer.ino

@@ -1,3 +1,7 @@
+/// @file    PJRCSpectrumAnalyzer.ino
+/// @brief   Creates an impressive LED light show to music input on the Teensy
+/// @example PJRCSpectrumAnalyzer.ino
+
 // LED Audio Spectrum Analyzer Display
 //
 // Creates an impressive LED light show to music input

examples/Pride2015/Pride2015.ino

@@ -1,3 +1,7 @@
+/// @file    Pride2015.ino
+/// @brief   Animated, ever-changing rainbows.
+/// @example Pride2015.ino
+
 #include "FastLED.h"
 
 // Pride2015

examples/RGBCalibrate/RGBCalibrate.ino

@@ -1,3 +1,7 @@
+/// @file    RGBCalibrate.ino
+/// @brief   Use this to determine what the RGB ordering for your LEDs should be
+/// @example RGBCalibrate.ino
+
 #include "FastLED.h"
 
 

examples/RGBSetDemo/RGBSetDemo.ino

@@ -1,3 +1,7 @@
+/// @file    RGBSetDemo.ino
+/// @brief   Demonstrates how to create an LED group with CRGBArray
+/// @example RGBSetDemo.ino
+
 #include <FastLED.h>
 #define NUM_LEDS 40
 

examples/SmartMatrix/SmartMatrix.ino

@@ -1,3 +1,7 @@
+/// @file    SmartMatrix.ino
+/// @brief   Demonstrates how to use FastLED with the SmartMatrix library
+/// @example SmartMatrix.ino
+
 #include <SmartMatrix.h>
 #include <FastLED.h>
 

examples/TwinkleFox/TwinkleFox.ino

@@ -1,3 +1,7 @@
+/// @file    TwinkleFox.ino
+/// @brief   Twinkling "holiday" lights that fade in and out.
+/// @example TwinkleFox.ino
+
 #include "FastLED.h"
 
 

examples/XYMatrix/XYMatrix.ino

@@ -1,3 +1,7 @@
+/// @file    XYMatrix.ino
+/// @brief   Demonstrates how to use an XY position helper function with a 2D matrix
+/// @example XYMatrix.ino
+
 #include <FastLED.h>
 
 #define LED_PIN  3