Cleanup docs.

pauliusmaciulis · Dec 27, 2013 · e593aef · e593aef
1 parent e19d0a5
commit e593aef
Show file tree

Hide file tree

Showing 94 changed files with 275 additions and 49 deletions.
diff --git a/dist/elastic.js b/dist/elastic.js
diff --git a/dist/elastic.min.js b/dist/elastic.min.js
diff --git a/docs/build.sh b/docs/build.sh
@@ -1,3 +1,5 @@
 #!/bin/bash
 
+grunt
 ./jsdoc -t elasticjs -d ../dist/docs ../dist/elastic.js
+#../node_modules/.bin/jsdoc -t elasticjs -d ../dist/docs ../dist/elastic.js
diff --git a/docs/templates/elasticjs/publish.js b/docs/templates/elasticjs/publish.js
@@ -201,6 +201,7 @@
         var nav = '',
             seen = {};
 
+        /*
         var moduleNames = find({kind: 'module'});
         if (moduleNames.length) {
             nav = nav + '<h3>Modules</h3><ul class="toc-item">';
@@ -233,6 +234,7 @@
             
             nav = nav + '</ul>';
         }
+        */
 
         // sorts an array of objects based on a property within that object
         var sort = function (prop, arr) {
@@ -247,26 +249,34 @@
             });
         };
 
-        var classNames = find({kind: 'class'});
-        if (classNames.length) {
-            nav = nav + '<h3>Modules</h3><ul class="toc-item">';
-            sort("name", classNames);
-            classNames.forEach(function(c) {
-                var moduleSameName = find({kind: 'module', longname: c.longname});
-                if (moduleSameName.length) {
-                    c.name = c.name.replace('module:', 'require(')+')';
-                    moduleSameName[0].module = c;
-                }
-                //print(c.name);
-                if (!seen.hasOwnProperty(c.longname) ) nav += '<li>'+linkto(c.longname, c.name)+'</li>';
-                seen[c.longname] = true;
-            });
-
-            nav = nav + '</ul>';
+        var navWithTag = function (tag, header) {
+            var classNames = find({kind: 'class', tags:{has: {title: 'ejs', value: tag}}});
+            if (classNames.length) {
+                nav = nav + '<h3>' + header + '</h3><ul class="toc-item">';
+                sort("name", classNames);
+                classNames.forEach(function(c) {
+                    var moduleSameName = find({kind: 'module', tags:{has: {title: 'ejs', value: tag}}, longname: c.longname});
+                    if (moduleSameName.length) {
+                        c.name = c.name.replace('module:', 'require(')+')';
+                        moduleSameName[0].module = c;
+                    }
+                    //print(c.name);
+                    if (!seen.hasOwnProperty(c.longname) ) nav += '<li>'+linkto(c.longname, c.name)+'</li>';
+                    seen[c.longname] = true;
+                });
+
+                nav = nav + '</ul>';
+            }
         }
 
+        navWithTag('request', 'Request');
+        navWithTag('query', 'Queries');
+        navWithTag('filter', 'Filters');
+        navWithTag('facet', 'Facets');
+        navWithTag('suggest', 'Suggesters');
+        navWithTag('geo', 'Geo');
 
-
+        /*
         var mixinNames = find({kind: 'mixin'});
         if (mixinNames.length) {
             nav = nav + '<h3>Mixins</h3><ul class="toc-item">';
@@ -277,9 +287,8 @@
             
             nav = nav + '</ul>';
         }
-
+        
         var globalNames = find({kind: ['property', 'function'], 'memberof': {'isUndefined': true}});
-
         if (globalNames.length) {
             nav = nav + '<h3>Global</h3><ul class="toc-item">';
             globalNames.forEach(function(g) {
@@ -289,6 +298,7 @@
             
             nav = nav + '</ul>';
         }
+        */
 
         for (var longname in helper.longnameToUrl) {
             var classes = find({kind: 'class', longname: longname});

diff --git a/src/facet/DateHistogramFacet.js b/src/facet/DateHistogramFacet.js
@@ -18,6 +18,7 @@
     </div>
 
     @name ejs.DateHistogramFacet
+    @ejs facet
     @borrows ejs.FacetMixin.facetFilter as facetFilter
     @borrows ejs.FacetMixin.global as global
     @borrows ejs.FacetMixin.mode as mode

diff --git a/src/facet/FilterFacet.js b/src/facet/FilterFacet.js
@@ -17,6 +17,7 @@
     </div>
 
     @name ejs.FilterFacet
+    @ejs facet
     @borrows ejs.FacetMixin.facetFilter as facetFilter
     @borrows ejs.FacetMixin.global as global
     @borrows ejs.FacetMixin.mode as mode

diff --git a/src/facet/GeoDistanceFacet.js b/src/facet/GeoDistanceFacet.js
@@ -18,6 +18,7 @@
     </div>
 
     @name ejs.GeoDistanceFacet
+    @ejs facet
     @borrows ejs.FacetMixin.facetFilter as facetFilter
     @borrows ejs.FacetMixin.global as global
     @borrows ejs.FacetMixin.mode as mode

diff --git a/src/facet/HistogramFacet.js b/src/facet/HistogramFacet.js
@@ -18,6 +18,7 @@
     </div>
 
     @name ejs.HistogramFacet
+    @ejs facet
     @borrows ejs.FacetMixin.facetFilter as facetFilter
     @borrows ejs.FacetMixin.global as global
     @borrows ejs.FacetMixin.mode as mode

diff --git a/src/facet/QueryFacet.js b/src/facet/QueryFacet.js
@@ -17,6 +17,7 @@
     </div>
 
     @name ejs.QueryFacet
+    @ejs facet
     @borrows ejs.FacetMixin.facetFilter as facetFilter
     @borrows ejs.FacetMixin.global as global
     @borrows ejs.FacetMixin.mode as mode

diff --git a/src/facet/RangeFacet.js b/src/facet/RangeFacet.js
@@ -17,6 +17,7 @@
     </div>
 
     @name ejs.RangeFacet
+    @ejs facet
     @borrows ejs.FacetMixin.facetFilter as facetFilter
     @borrows ejs.FacetMixin.global as global
     @borrows ejs.FacetMixin.mode as mode

diff --git a/src/facet/StatisticalFacet.js b/src/facet/StatisticalFacet.js
@@ -17,6 +17,7 @@
     </div>
 
     @name ejs.StatisticalFacet
+    @ejs facet
     @borrows ejs.FacetMixin.facetFilter as facetFilter
     @borrows ejs.FacetMixin.global as global
     @borrows ejs.FacetMixin.mode as mode

diff --git a/src/facet/TermStatsFacet.js b/src/facet/TermStatsFacet.js
@@ -17,6 +17,7 @@
     </div>
 
     @name ejs.TermStatsFacet
+    @ejs facet
     @borrows ejs.FacetMixin.facetFilter as facetFilter
     @borrows ejs.FacetMixin.global as global
     @borrows ejs.FacetMixin.mode as mode

diff --git a/src/facet/TermsFacet.js b/src/facet/TermsFacet.js
@@ -13,6 +13,7 @@
        <a href="http://en.wikipedia.org/wiki/Faceted_classification">Faceted Classification</a></p<
 
     @name ejs.TermsFacet
+    @ejs facet
     @borrows ejs.FacetMixin.facetFilter as facetFilter
     @borrows ejs.FacetMixin.global as global
     @borrows ejs.FacetMixin.mode as mode

diff --git a/src/filter/AndFilter.js b/src/filter/AndFilter.js
@@ -3,6 +3,7 @@
     A container Filter that allows Boolean AND composition of Filters.
 
     @name ejs.AndFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/BoolFilter.js b/src/filter/BoolFilter.js
@@ -6,6 +6,7 @@
     filter.
   
     @name ejs.BoolFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/ExistsFilter.js b/src/filter/ExistsFilter.js
@@ -4,6 +4,7 @@
     and the field contains a legitimate value.</p>
 
     @name ejs.ExistsFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/GeoBboxFilter.js b/src/filter/GeoBboxFilter.js
@@ -4,6 +4,7 @@
     the specified lon and lat coordinates. The format conforms with the GeoJSON specification.</p>
 
     @name ejs.GeoBboxFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/GeoDistanceFilter.js b/src/filter/GeoDistanceFilter.js
@@ -4,6 +4,7 @@
     point of origin. The format conforms with the GeoJSON specification.</p>
 
     @name ejs.GeoDistanceFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/GeoDistanceRangeFilter.js b/src/filter/GeoDistanceRangeFilter.js
@@ -4,6 +4,7 @@
     point of origin. The format conforms with the GeoJSON specification.</p>
 
     @name ejs.GeoDistanceRangeFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/GeoPolygonFilter.js b/src/filter/GeoPolygonFilter.js
@@ -4,6 +4,7 @@
     for each document as a Geo Point type. The format conforms with the GeoJSON specification.</p>
 
     @name ejs.GeoPolygonFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/GeoShapeFilter.js b/src/filter/GeoShapeFilter.js
@@ -10,6 +10,7 @@
     PrefixTree configuration as defined for the field.</p>
 
     @name ejs.GeoShapeFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/HasChildFilter.js b/src/filter/HasChildFilter.js
@@ -4,6 +4,7 @@
     matching the query being returned.</p>
 
     @name ejs.HasChildFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/HasParentFilter.js b/src/filter/HasParentFilter.js
@@ -4,6 +4,7 @@
     the query being returned.</p>
 
     @name ejs.HasParentFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/IdsFilter.js b/src/filter/IdsFilter.js
@@ -5,6 +5,7 @@
     _uid field.</p>
 
     @name ejs.IdsFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/IndicesFilter.js b/src/filter/IndicesFilter.js
@@ -6,6 +6,7 @@
     is executed on an index that does not match the listed indices.</p>
 
     @name ejs.IndicesFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/LimitFilter.js b/src/filter/LimitFilter.js
@@ -3,6 +3,7 @@
     <p>A limit filter limits the number of documents (per shard) to execute on.</p>
 
     @name ejs.LimitFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/MatchAllFilter.js b/src/filter/MatchAllFilter.js
@@ -4,6 +4,7 @@
     in a given set of collections and/or types.</p>
 
     @name ejs.MatchAllFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/MissingFilter.js b/src/filter/MissingFilter.js
@@ -3,6 +3,7 @@
     <p>An missingFilter matches documents where the specified field contains no legitimate value.</p>
 
     @name ejs.MissingFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/NestedFilter.js b/src/filter/NestedFilter.js
@@ -10,6 +10,7 @@
     parent doc (or parent nested mapping).</p>
   
     @name ejs.NestedFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/NotFilter.js b/src/filter/NotFilter.js
@@ -4,6 +4,7 @@
     contained filter.</p>
 
     @name ejs.NotFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/NumericRangeFilter.js b/src/filter/NumericRangeFilter.js
@@ -14,6 +14,7 @@
     filter should be used.</p>
 
     @name ejs.NumericRangeFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/OrFilter.js b/src/filter/OrFilter.js
@@ -3,6 +3,7 @@
     A container filter that allows Boolean OR composition of filters.
 
     @name ejs.OrFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/PrefixFilter.js b/src/filter/PrefixFilter.js
@@ -4,6 +4,7 @@
     to phrase query, except that it acts as a filter. Can be placed within queries that accept a filter.</p>
 
     @name ejs.PrefixFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/QueryFilter.js b/src/filter/QueryFilter.js
@@ -11,6 +11,7 @@
     caching (since it needs to satisfy different queries).</p>
   
     @name ejs.QueryFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/RangeFilter.js b/src/filter/RangeFilter.js
@@ -3,6 +3,7 @@
     <p>Matches documents with fields that have terms within a certain range.</p>
 
     @name ejs.RangeFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/RegexpFilter.js b/src/filter/RegexpFilter.js
@@ -5,6 +5,7 @@
     over index terms.</p>
 
     @name ejs.RegexpFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/ScriptFilter.js b/src/filter/ScriptFilter.js
@@ -3,6 +3,7 @@
     <p>A filter allowing to define scripts as filters</p>
 
     @name ejs.ScriptFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/TermFilter.js b/src/filter/TermFilter.js
@@ -5,6 +5,7 @@
     terms that are not necessarily in a sequence.</p>
 
     @name ejs.TermFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/TermsFilter.js b/src/filter/TermsFilter.js
@@ -4,6 +4,7 @@
     terms (not analyzed)</p>
 
     @name ejs.TermsFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/filter/TypeFilter.js b/src/filter/TypeFilter.js
@@ -3,6 +3,7 @@
     <p>A Filter that filters results by a specified index type.</p>
 
     @name ejs.TypeFilter
+    @ejs filter
     @borrows ejs.FilterMixin.name as name
     @borrows ejs.FilterMixin.cache as cache
     @borrows ejs.FilterMixin.cacheKey as cacheKey

diff --git a/src/query/BoolQuery.js b/src/query/BoolQuery.js
@@ -5,6 +5,7 @@
     for documents containing the terms <code>javascript</code> and <code>python</code>.</p>
 
     @name ejs.BoolQuery
+    @ejs query
     @borrows ejs.QueryMixin.boost as boost
     @borrows ejs.QueryMixin._type as _type
     @borrows ejs.QueryMixin.toJSON as toJSON