[beast: 30/95] PLUGINS: document namespaces



commit 8e12a9f6894673bd2880d138a56b6c997a2628b4
Author: Tim Janik <timj gnu org>
Date:   Sun Mar 17 06:17:43 2013 +0100

    PLUGINS: document namespaces

 plugins/bsecontribsampleandhold.idl |    5 ++++-
 plugins/standardsaturator.idl       |    6 +++++-
 2 files changed, 9 insertions(+), 2 deletions(-)
---
diff --git a/plugins/bsecontribsampleandhold.idl b/plugins/bsecontribsampleandhold.idl
index 077bd07..8f23f8b 100644
--- a/plugins/bsecontribsampleandhold.idl
+++ b/plugins/bsecontribsampleandhold.idl
@@ -1,6 +1,9 @@
 // Licensed GNU LGPL v2.1 or later: http://www.gnu.org/licenses/lgpl.html
 include "bse/bsecxxmodule.idl";
-namespace Bse { namespace Contrib {
+namespace Bse {
+
+/// The Contrib namespace contains contributed BSE modules.
+namespace Contrib {
 interface SampleAndHold: Effect {
   Info icon             = "icons/sample+hold.png";
   Info authors         = _("Artem Popov");
diff --git a/plugins/standardsaturator.idl b/plugins/standardsaturator.idl
index 668881d..cc13fcf 100644
--- a/plugins/standardsaturator.idl
+++ b/plugins/standardsaturator.idl
@@ -1,6 +1,9 @@
 // Licensed GNU LGPL v2.1 or later: http://www.gnu.org/licenses/lgpl.html
 include "bse/bsecxxmodule.idl";
-namespace Bse { namespace Standard {
+namespace Bse {
+
+/// The Standard namespace contains BSE standard modules.
+namespace Standard {
 enum SaturationType {
   SATURATE_TANH      = Enum (_("TANH"),      _("Saturation via hyperbolic tangent function which is mostly 
linear for "
                                               "small levels while providing a soft curvature for high volume 
signals")),
@@ -13,6 +16,7 @@ enum SaturationType {
                                               "for small levels")),
   SATURATE_HARD      = Enum (_("Hard"),      _("Hard saturation via clipping (prone to clicks)")),
 };
+
 interface Saturator : Bse::Effect {
   Info    category  = "/Distortion/Saturate";
   Info    icon      = "icons/saturate.png";


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]