From b3c3cd6448ae25c373ac0dc494de90a9cb481a2f Mon Sep 17 00:00:00 2001
From: falkTX <falktx@falktx.com>
Date: Sat, 25 Sep 2021 18:54:42 +0100
Subject: [PATCH] Add a few code comments

Signed-off-by: falkTX <falktx@falktx.com>
---
 distrho/src/DistrhoPluginVST3.cpp | 14 ++++++++++++++
 distrho/src/DistrhoUIVST3.cpp     | 14 ++++++++++++++
 2 files changed, 28 insertions(+)

diff --git a/distrho/src/DistrhoPluginVST3.cpp b/distrho/src/DistrhoPluginVST3.cpp
index f9a3cd1c..5ad26600 100644
--- a/distrho/src/DistrhoPluginVST3.cpp
+++ b/distrho/src/DistrhoPluginVST3.cpp
@@ -219,6 +219,14 @@ static constexpr void (*const snprintf_u32_utf16)(int16_t*, uint32_t, size_t) =
 
 // --------------------------------------------------------------------------------------------------------------------
 
+/**
+ * VST3 DSP class.
+ *
+ * All the dynamic things from VST3 get implemented here, free of complex low-level VST3 pointer things.
+ * The DSP is created during the "initialise" component event, and destroyed during "terminate".
+ *
+ * The low-level VST3 stuff comes after.
+ */
 class PluginVst3
 {
     /* buses: we provide 1 for the main audio (if there is any) plus 1 for each sidechain or cv port.
@@ -1377,6 +1385,12 @@ private:
 
 };
 
+// --------------------------------------------------------------------------------------------------------------------
+
+/**
+ * VST3 low-level pointer thingies follow, proceed with care.
+ */
+
 #if DISTRHO_PLUGIN_HAS_UI
 // --------------------------------------------------------------------------------------------------------------------
 // dpf_plugin_view_create (called from DSP side)
diff --git a/distrho/src/DistrhoUIVST3.cpp b/distrho/src/DistrhoUIVST3.cpp
index 34676693..7aafbb98 100644
--- a/distrho/src/DistrhoUIVST3.cpp
+++ b/distrho/src/DistrhoUIVST3.cpp
@@ -71,6 +71,14 @@ const char* tuid2str(const v3_tuid iid);
 
 // --------------------------------------------------------------------------------------------------------------------
 
+/**
+ * VST3 UI class.
+ *
+ * All the dynamic things from VST3 get implemented here, free of complex low-level VST3 pointer things.
+ * The UI is created during the "attach" view event, and destroyed during "removed".
+ *
+ * The low-level VST3 stuff comes after.
+ */
 class UIVst3 : public Thread
 {
 public:
@@ -293,6 +301,12 @@ private:
 #endif
 };
 
+// --------------------------------------------------------------------------------------------------------------------
+
+/**
+ * VST3 low-level pointer thingies follow, proceed with care.
+ */
+
 // --------------------------------------------------------------------------------------------------------------------
 // dpf_plugin_view_content_scale