From ad29373c4f82738386ee3e60f5b2f9b5215882b9 Mon Sep 17 00:00:00 2001
From: Thomas Steur <thomas.steur@googlemail.com>
Date: Wed, 12 Mar 2014 02:40:36 +0100
Subject: [PATCH] refs #4690 added documentation

---
 .../siteselector/siteselector-directive.js     | 18 ++++++++++++++++++
 1 file changed, 18 insertions(+)

diff --git a/plugins/CoreHome/angularjs/siteselector/siteselector-directive.js b/plugins/CoreHome/angularjs/siteselector/siteselector-directive.js
index bcd5c0f0ab4..b97cf1a3579 100644
--- a/plugins/CoreHome/angularjs/siteselector/siteselector-directive.js
+++ b/plugins/CoreHome/angularjs/siteselector/siteselector-directive.js
@@ -5,6 +5,24 @@
  * @license http://www.gnu.org/licenses/gpl-3.0.html GPL v3 or later
  */
 
+/**
+ * Usage:
+ * <div piwik-siteselector>
+ *
+ * More advanced example
+ * <div piwik-siteselector
+ *      show-selected-site="true" show-all-sites-item="true" switch-site-on-select="true"
+ *      all-sites-location="top|bottom" all-sites-text="test" show-selected-site="true"
+ *      show-all-sites-item="true">
+ *
+ * Within a form
+ * <div piwik-siteselector input-name="siteId">
+ *
+ * Events:
+ * Triggers a `change` event on any change
+ * <div piwik-siteselector id="mySelector">
+ * $('#mySelector').on('change', function (event) { event.id/event.name })
+ */
 angular.module('piwikApp').directive('piwikSiteselector', function($document, piwik, $filter){
     var defaults = {
         name: '',