From bfbc218a5bd4a648a2b71601ac2657e7a45ee761 Mon Sep 17 00:00:00 2001
From: Paul Licameli <paul.licameli@audacityteam.org>
Date: Tue, 9 Jan 2018 14:51:42 -0500
Subject: [PATCH] comments

---
 src/PluginManager.cpp | 5 +++++
 src/PluginManager.h   | 1 +
 2 files changed, 6 insertions(+)

diff --git a/src/PluginManager.cpp b/src/PluginManager.cpp
index c6511264a..e96005cb7 100644
--- a/src/PluginManager.cpp
+++ b/src/PluginManager.cpp
@@ -2905,6 +2905,7 @@ bool PluginManager::SetConfig(const wxString & key, const double & value)
    return result;
 }
 
+/* Return value is a key for lookup in a config file */
 wxString PluginManager::SettingsPath(const PluginID & ID, bool shared)
 {
    if (mPlugins.find(ID) == mPlugins.end())
@@ -2929,6 +2930,7 @@ wxString PluginManager::SettingsPath(const PluginID & ID, bool shared)
           wxCONFIG_PATH_SEPARATOR;
 }
 
+/* Return value is a key for lookup in a config file */
 wxString PluginManager::SharedGroup(const PluginID & ID, const wxString & group)
 {
    wxString path = SettingsPath(ID, true);
@@ -2942,6 +2944,7 @@ wxString PluginManager::SharedGroup(const PluginID & ID, const wxString & group)
    return path;
 }
 
+/* Return value is a key for lookup in a config file */
 wxString PluginManager::SharedKey(const PluginID & ID, const wxString & group, const wxString & key)
 {
    wxString path = SharedGroup(ID, group);
@@ -2953,6 +2956,7 @@ wxString PluginManager::SharedKey(const PluginID & ID, const wxString & group, c
    return path + key;
 }
 
+/* Return value is a key for lookup in a config file */
 wxString PluginManager::PrivateGroup(const PluginID & ID, const wxString & group)
 {
    wxString path = SettingsPath(ID, false);
@@ -2966,6 +2970,7 @@ wxString PluginManager::PrivateGroup(const PluginID & ID, const wxString & group
    return path;
 }
 
+/* Return value is a key for lookup in a config file */
 wxString PluginManager::PrivateKey(const PluginID & ID, const wxString & group, const wxString & key)
 {
    wxString path = PrivateGroup(ID, group);
diff --git a/src/PluginManager.h b/src/PluginManager.h
index 744191d5d..b6843ebb8 100644
--- a/src/PluginManager.h
+++ b/src/PluginManager.h
@@ -294,6 +294,7 @@ private:
    bool SetConfig(const wxString & key, const float & value);
    bool SetConfig(const wxString & key, const double & value);
 
+   /* Return values are keys for lookup in a config file */
    wxString SettingsPath(const PluginID & ID, bool shared);
    wxString SharedGroup(const PluginID & ID, const wxString & group);
    wxString SharedKey(const PluginID & ID, const wxString & group, const wxString & key);