diff --git a/README.md b/README.md index 5103630b..9150f793 100644 --- 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 index e8dfae7f..50573a79 100644 --- 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 index 6ed67deb..08d5bf72 100644 --- a/doxygen/header.html +++ b/doxygen/header.html @@ -17,16 +17,6 @@ $mathjax $extrastylesheet - - - -
@@ -37,11 +27,11 @@ - Logo + Foleys Logo - open foleysfinest.com -
$projectname +
$projectname  $projectnumber
$projectbrief
diff --git a/modules/foleys_gui_magic/General/foleys_MagicGUIBuilder.h b/modules/foleys_gui_magic/General/foleys_MagicGUIBuilder.h index e1ee3d69..15e318b2 100644 --- 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 tree. + Recreates all components from the `` 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 index 43aa8a11..7196f7d8 100644 --- 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 index 470b8ae1..bd64dea4 100644 --- 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 index c8a902af..cfd288cf 100644 --- 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::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::Ptr> coefficients, float maxDB);