comparison vamp-sdk/PluginBase.h @ 24:e252b1ab423f

* add documentation to the C header

 #define _VAMP_PLUGIN_BASE_H_
 
 #include <string>
 #include <vector>
 
+#define VAMP_SDK_VERSION "0.2"
+
 namespace Vamp {
 
 /**
  * A base class for plugins with optional configurable parameters,
  * programs, etc.

     /**
      * Get the computer-usable name of the plugin.  This should be
      * reasonably short and contain no whitespace or punctuation
      * characters.  It may be shown to the user, but it won't be the
      * main method for a user to identify a plugin (that will be the
-     * description, below).
+     * description, below).  This may only contain the characters
+     * [a-zA-Z0-9_].
      */
     virtual std::string getName() const = 0;
 
     /**
      * Get a human-readable description of the plugin.  This should be

 	 * The maximum value of the parameter.
 	 */
 	float maxValue;
 
 	/**
-	 * The default value of the parameter.
+	 * The default value of the parameter.  The plugin should
+	 * ensure that parameters have this value on initialisation
+	 * (i.e. the host is not required to explicitly set parameters
+	 * if it wants to use their default values).
 	 */
 	float defaultValue;
 	
 	/**
 	 * True if the parameter values are quantized to a particular