Prepare for version 1.1.0 (#252)

* Prepare for version 1.1.0 * Update changelog * Re-add code that I mistakenly removed * Fix typos
Chowdhury-DSP · Jul 14, 2022 · dff4959 · dff4959
1 parent 9b0ffe3
commit dff4959
Show file tree

Hide file tree

Showing 26 changed files with 41 additions and 24 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -2,7 +2,7 @@
 
 All notable changes to this project will be documented in this file.
 
-## [UNRELEASED]
+## [1.1.0] 2022-07-14
 - Removed dependency on JUCE for most DSP modules.
 - Added extensions for building CLAP plugins with CLAP-specific behaviour.
 - Added improved State Variable Filter with more filter types.

diff --git a/doxygen/Doxyfile b/doxygen/Doxyfile
@@ -850,6 +850,9 @@ EXCLUDE                = ../docs/ \
                          ../bench/ \
                          ../cmake/ \
                          ../build/ \
+                         ../build-bench/ \
+                         ../build-codequal/ \
+                         ../build-examples/ \
                          ../tests/ \
                          ../.vscode/ \
                          ../.idea/ \
@@ -870,7 +873,8 @@ EXCLUDE_SYMLINKS       = YES
 # exclude all test directories for example use the pattern */test/*
 
 EXCLUDE_PATTERNS       = *chowdsp_BinaryData* \
-                         */third_party/*
+                         */third_party/* \
+                         */JUCEHelpers/*
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the

diff --git a/modules/common/chowdsp_core/Types/chowdsp_TypeTraits.h b/modules/common/chowdsp_core/Types/chowdsp_TypeTraits.h
@@ -6,7 +6,7 @@
  * Usage:
  * @code {.cpp}
  * CHOWDSP_CHECK_HAS_STATIC_METHOD(HasToString, toString)
- * static_assert(HasToString<MyClass>, "MyClass must have a static toStringMethod!");
+ * static_assert(HasToString<MyClass>, "MyClass must have a static toString method!");
  * @endcode
  */
 #define CHOWDSP_CHECK_HAS_STATIC_METHOD(Name, Method)                                                                                   \

diff --git a/modules/common/chowdsp_core/chowdsp_core.h b/modules/common/chowdsp_core/chowdsp_core.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_core
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP Core
    description:   Core code for other ChowDSP modules
    dependencies:

diff --git a/modules/common/chowdsp_json/chowdsp_json.h b/modules/common/chowdsp_json/chowdsp_json.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_json
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP JSON Utilities
    description:   JUCE interface for nlohmann::json
    dependencies:  juce_core

diff --git a/modules/common/chowdsp_reflection/chowdsp_reflection.h b/modules/common/chowdsp_reflection/chowdsp_reflection.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_reflection
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP Reflection Utilities
    description:   JUCE interface for boost::pfr
    dependencies:  chowdsp_core

diff --git a/modules/common/chowdsp_serialization/Serialization/chowdsp_BaseSerializer.h b/modules/common/chowdsp_serialization/Serialization/chowdsp_BaseSerializer.h
@@ -27,11 +27,18 @@ namespace serialization_detail
         }
     };
 
+    // The reason we need this "detail" namespace is so that we can define these static method
+    // checkers for determining if a class has custom methods for serialization/deserialization.
     CHOWDSP_CHECK_HAS_STATIC_METHOD (HasCustomSerializer, template serialize<DummySerializer>)
     CHOWDSP_CHECK_HAS_STATIC_METHOD (HasCustomDeserializer, template deserialize<DummySerializer>)
 } // namespace serialization_detail
 #endif
 
+/**
+ * Base class for Serializer objects. If you would like to create
+ * a serializer for a particular serialization format, the new serializer
+ * should be derived from BaseSerializer.
+ */
 class BaseSerializer
 {
     template <typename Serializer>
@@ -56,6 +63,7 @@ class BaseSerializer
     static constexpr auto HasCustomDeserialization = serialization_detail::HasCustomDeserializer<T>;
 
 public:
+    /** Converts a SerialType object into its corresponding DeserialType */
     template <typename Serializer>
     static DeserialType<Serializer> getDeserial (const SerialType<Serializer>& serial)
     {

diff --git a/modules/common/chowdsp_serialization/chowdsp_serialization.h b/modules/common/chowdsp_serialization/chowdsp_serialization.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_serialization
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP Serialization Utilities
    description:   Utility methods for serializing data structures into XML, JSON, or some other format
    dependencies:  juce_core, chowdsp_core, chowdsp_json, chowdsp_reflection

diff --git a/modules/dsp/chowdsp_dsp_data_structures/chowdsp_dsp_data_structures.h b/modules/dsp/chowdsp_dsp_data_structures/chowdsp_dsp_data_structures.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_dsp_data_structures
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP DSP Data Structures
    description:   DSP data structures for ChowDSP plugins
    dependencies:  chowdsp_simd, chowdsp_math

diff --git a/modules/dsp/chowdsp_dsp_utils/chowdsp_dsp_utils.h b/modules/dsp/chowdsp_dsp_utils/chowdsp_dsp_utils.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_dsp_utils
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP DSP Utilities
    description:   Commonly used DSP utilities for ChowDSP plugins
    dependencies:  chowdsp_filters

diff --git a/modules/dsp/chowdsp_eq/chowdsp_eq.h b/modules/dsp/chowdsp_eq/chowdsp_eq.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_eq
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP EQ
    description:   EQ utilities for ChowDSP plugins
    dependencies:  chowdsp_reflection, chowdsp_dsp_utils

diff --git a/modules/dsp/chowdsp_filters/chowdsp_filters.h b/modules/dsp/chowdsp_filters/chowdsp_filters.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_filters
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP Filters
    description:   Filter classes for ChowDSP plugins
    dependencies:  chowdsp_core, chowdsp_dsp_data_structures, chowdsp_math

diff --git a/modules/dsp/chowdsp_math/chowdsp_math.h b/modules/dsp/chowdsp_math/chowdsp_math.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_math
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP Math Utilities
    description:   Math utilities for ChowDSP plugins
    dependencies:  chowdsp_simd

diff --git a/modules/dsp/chowdsp_reverb/chowdsp_reverb.h b/modules/dsp/chowdsp_reverb/chowdsp_reverb.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_reverb
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP Reverb
    description:   Reverb utilities for ChowDSP plugins
    dependencies:  chowdsp_dsp_utils

diff --git a/modules/dsp/chowdsp_simd/chowdsp_simd.h b/modules/dsp/chowdsp_simd/chowdsp_simd.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_simd
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP DSP SIMD
    description:   JUCE interface for XSIMD, with a few extra useful methods
    dependencies:  chowdsp_core

diff --git a/modules/dsp/chowdsp_waveshapers/chowdsp_waveshapers.h b/modules/dsp/chowdsp_waveshapers/chowdsp_waveshapers.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_waveshapers
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP Waveshapers
    description:   Waveshaping functions for ChowDSP plugins
    dependencies:  chowdsp_math, chowdsp_dsp_data_structures

diff --git a/modules/gui/chowdsp_foleys/chowdsp_foleys.h b/modules/gui/chowdsp_foleys/chowdsp_foleys.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_foleys
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP Foley's GUI Magic
    description:   Interface between chowdsp_gui and foleys_gui_magic
    dependencies:  juce_core, foleys_gui_magic, chowdsp_gui

diff --git a/modules/gui/chowdsp_gui/chowdsp_gui.h b/modules/gui/chowdsp_gui/chowdsp_gui.h
@@ -5,7 +5,7 @@
 
     ID:            chowdsp_gui
     vendor:        Chowdhury DSP
-    version:       1.0.0
+    version:       1.1.0
     name:          ChowDSP GUI Utilities
     description:   Commonly used GUI utilities for ChowDSP plugins
     dependencies:  juce_core, juce_audio_processors, juce_gui_basics, juce_dsp, chowdsp_core

diff --git a/modules/music/chowdsp_rhythm/chowdsp_rhythm.h b/modules/music/chowdsp_rhythm/chowdsp_rhythm.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_rhythm
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP Rhythm Utilities
    description:   Utility classes for working with rhythms
    dependencies:  juce_core

diff --git a/modules/plugin/chowdsp_clap_extensions/PluginExtensions/chowdsp_CLAPInfoExtensions.h b/modules/plugin/chowdsp_clap_extensions/PluginExtensions/chowdsp_CLAPInfoExtensions.h
@@ -2,8 +2,13 @@
 
 namespace chowdsp::CLAPExtensions
 {
+/** Interface for clap_juce_extensions::clap_properties */
 struct CLAPInfoExtensions : protected clap_juce_extensions::clap_properties
 {
+    /**
+     * Returns juce::AudioProcessor::getWrapperTypeDescription(), unless
+     * the plugin is a CLAP, in which case the method will return "CLAP".
+     */
     [[nodiscard]] juce::String getPluginTypeString (juce::AudioProcessor::WrapperType wrapperType) const
     {
         if (wrapperType == juce::AudioProcessor::wrapperType_Undefined && is_clap)

diff --git a/modules/plugin/chowdsp_clap_extensions/chowdsp_clap_extensions.h b/modules/plugin/chowdsp_clap_extensions/chowdsp_clap_extensions.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_clap_extensions
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP CLAP Extensions
    description:   Extensions for building CLAP plugins
    dependencies:  juce_core, juce_audio_processors

diff --git a/modules/plugin/chowdsp_parameters/chowdsp_parameters.h b/modules/plugin/chowdsp_parameters/chowdsp_parameters.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_parameters
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP Parameters
    description:   Parameter utilities for ChowDSP plugins
    dependencies:  juce_core, juce_audio_processors

diff --git a/modules/plugin/chowdsp_plugin_base/chowdsp_plugin_base.h b/modules/plugin/chowdsp_plugin_base/chowdsp_plugin_base.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_plugin_base
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP Plugin Base
    description:   Base classes for ChowDSP plugins
    dependencies:  chowdsp_core, chowdsp_parameters

diff --git a/modules/plugin/chowdsp_plugin_utils/chowdsp_plugin_utils.h b/modules/plugin/chowdsp_plugin_utils/chowdsp_plugin_utils.h
@@ -5,7 +5,7 @@
 
     ID:            chowdsp_plugin_utils
     vendor:        Chowdhury DSP
-    version:       1.0.0
+    version:       1.1.0
     name:          ChowDSP Plugin Utilities
     description:   Utilities for creating ChowDSP plugins
     dependencies:  juce_events, juce_audio_basics, juce_audio_formats,

diff --git a/modules/plugin/chowdsp_presets/chowdsp_presets.h b/modules/plugin/chowdsp_presets/chowdsp_presets.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_presets
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP Presets Utilities
    description:   Presets management system for ChowDSP plugins
    dependencies:  juce_core, juce_audio_utils, chowdsp_version

diff --git a/modules/plugin/chowdsp_version/chowdsp_version.h b/modules/plugin/chowdsp_version/chowdsp_version.h
@@ -5,7 +5,7 @@ BEGIN_JUCE_MODULE_DECLARATION
 
    ID:            chowdsp_version
    vendor:        Chowdhury DSP
-   version:       1.0.0
+   version:       1.1.0
    name:          ChowDSP Plugin Versioning
    description:   Versioning system for ChowDSP plugins
    dependencies:  juce_core