docs(core): update generated compodoc documentation

klemenoslaj · Nov 10, 2019 · 39be25c · 39be25c
1 parent 2d6427e
commit 39be25c
Show file tree

Hide file tree

Showing 35 changed files with 547 additions and 182 deletions.
diff --git a/docs/classes/ActionAbstract.html b/docs/classes/ActionAbstract.html
diff --git a/docs/classes/ActionButton.html b/docs/classes/ActionButton.html
diff --git a/docs/classes/ActionGroup.html b/docs/classes/ActionGroup.html
diff --git a/docs/classes/ActionToggle.html b/docs/classes/ActionToggle.html
diff --git a/docs/coverage.html b/docs/coverage.html
@@ -343,6 +343,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 0;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'coverage';
             var COMPODOC_CURRENT_PAGE_URL = 'coverage.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="./js/libs/custom-elements.min.js"></script>

diff --git a/docs/dependencies.html b/docs/dependencies.html
@@ -48,29 +48,29 @@
     </ol>
     <ul class="dependencies-list">
         <li>
-            <b>@angular/animations</b> : ^8.2.4</li>
+            <b>@angular/animations</b> : ^8.2.13</li>
         <li>
-            <b>@angular/cdk</b> : ^8.1.4</li>
+            <b>@angular/cdk</b> : ^8.2.3</li>
         <li>
-            <b>@angular/common</b> : ^8.2.4</li>
+            <b>@angular/common</b> : ^8.2.13</li>
         <li>
-            <b>@angular/compiler</b> : ^8.2.4</li>
+            <b>@angular/compiler</b> : ^8.2.13</li>
         <li>
-            <b>@angular/core</b> : ^8.2.4</li>
+            <b>@angular/core</b> : ^8.2.13</li>
         <li>
-            <b>@angular/forms</b> : ^8.2.4</li>
+            <b>@angular/forms</b> : ^8.2.13</li>
         <li>
-            <b>@angular/material</b> : ^8.1.4</li>
+            <b>@angular/material</b> : ^8.2.3</li>
         <li>
-            <b>@angular/platform-browser</b> : ^8.2.4</li>
+            <b>@angular/platform-browser</b> : ^8.2.13</li>
         <li>
-            <b>@angular/platform-browser-dynamic</b> : ^8.2.4</li>
+            <b>@angular/platform-browser-dynamic</b> : ^8.2.13</li>
         <li>
-            <b>@angular/router</b> : ^8.2.4</li>
+            <b>@angular/router</b> : ^8.2.13</li>
         <li>
             <b>hammerjs</b> : ^2.0.8</li>
         <li>
-            <b>rxjs</b> : ^6.4.0</li>
+            <b>rxjs</b> : ^6.5.3</li>
         <li>
             <b>travis-deploy-once</b> : ^5.0.11</li>
         <li>
@@ -100,6 +100,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 0;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'package-dependencies';
             var COMPODOC_CURRENT_PAGE_URL = 'dependencies.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="./js/libs/custom-elements.min.js"></script>

diff --git a/docs/directives/ActionOutletDirective.html b/docs/directives/ActionOutletDirective.html
@@ -597,7 +597,7 @@ <h3 id="accessors">
         const component &#x3D; this.getComponentType(this.action, this.injector);
         const componentFactory &#x3D; this.componentFactoryResolver.resolveComponentFactory(component);
         this.componentRef &#x3D; this.viewContainerRef.createComponent(componentFactory);
-        this.componentRef.instance.action &#x3D; this.action.activate();
+        this.componentRef.instance._action &#x3D; this.action.activate();
     }
 
     /**
@@ -698,6 +698,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'directive';
             var COMPODOC_CURRENT_PAGE_URL = 'ActionOutletDirective.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/fonts/roboto-v15-latin-italic.eot b/docs/fonts/roboto-v15-latin-italic.eot
diff --git a/docs/fonts/roboto-v15-latin-italic.svg b/docs/fonts/roboto-v15-latin-italic.svg
diff --git a/docs/fonts/roboto-v15-latin-italic.ttf b/docs/fonts/roboto-v15-latin-italic.ttf
diff --git a/docs/fonts/roboto-v15-latin-italic.woff b/docs/fonts/roboto-v15-latin-italic.woff
diff --git a/docs/fonts/roboto-v15-latin-italic.woff2 b/docs/fonts/roboto-v15-latin-italic.woff2
diff --git a/docs/index.html b/docs/index.html
@@ -181,6 +181,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 0;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'getting-started';
             var COMPODOC_CURRENT_PAGE_URL = 'index.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="./js/libs/custom-elements.min.js"></script>

diff --git a/docs/injectables/ActionOutletFactory.html b/docs/injectables/ActionOutletFactory.html
@@ -547,6 +547,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'injectable';
             var COMPODOC_CURRENT_PAGE_URL = 'ActionOutletFactory.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/interfaces/ActionAbstractComponentImpl.html b/docs/interfaces/ActionAbstractComponentImpl.html
@@ -87,7 +87,8 @@ <h6><b>Properties</b></h6>
                         <td class="col-md-4">
                             <ul class="index-list">
                                 <li>
-                                        <a href="#action">action</a>
+                                            <span class="modifier">Optional</span>
+                                        <a href="#_action">_action</a>
                                 </li>
                             </ul>
                         </td>
@@ -104,25 +105,30 @@ <h3 id="inputs">Properties</h3>
                         <tbody>
                                 <tr>
                                     <td class="col-md-4">
-                                        <a name="action"></a>
-                                        <span class="name"><b>action</b><a href="#action"><span class="icon ion-ios-link"></span></a></span>
+                                        <a name="_action"></a>
+                                        <span class="name"><b>_action</b><a href="#_action"><span class="icon ion-ios-link"></span></a></span>
                                     </td>
                                 </tr>
                                 <tr>
                                     <td class="col-md-4">
-                                        <code>action:     <code>Action</code>
+                                        <code>_action:     <code>Action | null</code>
 </code>
                                     </td>
                                 </tr>
 
 
                                     <tr>
                                         <td class="col-md-4">
-                                            <i>Type : </i>    <code>Action</code>
+                                            <i>Type : </i>    <code>Action | null</code>
 
                                         </td>
                                     </tr>
 
+                                    <tr>
+                                        <td class="col-md-4">
+                                            <i>Optional</i>
+                                        </td>
+                                    </tr>
 
 
 
@@ -150,7 +156,7 @@ <h3 id="inputs">Properties</h3>
     /**
      * The derived action instance, as Input in angular component
      */
-    action: Action; // @Input
+    _action?: Action | null; // @Input
 }
 
 /**
@@ -214,6 +220,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
             var COMPODOC_CURRENT_PAGE_URL = 'ActionAbstractComponentImpl.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/interfaces/ActionAbstractEvent.html b/docs/interfaces/ActionAbstractEvent.html
@@ -151,7 +151,7 @@ <h3 id="inputs">Properties</h3>
     /**
      * The derived action instance, as Input in angular component
      */
-    action: Action; // @Input
+    _action?: Action | null; // @Input
 }
 
 /**
@@ -215,6 +215,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
             var COMPODOC_CURRENT_PAGE_URL = 'ActionAbstractEvent.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/interfaces/ActionAbstractOptions.html b/docs/interfaces/ActionAbstractOptions.html
@@ -287,7 +287,7 @@ <h3 id="inputs">Properties</h3>
     /**
      * The derived action instance, as Input in angular component
      */
-    action: Action; // @Input
+    _action?: Action | null; // @Input
 }
 
 /**
@@ -351,6 +351,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
             var COMPODOC_CURRENT_PAGE_URL = 'ActionAbstractOptions.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/interfaces/ActionButtonEvent.html b/docs/interfaces/ActionButtonEvent.html
@@ -205,6 +205,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
             var COMPODOC_CURRENT_PAGE_URL = 'ActionButtonEvent.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/interfaces/ActionButtonOptions.html b/docs/interfaces/ActionButtonOptions.html
@@ -211,6 +211,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
             var COMPODOC_CURRENT_PAGE_URL = 'ActionButtonOptions.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/interfaces/ActionGroupEvent.html b/docs/interfaces/ActionGroupEvent.html
@@ -205,6 +205,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
             var COMPODOC_CURRENT_PAGE_URL = 'ActionGroupEvent.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/interfaces/ActionGroupOptions.html b/docs/interfaces/ActionGroupOptions.html
@@ -249,6 +249,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
             var COMPODOC_CURRENT_PAGE_URL = 'ActionGroupOptions.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/interfaces/ActionOutlet.html b/docs/interfaces/ActionOutlet.html
@@ -463,6 +463,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
             var COMPODOC_CURRENT_PAGE_URL = 'ActionOutlet.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/interfaces/ActionToggleEvent.html b/docs/interfaces/ActionToggleEvent.html
@@ -251,6 +251,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
             var COMPODOC_CURRENT_PAGE_URL = 'ActionToggleEvent.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/interfaces/ActionToggleOptions.html b/docs/interfaces/ActionToggleOptions.html
@@ -263,6 +263,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'interface';
             var COMPODOC_CURRENT_PAGE_URL = 'ActionToggleOptions.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/js/menu-wc.js b/docs/js/menu-wc.js
@@ -60,13 +60,13 @@ customElements.define('compodoc-menu', class extends HTMLElement {
                                 <a href="modules/ActionOutletModule.html" data-type="entity-link">ActionOutletModule</a>
                                 <li class="chapter inner">
                                     <div class="simple menu-toggler" data-toggle="collapse" ${ isNormalMode ?
-                                        'data-target="#directives-links-module-ActionOutletModule-59aabf42ce8bb55832d03b4fd8a35dd9"' : 'data-target="#xs-directives-links-module-ActionOutletModule-59aabf42ce8bb55832d03b4fd8a35dd9"' }>
+                                        'data-target="#directives-links-module-ActionOutletModule-a0fdde8a75138082c1989068b7f52264"' : 'data-target="#xs-directives-links-module-ActionOutletModule-a0fdde8a75138082c1989068b7f52264"' }>
                                         <span class="icon ion-md-code-working"></span>
                                         <span>Directives</span>
                                         <span class="icon ion-ios-arrow-down"></span>
                                     </div>
-                                    <ul class="links collapse" ${ isNormalMode ? 'id="directives-links-module-ActionOutletModule-59aabf42ce8bb55832d03b4fd8a35dd9"' :
-                                        'id="xs-directives-links-module-ActionOutletModule-59aabf42ce8bb55832d03b4fd8a35dd9"' }>
+                                    <ul class="links collapse" ${ isNormalMode ? 'id="directives-links-module-ActionOutletModule-a0fdde8a75138082c1989068b7f52264"' :
+                                        'id="xs-directives-links-module-ActionOutletModule-a0fdde8a75138082c1989068b7f52264"' }>
                                         <li class="link">
                                             <a href="directives/ActionOutletDirective.html"
                                                 data-type="entity-link" data-context="sub-entity" data-context-id="modules">ActionOutletDirective</a>

diff --git a/docs/js/search/search-lunr.js b/docs/js/search/search-lunr.js
@@ -36,7 +36,7 @@
 
         d.done({
             query: q,
-            results: results.slice(0, length),
+            results: length === 0 ? results : results.slice(0, length),
             count: results.length
         });
 

diff --git a/docs/js/search/search.js b/docs/js/search/search.js
@@ -1,8 +1,5 @@
 (function(compodoc) {
-    var MAX_RESULTS = 15,
-        MAX_DESCRIPTION_SIZE = 500,
-
-        usePushState = (typeof history.pushState !== 'undefined'),
+    var usePushState = (typeof history.pushState !== 'undefined'),
 
     // DOM Elements
         $body = $('body'),
@@ -120,7 +117,7 @@
             $mainContainer.css('margin-top', '100px');
         }
 
-        throttle(compodoc.search.query(q, 0, MAX_RESULTS)
+        throttle(compodoc.search.query(q, 0, MAX_SEARCH_RESULTS)
         .then(function(results) {
             displayResults(results);
         }), 1000);

diff --git a/docs/js/search/search_index.js b/docs/js/search/search_index.js
diff --git a/docs/license.html b/docs/license.html
@@ -84,6 +84,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 0;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'getting-started';
             var COMPODOC_CURRENT_PAGE_URL = 'license.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="./js/libs/custom-elements.min.js"></script>

diff --git a/docs/miscellaneous/enumerations.html b/docs/miscellaneous/enumerations.html
@@ -123,6 +123,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'miscellaneous-enumerations';
             var COMPODOC_CURRENT_PAGE_URL = 'enumerations.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/miscellaneous/typealiases.html b/docs/miscellaneous/typealiases.html
@@ -243,6 +243,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'miscellaneous-typealiases';
             var COMPODOC_CURRENT_PAGE_URL = 'typealiases.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/miscellaneous/variables.html b/docs/miscellaneous/variables.html
@@ -287,6 +287,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'miscellaneous-variables';
             var COMPODOC_CURRENT_PAGE_URL = 'variables.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/modules.html b/docs/modules.html
@@ -90,6 +90,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 0;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'modules';
             var COMPODOC_CURRENT_PAGE_URL = 'modules.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="./js/libs/custom-elements.min.js"></script>

diff --git a/docs/modules/ActionOutletModule.html b/docs/modules/ActionOutletModule.html
@@ -173,9 +173,9 @@ <h3>Exports<a href="https://angular.io/api/core/NgModule#exports" target="_blank
 import { ActionOutletDirective } from &#x27;./action-outlet.directive&#x27;;
 
 @NgModule({
-  declarations: [ActionOutletDirective],
-  imports: [CommonModule],
-  exports: [ActionOutletDirective]
+    declarations: [ActionOutletDirective],
+    imports: [CommonModule],
+    exports: [ActionOutletDirective]
 })
 export class ActionOutletModule { }
 </code></pre>
@@ -214,6 +214,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 1;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'module';
             var COMPODOC_CURRENT_PAGE_URL = 'ActionOutletModule.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="../js/libs/custom-elements.min.js"></script>

diff --git a/docs/overview.html b/docs/overview.html
@@ -195,6 +195,7 @@ <h1 class="search-results-title">No results matching "<span class='search-query'
             var COMPODOC_CURRENT_PAGE_DEPTH = 0;
             var COMPODOC_CURRENT_PAGE_CONTEXT = 'overview';
             var COMPODOC_CURRENT_PAGE_URL = 'overview.html';
+            var MAX_SEARCH_RESULTS = 15;
        </script>
 
        <script src="./js/libs/custom-elements.min.js"></script>