diff examples/basic/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 1feb9c23ac57
children 9dc5a0ccad25
line wrap: on
line diff
--- a/examples/basic/render.cpp	Thu Jun 09 17:31:44 2016 +0100
+++ b/examples/basic/render.cpp	Thu Jun 09 18:16:05 2016 +0100
@@ -1,3 +1,12 @@
+/*
+ ____  _____ _        _    
+| __ )| ____| |      / \   
+|  _ \|  _| | |     / _ \  
+| |_) | |___| |___ / ___ \ 
+|____/|_____|_____/_/   \_\.io
+
+ */
+
 /*
  * render.cpp
  *
@@ -5,6 +14,23 @@
  *      Author: parallels
  */
 
+/**
+\example 1_basic_helloworld
+
+Producing your first bleep!
+---------------------------
+
+This sketch is the hello world of embedded interactive audio. Better known as bleep, it 
+produces a sine tone.
+
+The frequency of the sine tone is determined by a global variable, `gFrequency` 
+(line 12). The sine tone is produced by incrementing the phase of a sin function 
+on every audio frame.
+
+In render() you'll see a nested for loop structure. You'll see this in all Bela projects. 
+The first for loop cycles through 'audioFrames', the second through 'audioChannels' (in this case left 0 and right 1). 
+It is good to familiarise yourself with this structure as it's fundamental to producing sound with the system.
+*/
 
 #include <Bela.h>
 #include <cmath>