fixes #1222 - document the version number policy; point developers (who read the code) to Piwik_Plugin (core/Plugin.php)

git-svn-id: http://dev.piwik.org/svn/trunk@1964 59fd770c-687e-43c8-a1e3-f5a4ff64c105

6 files changed, 39 insertions, 7 deletions

diff --git a/core/Plugin.php b/core/Plugin.php
index d0d118180a..ed7cf98332 100644
--- a/core/Plugin.php
+++ b/core/Plugin.php
@@ -20,14 +20,15 @@ abstract class Piwik_Plugin
 {
 	/**
 	 * Returns the plugin details
-	 * 	'name' => string             // plugin name
-	 * 	'description' => string      // 1/2 sentences description of the plugin 
-	 * 	'author' => string           // plugin author 
-	 * 	'author_homepage' => string  // author homepage (or email "mailto:youremail@example.org")
-	 * 	'homepage' => string         // plugin homepage
-	 * 	'version' => string          // plugin version number
+	 * 	'name' => string               // plugin name
+	 * 	'description' => string        // 1-2 sentence description of the plugin
+	 * 	'author' => string             // plugin author 
+	 * 	'author_homepage' => string    // author homepage URL (or email "mailto:youremail@example.org")
+	 * 	'homepage' => string           // plugin homepage URL
+	 * 	'version' => string            // plugin version number; examples and 3rd party plugins must not use Piwik_Version::VERSION;
+	 *                                 // 3rd party plugins must increment the version number with each plugin release
 	 *  'translationAvailable' => bool // is there a translation file in plugins/your-plugin/lang/* ?
-	 * 	'TrackerPlugin' => bool     // should we load this plugin during the stats logging process?
+	 * 	'TrackerPlugin' => bool        // should we load this plugin during the stats logging process?
 	 */
 	abstract function getInformation();
 
diff --git a/plugins/ExampleAPI/ExampleAPI.php b/plugins/ExampleAPI/ExampleAPI.php
index 25ffd2c687..62c630277f 100644
--- a/plugins/ExampleAPI/ExampleAPI.php
+++ b/plugins/ExampleAPI/ExampleAPI.php
@@ -19,6 +19,9 @@ class Piwik_ExampleAPI extends Piwik_Plugin
 {
 	/**
 	 * Return information about this plugin.
+	 *
+	 * @see Piwik_Plugin
+	 *
 	 * @return array
 	 */
 	public function getInformation()
diff --git a/plugins/ExampleFeedburner/ExampleFeedburner.php b/plugins/ExampleFeedburner/ExampleFeedburner.php
index 3580fd2bee..99b4e5fa37 100644
--- a/plugins/ExampleFeedburner/ExampleFeedburner.php
+++ b/plugins/ExampleFeedburner/ExampleFeedburner.php
@@ -16,6 +16,13 @@
  */
 class Piwik_ExampleFeedburner extends Piwik_Plugin
 {
+	/**
+	 * Return information about this plugin.
+	 *
+	 * @see Piwik_Plugin
+	 *
+	 * @return array
+	 */
 	public function getInformation()
 	{
 		return array(
diff --git a/plugins/ExamplePlugin/ExamplePlugin.php b/plugins/ExamplePlugin/ExamplePlugin.php
index 6e9a57d28e..6d17f6fd91 100644
--- a/plugins/ExamplePlugin/ExamplePlugin.php
+++ b/plugins/ExamplePlugin/ExamplePlugin.php
@@ -16,6 +16,13 @@
  */
 class Piwik_ExamplePlugin extends Piwik_Plugin
 {
+	/**
+	 * Return information about this plugin.
+	 *
+	 * @see Piwik_Plugin
+	 *
+	 * @return array
+	 */
 	public function getInformation()
 	{
 		return array(
diff --git a/plugins/ExampleRssWidget/ExampleRssWidget.php b/plugins/ExampleRssWidget/ExampleRssWidget.php
index 9572cfac75..157f178d77 100644
--- a/plugins/ExampleRssWidget/ExampleRssWidget.php
+++ b/plugins/ExampleRssWidget/ExampleRssWidget.php
@@ -16,6 +16,13 @@
  */
 class Piwik_ExampleRssWidget extends Piwik_Plugin
 {
+	/**
+	 * Return information about this plugin.
+	 *
+	 * @see Piwik_Plugin
+	 *
+	 * @return array
+	 */
 	public function getInformation()
 	{
 		return array(
diff --git a/plugins/ExampleUI/ExampleUI.php b/plugins/ExampleUI/ExampleUI.php
index beb6b9010a..b9aea81812 100644
--- a/plugins/ExampleUI/ExampleUI.php
+++ b/plugins/ExampleUI/ExampleUI.php
@@ -26,6 +26,13 @@
  */
 class Piwik_ExampleUI extends Piwik_Plugin
 {
+	/**
+	 * Return information about this plugin.
+	 *
+	 * @see Piwik_Plugin
+	 *
+	 * @return array
+	 */
 	public function getInformation()
 	{
 		return array(