@ng-doc/builder 17.6.16 → 18.0.0-beta.1

package/templates/helpers/constructor.html.nunj

@@ -4,31 +4,29 @@
 
 {% macro render(constructor) %}
     {% set parameters = constructor.getParameters() %}
-    <div class="ng-doc-table-wrapper">
-        <table class="ng-doc-method-table">
-            <tbody>
-            <tr>
-                <td>
-                    {% set description = constructor | extractDocs %}
+    <table>
+        <tbody>
+        <tr>
+            <td>
+                {% set description = constructor | getJsDocDescription %}
 
-                    {{ description if description else noContentMacro.render('No documentation has been provided.') }}
-                </td>
-            </tr>
-            <tr>
-                <td>
-                    <h5 class="no-anchor" indexable="false">Presentation</h5>
-                    {{ codeMacro.render(constructor | constructorPresentation, "typescript", false) }}
-                </td>
-            </tr>
-            <tr>
-                <td>
-                    {%- if parameters.length %}
-                        <h5 class="no-anchor" indexable="false">Parameters</h5>
-                        {{ parametersMacro.render(parameters, constructor, true) }}
-                    {%- endif %}
-                </td>
-            </tr>
-            </tbody>
-        </table>
-    </div>
+                {{ description if description else noContentMacro.render('No documentation has been provided.') }}
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <h5 class="no-anchor" indexable="false">Presentation</h5>
+                {{ codeMacro.render(constructor | constructorPresentation, "typescript", false) }}
+            </td>
+        </tr>
+        <tr>
+            <td>
+                {%- if parameters.length %}
+                    <h5 class="no-anchor" indexable="false">Parameters</h5>
+                    {{ parametersMacro.render(parameters, constructor, true) }}
+                {%- endif %}
+            </td>
+        </tr>
+        </tbody>
+    </table>
 {% endmacro %}

package/templates/helpers/members.html.nunj

@@ -1,23 +1,29 @@
+{% import "helpers/status.html.nunj" as statusMacro %}
+
 {% macro render(members) %}
-    <div class="ng-doc-table-wrapper">
-        <table>
-            <thead>
-            <tr indexable="false">
-                <th>Name</th>
-                <th>Value</th>
-                <th>Description</th>
+    <table class="ng-doc-api-table sticky first-colum-highlighted">
+        <thead>
+        <tr indexable="false">
+            <th>Name</th>
+            <th>Value</th>
+            <th style="min-width: 300px;">Description</th>
+        </tr>
+        </thead>
+        <tbody>
+        {% for member in members %}
+            <tr class="{{ statusMacro.class(member) }}">
+                <td indexable="false" dataSlug="{{ member.getName() }}"
+                    dataSlugType="member">{{ member.getName() }} </td>
+                <td indexable="false"><code>{{ member.getValue() | dump }}</code></td>
+                <td>
+                    <div class="ng-doc-api-status">
+                        {{ statusMacro.render(member) }}
+                    </div>
+
+                    {{ member | getJsDocDescription }}
+                </td>
             </tr>
-            </thead>
-            <tbody>
-            {% for member in members %}
-                <tr>
-                    <td indexable="false" dataSlug="{{ member.getName() }}"
-                        dataSlugType="member">{{ member.getName() }} </td>
-                    <td indexable="false"><code>{{ member.getValue() | dump }}</code></td>
-                    <td>{{ member | extractDocs }} </td>
-                </tr>
-            {% endfor %}
-            </tbody>
-        </table>
-    </div>
+        {% endfor %}
+        </tbody>
+    </table>
 {% endmacro %}

package/templates/helpers/method.html.nunj

@@ -4,6 +4,8 @@
 {% import "helpers/parameters.html.nunj" as parametersMacro %}
 {% import "helpers/decorators.html.nunj" as decoratorsMacro %}
 {% import "helpers/no-content.html.nunj" as noContentMacro %}
+{% import "helpers/overload.html.nunj" as overloadMacro %}
+{% import "helpers/status.html.nunj" as statusMacro %}
 
 {% macro render(method, origin) %}
     {% set parameters = method.getParameters() %}
@@ -12,54 +14,66 @@
     {% set overriddenMember = method | getOverriddenMember %}
     {% set implementedMember = method | getImplementedMember %}
     {% set docNode = methodChain | firstNodeWithComment %}
+    {% set overloads = method.getOverloads() if method.getOverloads else [] %}
 
-    <div class="ng-doc-table-wrapper">
-        <table class="ng-doc-method-table">
-            <thead>
-            <tr>
-                <th indexable="false">
-                    {{ decoratorsMacro.render(method.getDecorators()) if method.getDecorators }}
-                    {{ tagsMacro.render(method, 'modifier') }}
-                    <h3 dataSlugType="member">{{ method.getName() }}()</h3>
-                    <div class="ng-doc-node-details">
-                        {%- if inheritedFrom %}
-                            inherited from <code>{{ inheritedFrom.getName() }}</code>
-                        {%- elseif overriddenMember %}
-                            overrides <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
-                        {%- elseif implementedMember %}
-                            implements <code>{{ (implementedMember | getMemberParent).getName() }}</code>
-                        {%- endif %}
-                    </div>
-                </th>
-            </tr>
-            </thead>
-            <tbody>
-            <tr>
-                <td>
-                    {% set description = docNode | extractDocs %}
+    <table class="{{ statusMacro.class(method) }}">
+        <thead>
+        <tr>
+            <th indexable="false">
+                {{ decoratorsMacro.render(method.getDecorators()) if method.getDecorators }}
+                {{ tagsMacro.render(method, 'modifier') }}
+                <h3 dataSlugType="member">{{ method.getName() }}()</h3>
+                <div class="ng-doc-node-details">
+                    {%- if inheritedFrom %}
+                        inherited from <code>{{ inheritedFrom.getName() }}</code>
+                    {%- elseif overriddenMember %}
+                        overrides <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
+                    {%- elseif implementedMember %}
+                        implements
+                        <code>{{ (implementedMember | getMemberParent).getName() }}</code>
+                    {%- endif %}
+                </div>
+            </th>
+        </tr>
+        </thead>
+        <tbody>
+        <tr>
+            <td>
+                <div class="ng-doc-api-status">
+                    {{ statusMacro.render(method) }}
+                </div>
 
-                    {{ description if description else noContentMacro.render('No documentation has been provided.') }}
-                </td>
-            </tr>
-            <tr>
-                <td>
-                    <h5 class="no-anchor" indexable="false">Presentation</h5>
-                    {{ codeMacro.render(method | methodPresentation, "typescript", false) }}
-                </td>
-            </tr>
+                {% set description = docNode | getJsDocDescription %}
+
+                {{ description if description else noContentMacro.render('No documentation has been provided.') }}
+            </td>
+        </tr>
+        <tr>
+            <td>
+                <h5 class="no-anchor ng-doc-secondary-heading" indexable="false">Presentation</h5>
+                {{ codeMacro.render(method | methodPresentation, "typescript", false) }}
+            </td>
+        </tr>
+        <tr>
+            <td>
+                {%- if parameters.length %}
+                    <h5 class="no-anchor ng-doc-secondary-heading" indexable="false">Parameters</h5>
+                    {{ parametersMacro.render(parameters, docNode) }}
+                {%- endif %}
+                <h5 class="no-anchor ng-doc-secondary-heading" indexable="false">Returns</h5>
+                <p>
+                    {{ typeMacro.returnType(method) }}
+                </p>
+            </td>
+        </tr>
+
+        {% if overloads.length %}
             <tr>
                 <td>
-                    {%- if parameters.length %}
-                        <h5 class="no-anchor" indexable="false">Parameters</h5>
-                        {{ parametersMacro.render(parameters, docNode) }}
-                    {%- endif %}
-                    <h5 class="no-anchor" indexable="false">Returns</h5>
-                    <p>
-                        {{ typeMacro.returnType(method) }}
-                    </p>
+                    {{ overloadMacro.render(overloads) }}
                 </td>
             </tr>
-            </tbody>
-        </table>
-    </div>
+        {% endif %}
+        </tbody>
+    </table>
 {% endmacro %}

package/templates/helpers/no-content.html.nunj

@@ -1,3 +1,3 @@
 {%- macro render(content) -%}
-    <span class="ng-doc-no-content" indexable="false">{{ content }}</span>
+    <p class="ng-doc-no-content" indexable="false">{{ content }}</p>
 {%- endmacro -%}

package/templates/helpers/overload.html.nunj

@@ -0,0 +1,47 @@
+{% import "helpers/no-content.html.nunj" as noContentMacro %}
+{% import "helpers/parameters.html.nunj" as parametersMacro %}
+{% import "helpers/type.html.nunj" as typeMacro %}
+{% import "helpers/code.html.nunj" as codeMacro %}
+
+{% macro render(overloads) %}
+    {% for overload in overloads %}
+        {% set docNode = overload %}
+        {% set parameters = overload.getParameters() %}
+
+        <table class="ng-doc-overload-table">
+            <thead indexable="false">
+            <tr>
+                <th>Overload #{{ loop.index }}</th>
+            </tr>
+            </thead>
+            <tbody>
+            <tr>
+                <td>
+                    {% set description = docNode | getJsDocDescription %}
+
+                    {{ description if description else noContentMacro.render('No documentation has been provided.') }}
+                </td>
+            </tr>
+            <tr>
+                <td>
+                    <h5 class="no-anchor" indexable="false">Presentation</h5>
+                    {{ codeMacro.render(overload | methodPresentation, "typescript", false) }}
+                </td>
+            </tr>
+            <tr>
+                <td>
+                    {%- if parameters.length %}
+                        <h5 class="no-anchor" indexable="false">Parameters</h5>
+                        {{ parametersMacro.render(parameters, docNode) }}
+                    {%- endif %}
+                    <h5 class="no-anchor" indexable="false">Returns</h5>
+                    <p>
+                        {{ typeMacro.returnType(overload) }}
+                    </p>
+                </td>
+            </tr>
+            </tbody>
+        </table>
+    {% endfor %}
+{% endmacro %}
+

package/templates/helpers/parameters.html.nunj

@@ -3,42 +3,42 @@
 {% import "helpers/decorators.html.nunj" as decoratorsMacro %}
 
 {% macro render(parameters, origin, slugger) %}
-    <div class="ng-doc-table-wrapper">
-        <table class="ng-doc-parameters-table">
-            <thead>
-            <tr indexable="false">
-                <th class="ng-doc-parameters-table-name">Name</th>
-                <th class="ng-doc-parameters-table-type">Type</th>
-                <th class="ng-doc-parameters-table-description">Description</th>
-            </tr>
-            </thead>
-            <tbody>
-            {%- for param in parameters %}
-                {% set paramChain = param | getPropertyChain %}
-                {% set inheritedFrom = param | getInheritedParent(origin) %}
-                {% set overriddenMember = param | getOverriddenMember %}
-                {% set implementedMember = param | getImplementedMember %}
-                {% set docNode = paramChain | firstNodeWithComment %}
+    <table class="ng-doc-api-table">
+        <thead>
+        <tr indexable="false">
+            <th>Name</th>
+            <th>Type</th>
+            <th>Description</th>
+        </tr>
+        </thead>
+        <tbody>
+        {%- for param in parameters %}
+            {% set paramChain = param | getPropertyChain %}
+            {% set inheritedFrom = param | getInheritedParent(origin) %}
+            {% set overriddenMember = param | getOverriddenMember %}
+            {% set implementedMember = param | getImplementedMember %}
+            {% set docNode = paramChain | firstNodeWithComment %}
 
-                <tr {{ 'dataSlug="'+param.getName()+'" dataSlugType="member"' if slugger }}>
-                    <td indexable="false">
-                        {{ decoratorsMacro.render(param.getDecorators(), true) if param.getDecorators }}
-                        {{ tagsMacro.render(param, "badge") }}{{ param.getName() }}
-                        <div class="ng-doc-node-details">
-                            {%- if inheritedFrom %}
-                                inherited from <code>{{ inheritedFrom.getName() }}</code>
-                            {%- elseif overriddenMember %}
-                                overrides <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
-                            {%- elseif implementedMember %}
-                                implements <code>{{ (implementedMember | getMemberParent).getName() }}</code>
-                            {%- endif %}
-                        </div>
-                    </td>
-                    <td>{{ typeMacro.type(param) }}</td>
-                    <td>{{ origin | extractParameterDocs(param.getName()) }}</td>
-                </tr>
-            {%- endfor %}
-            </tbody>
-        </table>
-    </div>
+            <tr {{ 'dataSlug="'+param.getName()+'" dataSlugType="member"' if slugger }}>
+                <td indexable="false">
+                    {{ decoratorsMacro.render(param.getDecorators(), true) if param.getDecorators }}
+                    {{ tagsMacro.render(param, "badge") }}{{ param.getName() }}
+                    <div class="ng-doc-node-details">
+                        {%- if inheritedFrom %}
+                            inherited from <code>{{ inheritedFrom.getName() }}</code>
+                        {%- elseif overriddenMember %}
+                            overrides
+                            <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
+                        {%- elseif implementedMember %}
+                            implements
+                            <code>{{ (implementedMember | getMemberParent).getName() }}</code>
+                        {%- endif %}
+                    </div>
+                </td>
+                <td>{{ typeMacro.type(param) }}</td>
+                <td>{{ origin | getJsDocParam(param.getName()) }}</td>
+            </tr>
+        {%- endfor %}
+        </tbody>
+    </table>
 {% endmacro %}

package/templates/helpers/properties.html.nunj

@@ -1,44 +1,50 @@
 {% import "helpers/type.html.nunj" as typeMacro %}
 {% import "helpers/declaration-modifiers.html.nunj" as tagsMacro %}
 {% import "helpers/decorators.html.nunj" as decoratorsMacro %}
+{% import "helpers/status.html.nunj" as statusMacro %}
 
 {% macro render(properties, origin) %}
-    <div class="ng-doc-table-wrapper">
-        <table class="ng-doc-properties-table">
-            <thead>
-            <tr indexable="false">
-                <th class="ng-doc-properties-table-name">Name</th>
-                <th class="ng-doc-properties-table-type">Type</th>
-                <th class="ng-doc-properties-table-description">Description</th>
-            </tr>
-            </thead>
-            <tbody>
-            {%- for property in properties %}
-                {% set propertyChain = property | getPropertyChain %}
-                {% set inheritedFrom = property | getInheritedParent(origin) %}
-                {% set overriddenMember = property | getOverriddenMember %}
-                {% set implementedMember = property | getImplementedMember %}
-                {% set docNode = propertyChain | firstNodeWithComment %}
+    <table class="ng-doc-api-table sticky first-colum-highlighted">
+        <thead>
+        <tr indexable="false">
+            <th class="ng-doc-api-table-name">Name</th>
+            <th class="ng-doc-api-table-type">Type</th>
+            <th class="ng-doc-api-table-description">Description</th>
+        </tr>
+        </thead>
+        <tbody>
+        {%- for property in properties %}
+            {% set propertyChain = property | getPropertyChain %}
+            {% set inheritedFrom = property | getInheritedParent(origin) %}
+            {% set overriddenMember = property | getOverriddenMember %}
+            {% set implementedMember = property | getImplementedMember %}
+            {% set docNode = propertyChain | firstNodeWithComment %}
 
-                <tr dataSlug="{{ property.getName() }}" dataSlugType="member">
-                    <td indexable="false">
-                        {{ decoratorsMacro.render(property.getDecorators(), true) if property.getDecorators }}
-                        {{ tagsMacro.render(property, "badge") }}{{ property.getName() }}
-                        <div class="ng-doc-node-details">
-                            {%- if inheritedFrom %}
-                                inherited from <code>{{ inheritedFrom.getName() }}</code>
-                            {%- elseif overriddenMember %}
-                                overrides <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
-                            {%- elseif implementedMember %}
-                                implements <code>{{ (implementedMember | getMemberParent).getName() }}</code>
-                            {%- endif %}
-                        </div>
-                    </td>
-                    <td>{{ typeMacro.type(property) }}</td>
-                    <td>{{ docNode | extractDocs }}</td>
-                </tr>
-            {%- endfor %}
-            </tbody>
-        </table>
-    </div>
+            <tr class="{{ statusMacro.class(property) }}" dataSlug="{{ property.getName() }}" dataSlugType="member">
+                <td indexable="false">
+                    {{ decoratorsMacro.render(property.getDecorators(), true) if property.getDecorators }}
+                    <span>{{ property.getName() }}{{ tagsMacro.render(property, "badge") }}</span>
+                    <div class="ng-doc-node-details">
+                        {%- if inheritedFrom %}
+                            inherited from <code>{{ inheritedFrom.getName() }}</code>
+                        {%- elseif overriddenMember %}
+                            overrides
+                            <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
+                        {%- elseif implementedMember %}
+                            implements
+                            <code>{{ (implementedMember | getMemberParent).getName() }}</code>
+                        {%- endif %}
+                    </div>
+                </td>
+                <td>{{ typeMacro.type(property) }}</td>
+                <td>
+                    <div class="ng-doc-api-status">
+                        {{ statusMacro.render(property) }}
+                    </div>
+                    {{ docNode | getJsDocDescription }}
+                </td>
+            </tr>
+        {%- endfor %}
+        </tbody>
+    </table>
 {% endmacro %}

package/templates/helpers/status.html.nunj

@@ -0,0 +1,37 @@
+{% macro render(member) %}
+    {% set deprecated = member | getJsDocTag('deprecated') %}
+    {% if deprecated %}
+        <ng-doc-blockquote type="warning" icon="activity">
+            <b>Deprecated</b>
+            {{ deprecated }}
+        </ng-doc-blockquote>
+    {% endif %}
+
+    {% set experimental = member | getJsDocTag('experimental') %}
+    {% if experimental %}
+        <ng-doc-blockquote type="alert" icon="activity">
+            <b>Experimental</b>
+            {{ experimental }}
+        </ng-doc-blockquote>
+    {% endif %}
+
+    {% set alpha = member | getJsDocTag('alpha') %}
+    {% if alpha %}
+        <ng-doc-blockquote type="alert" icon="activity">
+            <b>Alpha</b>
+            {{ alpha }}
+        </ng-doc-blockquote>
+    {% endif %}
+
+    {% set beta = member | getJsDocTag('beta') %}
+    {% if beta %}
+        <ng-doc-blockquote type="warning" icon="activity">
+            <b>Beta</b>
+            {{ beta }}
+        </ng-doc-blockquote>
+    {% endif %}
+{% endmacro %}
+
+{% macro class(member) -%}
+    {{ "ng-doc-deprecated" if member | hasJsDocTag('deprecated') }} {{ "ng-doc-alpha" if member | hasJsDocTag('alpha') }} {{ "ng-doc-beta" if member | hasJsDocTag('beta') }} {{ "ng-doc-experimental" if member | hasJsDocTag('experimental') }}
+{%- endmacro %}

package/templates/helpers/type.html.nunj

@@ -5,3 +5,7 @@
 {%- macro returnType(node) -%}
     <code indexable="false">{{ node | displayReturnType | escape }}</code>
 {%- endmacro %}
+
+{% macro render(type) -%}
+    <code indexable="false">{{ type | escape }}</code>
+{%- endmacro %}

package/templates/index.ts.nunj

@@ -1,2 +1,2 @@
-export * from './ng-doc.context';
-export * from './ng-doc.routing';
+export * from './context';
+export * from './routes';

package/templates/page-header.html.nunj

@@ -0,0 +1,5 @@
+<h1 class="ngde">{{ NgDocPage.title }}</h1>
+
+{% if Metadata.description %}
+<p class="ngde">{{ Metadata.description }}</p>
+{% endif %}

package/templates/page-wrapper.ts.nunj

@@ -0,0 +1,42 @@
+// @ts-nocheck
+import {ChangeDetectionStrategy, Component} from '@angular/core';
+import {Routes} from '@angular/router';
+import {NgDocPageWrapperComponent} from '@ng-doc/app';
+import {NgDocPageType} from '@ng-doc/core';
+
+const headerContent: string = `{{ headerContent | toTemplateString }}`
+
+@Component({
+  selector: 'ng-doc-page-wrapper-{{ id }}',
+  template: `<ng-doc-page-wrapper [routes]="routes" [headerContent]="headerContent" [hasBreadcrumb]="hasBreadcrumb" [pageType]="pageType"></ng-doc-page-wrapper>`,
+  imports: [NgDocPageWrapperComponent],
+  changeDetection: ChangeDetectionStrategy.OnPush,
+  standalone: true
+})
+export class PageWrapperComponent {
+    routes = routes[0].children!;
+    headerContent = headerContent;
+    pageType: NgDocPageType = '{{ pageType }}';
+    hasBreadcrumb = {{ hasBreadcrumb }};
+}
+
+
+const routes: Routes = [{
+  path: '',
+  component: PageWrapperComponent,
+  title: `{{ metadata.title | toTemplateString }}`,
+  children: [
+    {%- for importPath, entry in entries  %}
+    {
+      path: '{{ entry.route }}',
+      loadChildren: () => import('./{{ importPath }}'),
+      title: '{{ entry.title | toTemplateString }}',
+      data: {
+        icon: '{{ entry.entry.icon }}',
+      }
+    },
+    {%- endfor %}
+  ]
+}]
+
+export default routes;