diff examples/analogDigitalDemo/render.cpp @ 372:db2fe4e1b88e prerelease

Doxygen content added to each example render.cpp. References to AnalogReadFrame etc. removed from doxygen content.
author Robert Jack <robert.h.jack@gmail.com>
date Thu, 09 Jun 2016 18:16:05 +0100
parents 493a07f6ec09
children 9dc5a0ccad25
line wrap: on
line diff
--- a/examples/analogDigitalDemo/render.cpp	Thu Jun 09 17:31:44 2016 +0100
+++ b/examples/analogDigitalDemo/render.cpp	Thu Jun 09 18:16:05 2016 +0100
@@ -1,9 +1,34 @@
-    /*
+/*
+ ____  _____ _        _    
+| __ )| ____| |      / \   
+|  _ \|  _| | |     / _ \  
+| |_) | |___| |___ / ___ \ 
+|____/|_____|_____/_/   \_\.io
+
+ */
+
+/*
  *
  * Andrew McPherson and Victor Zappi
  * Queen Mary, University of London
  */
 
+/**
+\example 3_analogDigitalDemo
+
+Analog digital workout
+----------------------
+
+This sketch showcases many different ways to write and read digital pins, 
+including generating clocks and creating binary counters.
+
+The code as it is will not work properly, as the direction of the pins is not 
+set. As an exercise, you will need to set the pin mode before writing or reading 
+the digital pins. 
+
+This is for advanced users only.
+*/
+
 #include <Bela.h>
 #include <Utilities.h>
 #include <cmath>