Fixed documentation

josmithiii · Oct 30, 2023 · a619fb7 · a619fb7
1 parent 42043fe
commit a619fb7
Show file tree

Hide file tree

Showing 7 changed files with 19 additions and 31 deletions.
diff --git a/README.md b/README.md
@@ -138,18 +138,18 @@ Currently available Components
 It is completely possible to register your own bespoke Components into the builder. These Components
 are already available:
 
-- Slider (attachable to parameters)
-- ComboBox ( -"- )
-- ToggleButton ( -"- )
-- TextButton ( -"- )
-- XYDragComponent (attachable to two parameters)
-- Plot (displays various 2-d data)
-- LevelMeter (displays different RMS / Max levels)
-- Label
-- MidiKeyboardComponent
-- MidiLearn
-- ListBox
-- WebBrowserComponent
+ - Slider (attachable to parameters)
+ - ComboBox (attachable to parameters)
+ - ToggleButton (attachable to parameters)
+ - TextButton (attachable to parameters)
+ - XYDragComponent (attachable to two parameters)
+ - Plot (displays various 2-d data)
+ - LevelMeter (displays different RMS / Max levels)
+ - Label
+ - MidiKeyboardComponent
+ - MidiLearn
+ - ListBox
+ - WebBrowserComponent
 
 All Components have the option to add margins/paddings and a border also with rounded corners.
 The View component serves as container, that has the option to layer all child components on top of each other

diff --git a/doxygen/Doxyfile b/doxygen/Doxyfile
@@ -1019,7 +1019,7 @@ 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

diff --git a/doxygen/header.html b/doxygen/header.html
@@ -17,16 +17,6 @@
 $mathjax
 <link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" />
 $extrastylesheet
-<!-- Global site tag (gtag.js) - Google Analytics -->
-<script async src="https://www.googletagmanager.com/gtag/js?id=UA-115384200-1"></script>
-<script>
-  window.dataLayer = window.dataLayer || [];
-  function gtag(){dataLayer.push(arguments);}
-  gtag('js', new Date());
-
-  gtag('config', 'UA-115384200-1');
-</script>
-<!-- END Global site tag - Google Analytics -->
 </head>
 <body>
 <div id="top"><!-- do not remove this div, it is closed by doxygen! -->
@@ -37,11 +27,11 @@
  <tbody>
  <tr style="height: 56px;">
   <!--BEGIN PROJECT_LOGO-->
-  <td id="projectlogo"><a href="https://foleysfinest.com"><img alt="Logo" src="$relpath^$projectlogo"/></a></td>
+  <td id="projectlogo"><a href="https://foleysfinest.com"><img alt="Foleys Logo - open foleysfinest.com" src="$relpath^$projectlogo"/></a></td>
   <!--END PROJECT_LOGO-->
   <!--BEGIN PROJECT_NAME-->
   <td id="projectalign" style="padding-left: 0.5em;">
-   <div id="projectname">$projectname
+   <div id="projectname"><a href="https://github.com/ffAudio/$projectname/">$projectname</a>
    <!--BEGIN PROJECT_NUMBER-->&#160;<span id="projectnumber">$projectnumber</span><!--END PROJECT_NUMBER-->
    </div>
    <!--BEGIN PROJECT_BRIEF--><div id="projectbrief">$projectbrief</div><!--END PROJECT_BRIEF-->

diff --git a/modules/foleys_gui_magic/General/foleys_MagicGUIBuilder.h b/modules/foleys_gui_magic/General/foleys_MagicGUIBuilder.h
@@ -100,7 +100,7 @@ class MagicGUIBuilder : public juce::ChangeListener,
     void updateStylesheet();
 
     /**
-     Recreates all components from the <View/> tree.
+     Recreates all components from the `<View/>` tree.
      If no div tree is found, createDefaultGUITree is called to give subclasses
      a chance to create a suitable default.
      */

diff --git a/modules/foleys_gui_magic/General/foleys_MagicPluginEditor.h b/modules/foleys_gui_magic/General/foleys_MagicPluginEditor.h
@@ -60,7 +60,7 @@ class MagicPluginEditor  : public juce::AudioProcessorEditor,
     /**
      Setup a GUI from a previously stored ValueTree
 
-     @param gui the ValueTree that defines the Stylesheet, colour palette and GUI components of the editor
+     @param config the ValueTree that defines the Stylesheet, colour palette and GUI components of the editor
      */
     void setConfigTree (const juce::ValueTree& config);
 

diff --git a/modules/foleys_gui_magic/Layout/foleys_Stylesheet.h b/modules/foleys_gui_magic/Layout/foleys_Stylesheet.h
@@ -73,8 +73,6 @@ class Stylesheet : private juce::ValueTree::Listener
 
     /**
      Read the style classes and connect variables
-
-     @param builder is the managed builder instance, so the style class can connect to the variables
      */
     void updateStyleClasses();
 
@@ -96,6 +94,8 @@ class Stylesheet : private juce::ValueTree::Listener
 
      @param name the name of the property.
      @param node is the node in the DOM. This is used for inheritance by traversing upwards.
+     @param inherit if this is true, it will impact child nodes as well
+     @param definedHere this is a hint for the editor where the property was actually set
      */
     juce::var getStyleProperty (const juce::Identifier& name, const juce::ValueTree& node, bool inherit=true, juce::ValueTree* definedHere=nullptr) const;
 

diff --git a/modules/foleys_gui_magic/Visualisers/foleys_MagicFilterPlot.h b/modules/foleys_gui_magic/Visualisers/foleys_MagicFilterPlot.h
@@ -53,7 +53,6 @@ class MagicFilterPlot : public MagicPlotSource
      Set new coefficients to calculate the frequency response from.
 
      @param coefficients the coefficients to calculate the frequency response for
-     @param sampleRate is the sampleRate the processing is happening with
      @param maxDB is the maximum level in dB, that the curve will display
      */
     void setIIRCoefficients (juce::dsp::IIR::Coefficients<float>::Ptr coefficients, float maxDB);
@@ -63,7 +62,6 @@ class MagicFilterPlot : public MagicPlotSource
 
      @param gain the overall added gain
      @param coefficients a vector of coefficients to sum up (multiply) to calculate the frequency response for
-     @param sampleRate is the sampleRate the processing is happening with
      @param maxDB is the maximum level in dB, that the curve will display
      */
     void setIIRCoefficients (float gain, std::vector<juce::dsp::IIR::Coefficients<float>::Ptr> coefficients, float maxDB);