Refs #4200 started documenting LogAggregator and documented Plugin/API.

1 files changed, 21 insertions, 1 deletions

diff --git a/core/Plugin/API.php b/core/Plugin/API.php
index bb7e67cd7e..436f13a32c 100644
--- a/core/Plugin/API.php
+++ b/core/Plugin/API.php
@@ -13,7 +13,27 @@ namespace Piwik\Plugin;
 
 use Piwik\Singleton;
 
+/**
+ * The base class of all API singletons.
+ * 
+ * Plugins that want to expose functionality through an API should create a class
+ * that derives from this one. Every public method in that class will be callable
+ * through Piwik's API.
+ * 
+ * ### Example
+ * 
+ *     class MyAPI extends API
+ *     {
+ *         public function myMethod($idSite, $period, $date, $segment = false)
+ *         {
+ *             $dataTable = // ... get some data ...
+ *             return $dataTable;
+ *         }
+ *     }
+ * 
+ * @api
+ */
 abstract class API extends Singleton
 {
 
-}
+}
\ No newline at end of file