fields panel documentation

panels/fields/module.js

@@ -1,3 +1,22 @@
+/*
+
+  ## Fields
+
+  Allows for enabling and disabling of fields in the table panel as well as a 
+  micro anaylsis panel for analyzing the events in the table panel
+
+  ### Parameters
+  * style :: a hash containing css styles
+  * arrange :: the layout pf the panel 'horizontal' or 'vertical'
+  * micropanel_position :: where to place the micropanel in relation to the field
+  
+  ### Group Events
+  #### Recieves
+  * table_documents :: An object containing the documents in the table panel
+  *** Sends
+  * fields :: an object containing the sort order, existing fields and selected fields
+
+*/
 angular.module('kibana.fields', [])
 .controller('fields', function($scope, eventBus, $timeout) {
 

panels/timepicker/module.js

@@ -1,30 +1,32 @@
 /*
-## Timepicker
+
-
+  ## Timepicker
-The timepicker panel is used to select time ranges and inform other panel of 
+
-them. It also handles searching for indices that match the given time range and 
+  The timepicker panel is used to select time ranges and inform other panel of 
-a pattern
+  them. It also handles searching for indices that match the given time range and 
-
+  a pattern
-### Parameters
+
-* mode :: The default mode of the panel. Options: 'relative', 'absolute' 'since' Default: 'relative'
+  ### Parameters
-* time_options :: An array of possible time options. Default: ['5m','15m','1h','6h','12h','24h','2d','7d','30d']
+  * mode :: The default mode of the panel. Options: 'relative', 'absolute' 'since' Default: 'relative'
-* timespan :: The default options selected for the relative view. Default: '15m'
+  * time_options :: An array of possible time options. Default: ['5m','15m','1h','6h','12h','24h','2d','7d','30d']
-* timefield :: The field in which time is stored in the document.
+  * timespan :: The default options selected for the relative view. Default: '15m'
-* index :: Index pattern to match. Literals should be double quoted. Default: '_all'
+  * timefield :: The field in which time is stored in the document.
-* defaultindex :: Index to failover to if index not found
+  * index :: Index pattern to match. Literals should be double quoted. Default: '_all'
-* index_interval :: Time between timestamped indices (can be 'none') for static index
+  * defaultindex :: Index to failover to if index not found
-* refresh: Object containing refresh parameters
+  * index_interval :: Time between timestamped indices (can be 'none') for static index
-  * enable :: true/false, enable auto refresh by default. Default: false
+  * refresh: Object containing refresh parameters
-  * interval :: Seconds between auto refresh. Default: 30
+    * enable :: true/false, enable auto refresh by default. Default: false
-  * min :: The lowest interval a user may set
+    * interval :: Seconds between auto refresh. Default: 30
-
+    * min :: The lowest interval a user may set
-### Group Events
+
-#### Sends
+  ### Group Events
-* time :: Object Includes from, to and index
+  #### Sends
-#### Receives
+  * time :: Object Includes from, to and index
-* get_time :: Receives an object containing a $id, broadcasts back to it.
+  #### Receives
+  * get_time :: Receives an object containing a $id, broadcasts back to it.
 
 */
+
 angular.module('kibana.timepicker', [])
 .controller('timepicker', function($scope, eventBus, $timeout, timer, $http) {