ref: cea72f68780d2770d2407681ce1ee077ca31909e
parent: 223a8ee32c6fe93c2ecd2636e9c49fa618cc1759
author: Matthew Wang <mjw7@princeton.edu>
date: Fri Mar 6 11:26:46 EST 2020
basic structure for example docs
binary files a/.DS_Store b/.DS_Store differ
--- a/Doxyfile
+++ b/Doxyfile
@@ -524,7 +524,7 @@
# section is generated. This option has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
-HIDE_UNDOC_MEMBERS = NO
+HIDE_UNDOC_MEMBERS = YES
# If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
# undocumented classes that are normally visible in the class hierarchy. If set
@@ -532,7 +532,7 @@
# has no effect if EXTRACT_ALL is enabled.
# The default value is: NO.
-HIDE_UNDOC_CLASSES = NO
+HIDE_UNDOC_CLASSES = YES
# If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
# (class|struct|union) declarations. If set to NO, these declarations will be
@@ -608,7 +608,7 @@
# name. If set to NO, the members will appear in declaration order.
# The default value is: YES.
-SORT_MEMBER_DOCS = YES
+SORT_MEMBER_DOCS = NO
# If the SORT_BRIEF_DOCS tag is set to YES then doxygen will sort the brief
# descriptions of file, namespace and class members alphabetically by member
@@ -829,7 +829,7 @@
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
-INPUT = /Users/Matthew/Desktop/PrincetonL/LEAF/LEAF/Src
+INPUT = LEAF
# 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
--- /dev/null
+++ b/Examples/basic-oscillators.c
@@ -1,0 +1,36 @@
+/*
+ ==============================================================================
+
+ basic-oscillators.c
+ Created: 5 Mar 2020 2:56:24pm
+ Author: Matthew Wang
+
+ ==============================================================================
+*/
+
+#include "basic-oscillators.c"
+
+void exampleInit()
+{
+ LEAF_init(44100, 64, mempool, 1000, &exampleRandom);
+
+ tCycle_init(&cycle);
+ tCycle_setFreq(&cycle, 220);
+}
+
+void exampleFrame()
+{
+
+}
+
+float exampleTick(float sampleIn)
+{
+ float sampleOut = tCycle_tick(&cycle);
+ return sampleOut;
+}
+
+float exampleRandom()
+{
+ return ((float)rand()/(float)(RAND_MAX));
+}
+
--- /dev/null
+++ b/Examples/basic-oscillators.h
@@ -1,0 +1,22 @@
+/*
+ ==============================================================================
+
+ basic-oscillators.h
+ Created: 5 Mar 2020 2:56:24pm
+ Author: Matthew Wang
+
+ ==============================================================================
+*/
+
+#include "../LEAF/leaf.h"
+
+char mempool[1000];
+tCycle cycle;
+
+void exampleInit(void);
+
+void exampleFrame(void);
+
+float exampleTick(float sampleIn);
+
+float exampleRandom(void);
--- a/LEAF/Inc/leaf-oscillators.h
+++ b/LEAF/Inc/leaf-oscillators.h
@@ -18,14 +18,21 @@
#include "leaf-filters.h"
/*!
- * @defgroup OSCILLATORS Oscillators
+ * Header.
+ * @include basic-oscillators.h
+ * @example basic-oscillators.c
+ * An example.
*/
+ /*!
+ * @defgroup oscillators Oscillators
+ */
+
//==============================================================================
/*!
- * @ingroup OSCILLATORS
- * @defgroup TCYCLE tCycle
+ * @ingroup oscillators
+ * @defgroup tcycle tCycle
* A cycle/sine waveform oscillator. Uses wavetable synthesis.
* @{
*/
@@ -90,8 +97,8 @@
//==============================================================================
/*!
- * @ingroup OSCILLATORS
- * @defgroup TTRIANGLE tTriangle
+ * @ingroup oscillators
+ * @defgroup ttriangle tTriangle
* An anti-aliased triangle waveform oscillator. Uses wavetable synthesis.
* @{
*/
@@ -157,8 +164,8 @@
//==============================================================================
/*!
- * @ingroup OSCILLATORS
- * @defgroup TSQUARE tSquare
+ * @ingroup oscillators
+ * @defgroup tsquare tSquare
* An anti-aliased square waveform oscillator. Uses wavetable synthesis.
* @{
*/
--- a/LEAF/leaf.h
+++ b/LEAF/leaf.h
@@ -61,6 +61,19 @@
#endif
+/*! \mainpage LEAF
+ *
+ * \section intro_sec Introduction
+ *
+ * This is the introduction.
+ *
+ * \section install_sec Installation
+ *
+ * \subsection step1 Step 1: Opening the box
+ *
+ * etc...
+ */
+
#ifdef __cplusplus
extern "C" {
#endif
binary files a/LEAF_JUCEPlugin/.DS_Store b/LEAF_JUCEPlugin/.DS_Store differ
--- a/LEAF_JUCEPlugin/LEAF.jucer
+++ b/LEAF_JUCEPlugin/LEAF.jucer
@@ -13,6 +13,12 @@
buildStandalone="1" enableIAA="0" cppLanguageStandard="11" companyCopyright="Princeton University"
pluginFormats="buildAU,buildStandalone" pluginCharacteristicsValue="pluginWantsMidiIn">
<MAINGROUP id="F7Bywq" name="LEAF">
+ <GROUP id="{F7096CF4-1A84-4CC8-A236-06FAE894451E}" name="Examples">
+ <FILE id="hMMOsl" name="basic-oscillators.c" compile="0" resource="0"
+ file="../Examples/basic-oscillators.c"/>
+ <FILE id="mVSe2h" name="basic-oscillators.h" compile="0" resource="0"
+ file="../Examples/basic-oscillators.h"/>
+ </GROUP>
<GROUP id="{14C5E2CD-5D51-3FD3-5677-28BECA29E95E}" name="Source">
<GROUP id="{C9F79DF0-2C57-F2B0-7B1B-78A14937E038}" name="LEAF">
<GROUP id="{B591B686-9726-94F1-28CD-B08349461C76}" name="Externals">