changeset 524:9f455f01edd5 prerelease

Doxygen updates
author Robert Jack <robert.h.jack@gmail.com>
date Thu, 23 Jun 2016 10:19:24 +0100
parents 42f6af3a5f1d
children 1ca196e35105
files Doxyfile examples/03-Analog/analog-input/render.cpp
diffstat 2 files changed, 14 insertions(+), 8 deletions(-) [+]
line wrap: on
line diff
--- a/Doxyfile	Thu Jun 23 04:31:09 2016 +0100
+++ b/Doxyfile	Thu Jun 23 10:19:24 2016 +0100
@@ -771,8 +771,7 @@
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = include/ \
-                         examples/
+INPUT                  = include/ examples/
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -812,7 +811,7 @@
 # Note that relative paths are relative to the directory from which doxygen is
 # run.
 
-EXCLUDE                = include/ne10/ include/oscpkt.hh include/libpd include/prussdrv.h examples/10-Instruments/d-box/main.cpp
+EXCLUDE                = include/ne10/ include/oscpkt.hh include/libpd include/prussdrv.h examples/10-Instruments/
 
 # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
 # directories that are symbolic links (a Unix file system feature) are excluded
@@ -1893,7 +1892,7 @@
 # The default value is: YES.
 # This tag requires that the tag GENERATE_XML is set to YES.
 
-XML_PROGRAMLISTING     = YES
+XML_PROGRAMLISTING     = NO
 
 #---------------------------------------------------------------------------
 # Configuration options related to the DOCBOOK output
--- a/examples/03-Analog/analog-input/render.cpp	Thu Jun 23 04:31:09 2016 +0100
+++ b/examples/03-Analog/analog-input/render.cpp	Thu Jun 23 10:19:24 2016 +0100
@@ -101,10 +101,17 @@
 
 The important thing to notice is that audio is sampled twice as often as analog 
 data. The audio sampling rate is 44.1kHz (44100 frames per second) and the 
-analog sampling rate is 22.05kHz (22050 frames per second). On line 62 you might 
-notice that we are processing the analog data and updating frequency and 
-amplitude only on every second audio sample, since the analog sampling rate is 
-half that of the audio.
+analog sampling rate is 22.05kHz (22050 frames per second). Notice that we are 
+processing the analog data and updating frequency and amplitude only on every 
+second audio sample, since the analog sampling rate is half that of the audio.
+
+````
+if(!(n % gAudioFramesPerAnalogFrame)) {
+    // Even audio samples: update frequency and amplitude from the matrix
+    frequency = map(analogRead(context, n/gAudioFramesPerAnalogFrame, gSensorInputFrequency), 0, 1, 100, 1000);
+    amplitude = analogRead(context, n/gAudioFramesPerAnalogFrame, gSensorInputAmplitude);
+}
+````
 
 Note that the pin numbers are stored in the variables `gAnalogInputFrequency` and 
 `gAnalogInputAmplitude`. These are declared in the main.cpp file; if you look in