@ng-doc/builder 16.13.1 → 16.15.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (181) hide show
  1. package/browser/index.js +6 -2
  2. package/browser/index.js.map +1 -1
  3. package/engine/actions/demo-pane.action.d.ts +1 -1
  4. package/engine/actions/demo-pane.action.js +1 -1
  5. package/engine/actions/demo-pane.action.js.map +1 -1
  6. package/engine/actions/demo.action.d.ts +1 -1
  7. package/engine/actions/demo.action.js +1 -1
  8. package/engine/actions/demo.action.js.map +1 -1
  9. package/engine/actions/playground.action.d.ts +1 -1
  10. package/engine/actions/playground.action.js +1 -1
  11. package/engine/actions/playground.action.js.map +1 -1
  12. package/engine/actions.js.map +1 -1
  13. package/engine/builder-operators/add-build-candidates.js.map +1 -1
  14. package/engine/builder-operators/build.js.map +1 -1
  15. package/engine/builder-operators/dependency-changes.js.map +1 -1
  16. package/engine/builder-operators/post-build.js.map +1 -1
  17. package/engine/builder-operators/post-process.js.map +1 -1
  18. package/engine/builder-operators/print-output.js +3 -1
  19. package/engine/builder-operators/print-output.js.map +1 -1
  20. package/engine/builder-operators/to-builder-output.js.map +1 -1
  21. package/engine/entities/abstractions/entity.js +3 -1
  22. package/engine/entities/abstractions/entity.js.map +1 -1
  23. package/engine/entities/abstractions/file.entity.js +3 -1
  24. package/engine/entities/abstractions/file.entity.js.map +1 -1
  25. package/engine/entities/abstractions/module.entity.js +1 -1
  26. package/engine/entities/abstractions/route.entity.js +7 -3
  27. package/engine/entities/abstractions/route.entity.js.map +1 -1
  28. package/engine/entities/abstractions/source-file.entity.js +1 -1
  29. package/engine/entities/abstractions/source-file.entity.js.map +1 -1
  30. package/engine/entities/api-list.entity.js +1 -1
  31. package/engine/entities/api-list.entity.js.map +1 -1
  32. package/engine/entities/api-page.entity.js +1 -1
  33. package/engine/entities/cache/cache.js.map +1 -1
  34. package/engine/entities/cache/decorators/cached-entity.js.map +1 -1
  35. package/engine/entities/cache/decorators/cached-files-getter.js.map +1 -1
  36. package/engine/entities/cache/helpers/create-cache.js.map +1 -1
  37. package/engine/entities/cache/helpers/invalidate-cache-if-needed.js.map +1 -1
  38. package/engine/entities/cache/helpers/update-cache.js.map +1 -1
  39. package/engine/entities/context.entity.js.map +1 -1
  40. package/engine/entities/index-file.entity.js.map +1 -1
  41. package/engine/entities/indexes.entity.js.map +1 -1
  42. package/engine/entities/keywords.entity.js.map +1 -1
  43. package/engine/entities/page-playground.entity.js.map +1 -1
  44. package/engine/entities/plugins/entity-plugins/markdown-to-html.plugin.js.map +1 -1
  45. package/engine/entities/plugins/entity-plugins/wrap-code.plugin.js.map +1 -1
  46. package/engine/entities/plugins/helpers/execute-plugins.js.map +1 -1
  47. package/engine/entities/routes.entity.js.map +1 -1
  48. package/engine/entity-emitter.js +2 -2
  49. package/engine/entity-emitter.js.map +1 -1
  50. package/engine/entity-store.js +3 -1
  51. package/engine/entity-store.js.map +1 -1
  52. package/engine/functions/build-candidates.js.map +1 -1
  53. package/engine/functions/if-not-cached-or-invalid.js.map +1 -1
  54. package/engine/nunjucks/extentions/index.extension.js.map +1 -1
  55. package/engine/nunjucks/render-template.js.map +1 -1
  56. package/engine/ts-doc-formatter.js.map +1 -1
  57. package/helpers/angular/get-component-decorator.d.ts +1 -1
  58. package/helpers/angular/get-component-decorator.js +1 -1
  59. package/helpers/angular/get-component-decorator.js.map +1 -1
  60. package/helpers/angular/get-directive-decorator.d.ts +1 -1
  61. package/helpers/angular/get-directive-decorator.js +1 -1
  62. package/helpers/angular/get-directive-decorator.js.map +1 -1
  63. package/helpers/angular/get-input-name.js +3 -1
  64. package/helpers/angular/get-input-name.js.map +1 -1
  65. package/helpers/angular/get-pipe-decorator.d.ts +1 -1
  66. package/helpers/angular/get-pipe-decorator.js +1 -1
  67. package/helpers/angular/get-pipe-decorator.js.map +1 -1
  68. package/helpers/build-indexes.d.ts +1 -1
  69. package/helpers/build-indexes.js +1 -1
  70. package/helpers/emit-built-output.js.map +1 -1
  71. package/helpers/filter-useless-members.js.map +1 -1
  72. package/helpers/format-code.d.ts +1 -1
  73. package/helpers/format-code.js +2 -2
  74. package/helpers/generate-api-entities.js +3 -1
  75. package/helpers/generate-api-entities.js.map +1 -1
  76. package/helpers/get-entity-constructor.js.map +1 -1
  77. package/helpers/get-keyword-type-from-entity.js.map +1 -1
  78. package/helpers/import-fresh-esm.js +2 -1
  79. package/helpers/import-fresh-esm.js.map +1 -1
  80. package/helpers/index.d.ts +1 -1
  81. package/helpers/index.js +1 -1
  82. package/helpers/index.js.map +1 -1
  83. package/helpers/load-config.js +3 -1
  84. package/helpers/load-config.js.map +1 -1
  85. package/helpers/markdown-to-html.js +4 -7
  86. package/helpers/markdown-to-html.js.map +1 -1
  87. package/helpers/playground/get-content-for-playground.js.map +1 -1
  88. package/helpers/playground/get-playground-inputs.js.map +1 -1
  89. package/helpers/playground/get-playground-template-inputs.js.map +1 -1
  90. package/helpers/playground/get-playgrounds-expression.js.map +1 -1
  91. package/helpers/playground/get-template-for-playground.js +2 -1
  92. package/helpers/playground/get-template-for-playground.js.map +1 -1
  93. package/helpers/posix.d.ts +6 -0
  94. package/helpers/posix.js +18 -0
  95. package/helpers/posix.js.map +1 -0
  96. package/helpers/print.js.map +1 -1
  97. package/helpers/process-html.js +1 -1
  98. package/helpers/process-html.js.map +1 -1
  99. package/helpers/process-legacy-snippets.d.ts +1 -1
  100. package/helpers/process-legacy-snippets.js +4 -2
  101. package/helpers/process-legacy-snippets.js.map +1 -1
  102. package/helpers/process-snippets.js.map +1 -1
  103. package/helpers/repo-link.js +3 -3
  104. package/helpers/repo-link.js.map +1 -1
  105. package/helpers/snippets-from-asset.js.map +1 -1
  106. package/helpers/sort-navigation-entities.js.map +1 -1
  107. package/helpers/to-template-string.js +1 -1
  108. package/helpers/to-template-string.js.map +1 -1
  109. package/helpers/typescript/accessor/get-accessor-chain.js.map +1 -1
  110. package/helpers/typescript/accessor/get-interface-accessors.js.map +1 -1
  111. package/helpers/typescript/accessor/group-accessors.js.map +1 -1
  112. package/helpers/typescript/class/for-all-classes.js.map +1 -1
  113. package/helpers/typescript/declaration-import.js +3 -1
  114. package/helpers/typescript/declaration-import.js.map +1 -1
  115. package/helpers/typescript/interface/for-all-interfaces.js.map +1 -1
  116. package/helpers/typescript/interface/get-interface-member.js.map +1 -1
  117. package/helpers/typescript/member/find-member.js.map +1 -1
  118. package/helpers/typescript/member/get-implemented-member.d.ts +1 -1
  119. package/helpers/typescript/member/get-implemented-member.js +1 -1
  120. package/helpers/typescript/member/get-implemented-member.js.map +1 -1
  121. package/helpers/typescript/member/get-overridden-member.d.ts +1 -1
  122. package/helpers/typescript/member/get-overridden-member.js +1 -1
  123. package/helpers/typescript/member/get-overridden-member.js.map +1 -1
  124. package/helpers/typescript/method/get-class-methods.js +2 -1
  125. package/helpers/typescript/method/get-class-methods.js.map +1 -1
  126. package/helpers/typescript/property/get-class-properties.js +2 -1
  127. package/helpers/typescript/property/get-class-properties.js.map +1 -1
  128. package/helpers/typescript/property/get-property-assignment.d.ts +1 -1
  129. package/helpers/typescript/property/get-property-assignment.js +1 -1
  130. package/helpers/typescript/property/get-property-assignment.js.map +1 -1
  131. package/operators/error-handler.js.map +1 -1
  132. package/package.json +3 -3
  133. package/schematics/api/index.js.map +1 -1
  134. package/schematics/category/index.js +5 -3
  135. package/schematics/category/index.js.map +1 -1
  136. package/schematics/migrations/standalone-pages/index.js +2 -1
  137. package/schematics/migrations/standalone-pages/index.js.map +1 -1
  138. package/schematics/page/index.js +9 -4
  139. package/schematics/page/index.js.map +1 -1
  140. package/schematics/utils/find-closest-file.d.ts +1 -1
  141. package/schematics/utils/find-closest-file.js +1 -1
  142. package/schematics/utils/find-closest-file.js.map +1 -1
  143. package/templates/api/base.html.nunj +9 -9
  144. package/templates/api/class.html.nunj +70 -70
  145. package/templates/api/enum.html.nunj +7 -7
  146. package/templates/api/function.html.nunj +11 -11
  147. package/templates/api/interface.html.nunj +30 -30
  148. package/templates/api/type-alias.html.nunj +4 -4
  149. package/templates/api/variable.html.nunj +4 -4
  150. package/templates/api-list.ts.nunj +19 -19
  151. package/templates/api-page-content.html.nunj +7 -7
  152. package/templates/api-page.ts.nunj +23 -23
  153. package/templates/api-scope.ts.nunj +15 -15
  154. package/templates/category.ts.nunj +15 -15
  155. package/templates/context.ts.nunj +31 -31
  156. package/templates/demo-assets.ts.nunj +14 -14
  157. package/templates/helpers/accessor.html.nunj +57 -57
  158. package/templates/helpers/accessors.html.nunj +3 -3
  159. package/templates/helpers/badge.html.nunj +2 -2
  160. package/templates/helpers/code.html.nunj +2 -2
  161. package/templates/helpers/constructor.html.nunj +27 -27
  162. package/templates/helpers/declaration-modifiers.html.nunj +33 -33
  163. package/templates/helpers/decorators.html.nunj +7 -7
  164. package/templates/helpers/members.html.nunj +21 -21
  165. package/templates/helpers/method.html.nunj +54 -54
  166. package/templates/helpers/methods.html.nunj +3 -3
  167. package/templates/helpers/modifier.html.nunj +2 -2
  168. package/templates/helpers/no-content.html.nunj +1 -1
  169. package/templates/helpers/parameters.html.nunj +37 -37
  170. package/templates/helpers/properties.html.nunj +37 -37
  171. package/templates/helpers/tag.html.nunj +2 -2
  172. package/templates/helpers/type.html.nunj +2 -2
  173. package/templates/page.ts.nunj +33 -33
  174. package/templates/parts/page-tags.html.nunj +13 -13
  175. package/templates/parts/see-also.html.nunj +15 -15
  176. package/templates/parts/usage-notes.html.nunj +4 -4
  177. package/templates/playgrounds.ts.nunj +29 -29
  178. package/templates/routing.ts.nunj +6 -6
  179. package/helpers/slash.d.ts +0 -5
  180. package/helpers/slash.js +0 -17
  181. package/helpers/slash.js.map +0 -1
@@ -3,32 +3,32 @@
3
3
  {% import "helpers/no-content.html.nunj" as noContentMacro %}
4
4
 
5
5
  {% macro render(constructor) %}
6
- {% set parameters = constructor.getParameters() %}
7
- <div class="ng-doc-table-wrapper">
8
- <table class="ng-doc-method-table">
9
- <tbody>
10
- <tr>
11
- <td>
12
- {% set description = constructor | extractDocs %}
6
+ {% set parameters = constructor.getParameters() %}
7
+ <div class="ng-doc-table-wrapper">
8
+ <table class="ng-doc-method-table">
9
+ <tbody>
10
+ <tr>
11
+ <td>
12
+ {% set description = constructor | extractDocs %}
13
13
 
14
- {{ description if description else noContentMacro.render('No documentation has been provided.') }}
15
- </td>
16
- </tr>
17
- <tr>
18
- <td>
19
- <h5 class="no-anchor" indexable="false">Presentation</h5>
20
- {{ codeMacro.render(constructor | constructorPresentation, "typescript", false) }}
21
- </td>
22
- </tr>
23
- <tr>
24
- <td>
25
- {%- if parameters.length %}
26
- <h5 class="no-anchor" indexable="false">Parameters</h5>
27
- {{ parametersMacro.render(parameters, constructor, true) }}
28
- {%- endif %}
29
- </td>
30
- </tr>
31
- </tbody>
32
- </table>
33
- </div>
14
+ {{ description if description else noContentMacro.render('No documentation has been provided.') }}
15
+ </td>
16
+ </tr>
17
+ <tr>
18
+ <td>
19
+ <h5 class="no-anchor" indexable="false">Presentation</h5>
20
+ {{ codeMacro.render(constructor | constructorPresentation, "typescript", false) }}
21
+ </td>
22
+ </tr>
23
+ <tr>
24
+ <td>
25
+ {%- if parameters.length %}
26
+ <h5 class="no-anchor" indexable="false">Parameters</h5>
27
+ {{ parametersMacro.render(parameters, constructor, true) }}
28
+ {%- endif %}
29
+ </td>
30
+ </tr>
31
+ </tbody>
32
+ </table>
33
+ </div>
34
34
  {% endmacro %}
@@ -3,43 +3,43 @@
3
3
  {% import "helpers/modifier.html.nunj" as modifierMacro %}
4
4
 
5
5
  {%- macro render(declaration, type='tag') -%}
6
- {% set isAbstract = declaration.isAbstract and declaration.isAbstract() %}
7
- {% set isStatic = declaration.isStatic and declaration.isStatic() %}
8
- {% set isAsync = declaration.isAsync and declaration.isAsync() %}
9
- {% set isReadonly = declaration.isReadonly and declaration.isReadonly() %}
10
- {% set isProtected = declaration.getScope and declaration.getScope() == 'protected' %}
11
- {% set tooltip = ["Protected" if isProtected, "Abstract" if isAbstract, 'Static' if isStatic, 'Async' if isAsync, 'Readonly' if isReadonly] | noEmpty | join(', ') %}
6
+ {% set isAbstract = declaration.isAbstract and declaration.isAbstract() %}
7
+ {% set isStatic = declaration.isStatic and declaration.isStatic() %}
8
+ {% set isAsync = declaration.isAsync and declaration.isAsync() %}
9
+ {% set isReadonly = declaration.isReadonly and declaration.isReadonly() %}
10
+ {% set isProtected = declaration.getScope and declaration.getScope() == 'protected' %}
11
+ {% set tooltip = ["Protected" if isProtected, "Abstract" if isAbstract, 'Static' if isStatic, 'Async' if isAsync, 'Readonly' if isReadonly] | noEmpty | join(', ') %}
12
12
 
13
- {%- if type == 'badge' %}
14
- {%- if isAbstract or isStatic or isAsync or isReadonly or isProtected %}
15
- <span class="ng-doc-badge-wrapper" ngDocTooltip="{{ tooltip }}" indexable="false">
13
+ {%- if type == 'badge' %}
14
+ {%- if isAbstract or isStatic or isAsync or isReadonly or isProtected %}
15
+ <span class="ng-doc-badge-wrapper" ngDocTooltip="{{ tooltip }}" indexable="false">
16
16
  {{ badgeMacro.render("protected") if isProtected }}
17
- {{ badgeMacro.render("abstract") if isAbstract }}
18
- {{ badgeMacro.render("static") if isStatic }}
19
- {{ badgeMacro.render("async") if isAsync }}
20
- {{ badgeMacro.render("readonly") if isReadonly }}
17
+ {{ badgeMacro.render("abstract") if isAbstract }}
18
+ {{ badgeMacro.render("static") if isStatic }}
19
+ {{ badgeMacro.render("async") if isAsync }}
20
+ {{ badgeMacro.render("readonly") if isReadonly }}
21
21
  </span>
22
- {%- endif %}
22
+ {%- endif %}
23
23
 
24
- {%- elseif type == 'modifier' %}
25
- {%- if isAbstract or isStatic or isAsync or isReadonly or isProtected %}
26
- <div class="ng-doc-modifiers-wrapper" indexable="false">
27
- {{ modifierMacro.render("protected") if isProtected }}
28
- {{ modifierMacro.render("abstract") if isAbstract }}
29
- {{ modifierMacro.render("static") if isStatic }}
30
- {{ modifierMacro.render("async") if isAsync }}
31
- {{ modifierMacro.render("readonly") if isReadonly }}
32
- </div>
33
- {%- endif %}
34
- {%- else %}
35
- {%- if isAbstract or isStatic or isAsync or isReadonly or isProtected %}
36
- <span class="ng-doc-tags-wrapper" indexable="false">
24
+ {%- elseif type == 'modifier' %}
25
+ {%- if isAbstract or isStatic or isAsync or isReadonly or isProtected %}
26
+ <div class="ng-doc-modifiers-wrapper" indexable="false">
27
+ {{ modifierMacro.render("protected") if isProtected }}
28
+ {{ modifierMacro.render("abstract") if isAbstract }}
29
+ {{ modifierMacro.render("static") if isStatic }}
30
+ {{ modifierMacro.render("async") if isAsync }}
31
+ {{ modifierMacro.render("readonly") if isReadonly }}
32
+ </div>
33
+ {%- endif %}
34
+ {%- else %}
35
+ {%- if isAbstract or isStatic or isAsync or isReadonly or isProtected %}
36
+ <span class="ng-doc-tags-wrapper" indexable="false">
37
37
  {{ tagMacro.render("protected") if isProtected }}
38
- {{ tagMacro.render("abstract") if isAbstract }}
39
- {{ tagMacro.render("static") if isStatic }}
40
- {{ tagMacro.render("async") if isAsync }}
41
- {{ tagMacro.render("readonly") if isReadonly }}
38
+ {{ tagMacro.render("abstract") if isAbstract }}
39
+ {{ tagMacro.render("static") if isStatic }}
40
+ {{ tagMacro.render("async") if isAsync }}
41
+ {{ tagMacro.render("readonly") if isReadonly }}
42
42
  </span>
43
- {%- endif %}
44
- {%- endif %}
43
+ {%- endif %}
44
+ {%- endif %}
45
45
  {%- endmacro -%}
@@ -1,11 +1,11 @@
1
1
  {% import "helpers/tag.html.nunj" as tagMacro %}
2
2
 
3
3
  {% macro render(decorators, column) %}
4
- {% if decorators.length %}
5
- <div class="ng-doc-decorators-group {{ 'column' if column }}" indexable="false">
6
- {% for decorator in decorators %}
7
- <code>{{ '@' + decorator.getName() | escape }}</code>
8
- {%- endfor %}
9
- </div>
10
- {% endif %}
4
+ {% if decorators.length %}
5
+ <div class="ng-doc-decorators-group {{ 'column' if column }}" indexable="false">
6
+ {% for decorator in decorators %}
7
+ <code>{{ '@' + decorator.getName() | escape }}</code>
8
+ {%- endfor %}
9
+ </div>
10
+ {% endif %}
11
11
  {% endmacro %}
@@ -1,23 +1,23 @@
1
1
  {% macro render(members) %}
2
- <div class="ng-doc-table-wrapper">
3
- <table>
4
- <thead>
5
- <tr indexable="false">
6
- <th>Name</th>
7
- <th>Value</th>
8
- <th>Description</th>
9
- </tr>
10
- </thead>
11
- <tbody>
12
- {% for member in members %}
13
- <tr>
14
- <td indexable="false" dataSlug="{{ member.getName() }}"
15
- dataSlugType="member">{{ member.getName() }} </td>
16
- <td indexable="false"><code>{{ member.getValue() | dump }}</code></td>
17
- <td>{{ member | extractDocs }} </td>
18
- </tr>
19
- {% endfor %}
20
- </tbody>
21
- </table>
22
- </div>
2
+ <div class="ng-doc-table-wrapper">
3
+ <table>
4
+ <thead>
5
+ <tr indexable="false">
6
+ <th>Name</th>
7
+ <th>Value</th>
8
+ <th>Description</th>
9
+ </tr>
10
+ </thead>
11
+ <tbody>
12
+ {% for member in members %}
13
+ <tr>
14
+ <td indexable="false" dataSlug="{{ member.getName() }}"
15
+ dataSlugType="member">{{ member.getName() }} </td>
16
+ <td indexable="false"><code>{{ member.getValue() | dump }}</code></td>
17
+ <td>{{ member | extractDocs }} </td>
18
+ </tr>
19
+ {% endfor %}
20
+ </tbody>
21
+ </table>
22
+ </div>
23
23
  {% endmacro %}
@@ -6,60 +6,60 @@
6
6
  {% import "helpers/no-content.html.nunj" as noContentMacro %}
7
7
 
8
8
  {% macro render(method, origin) %}
9
- {% set parameters = method.getParameters() %}
10
- {% set methodChain = method | getMethodChain %}
11
- {% set inheritedFrom = method | getInheritedParent(origin) %}
12
- {% set overriddenMember = method | getOverriddenMember %}
13
- {% set implementedMember = method | getImplementedMember %}
14
- {% set docNode = methodChain | firstNodeWithComment %}
9
+ {% set parameters = method.getParameters() %}
10
+ {% set methodChain = method | getMethodChain %}
11
+ {% set inheritedFrom = method | getInheritedParent(origin) %}
12
+ {% set overriddenMember = method | getOverriddenMember %}
13
+ {% set implementedMember = method | getImplementedMember %}
14
+ {% set docNode = methodChain | firstNodeWithComment %}
15
15
 
16
- <div class="ng-doc-table-wrapper">
17
- <table class="ng-doc-method-table">
18
- <thead>
19
- <tr>
20
- <th indexable="false">
21
- {{ decoratorsMacro.render(method.getDecorators()) if method.getDecorators }}
22
- {{ tagsMacro.render(method, 'modifier') }}
23
- <h3 dataSlugType="member">{{ method.getName() }}()</h3>
24
- <div class="ng-doc-node-details">
25
- {%- if inheritedFrom %}
26
- inherited from <code>{{ inheritedFrom.getName() }}</code>
27
- {%- elseif overriddenMember %}
28
- overrides <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
29
- {%- elseif implementedMember %}
30
- implements <code>{{ (implementedMember | getMemberParent).getName() }}</code>
31
- {%- endif %}
32
- </div>
33
- </th>
34
- </tr>
35
- </thead>
36
- <tbody>
37
- <tr>
38
- <td>
39
- {% set description = docNode | extractDocs %}
16
+ <div class="ng-doc-table-wrapper">
17
+ <table class="ng-doc-method-table">
18
+ <thead>
19
+ <tr>
20
+ <th indexable="false">
21
+ {{ decoratorsMacro.render(method.getDecorators()) if method.getDecorators }}
22
+ {{ tagsMacro.render(method, 'modifier') }}
23
+ <h3 dataSlugType="member">{{ method.getName() }}()</h3>
24
+ <div class="ng-doc-node-details">
25
+ {%- if inheritedFrom %}
26
+ inherited from <code>{{ inheritedFrom.getName() }}</code>
27
+ {%- elseif overriddenMember %}
28
+ overrides <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
29
+ {%- elseif implementedMember %}
30
+ implements <code>{{ (implementedMember | getMemberParent).getName() }}</code>
31
+ {%- endif %}
32
+ </div>
33
+ </th>
34
+ </tr>
35
+ </thead>
36
+ <tbody>
37
+ <tr>
38
+ <td>
39
+ {% set description = docNode | extractDocs %}
40
40
 
41
- {{ description if description else noContentMacro.render('No documentation has been provided.') }}
42
- </td>
43
- </tr>
44
- <tr>
45
- <td>
46
- <h5 class="no-anchor" indexable="false">Presentation</h5>
47
- {{ codeMacro.render(method | methodPresentation, "typescript", false) }}
48
- </td>
49
- </tr>
50
- <tr>
51
- <td>
52
- {%- if parameters.length %}
53
- <h5 class="no-anchor" indexable="false">Parameters</h5>
54
- {{ parametersMacro.render(parameters, docNode) }}
55
- {%- endif %}
56
- <h5 class="no-anchor" indexable="false">Returns</h5>
57
- <p>
58
- {{ typeMacro.returnType(method) }}
59
- </p>
60
- </td>
61
- </tr>
62
- </tbody>
63
- </table>
64
- </div>
41
+ {{ description if description else noContentMacro.render('No documentation has been provided.') }}
42
+ </td>
43
+ </tr>
44
+ <tr>
45
+ <td>
46
+ <h5 class="no-anchor" indexable="false">Presentation</h5>
47
+ {{ codeMacro.render(method | methodPresentation, "typescript", false) }}
48
+ </td>
49
+ </tr>
50
+ <tr>
51
+ <td>
52
+ {%- if parameters.length %}
53
+ <h5 class="no-anchor" indexable="false">Parameters</h5>
54
+ {{ parametersMacro.render(parameters, docNode) }}
55
+ {%- endif %}
56
+ <h5 class="no-anchor" indexable="false">Returns</h5>
57
+ <p>
58
+ {{ typeMacro.returnType(method) }}
59
+ </p>
60
+ </td>
61
+ </tr>
62
+ </tbody>
63
+ </table>
64
+ </div>
65
65
  {% endmacro %}
@@ -1,7 +1,7 @@
1
1
  {% import "helpers/method.html.nunj" as method %}
2
2
 
3
3
  {% macro render(methods, originalParent) %}
4
- {%- for m in methods %}
5
- {{ method.render(m, originalParent) }}
6
- {% endfor -%}
4
+ {%- for m in methods %}
5
+ {{ method.render(m, originalParent) }}
6
+ {% endfor -%}
7
7
  {% endmacro %}
@@ -1,4 +1,4 @@
1
1
  {%- macro render(content, attributeOverride) -%}
2
- <span class="ng-doc-modifier" indexable="false"
3
- data-content="{{ attributeOverride if attributeOverride else content }}">{{ content }}</span>
2
+ <span class="ng-doc-modifier" indexable="false"
3
+ data-content="{{ attributeOverride if attributeOverride else content }}">{{ content }}</span>
4
4
  {%- endmacro -%}
@@ -1,3 +1,3 @@
1
1
  {%- macro render(content) -%}
2
- <span class="ng-doc-no-content" indexable="false">{{ content }}</span>
2
+ <span class="ng-doc-no-content" indexable="false">{{ content }}</span>
3
3
  {%- endmacro -%}
@@ -3,42 +3,42 @@
3
3
  {% import "helpers/decorators.html.nunj" as decoratorsMacro %}
4
4
 
5
5
  {% macro render(parameters, origin, slugger) %}
6
- <div class="ng-doc-table-wrapper">
7
- <table class="ng-doc-parameters-table">
8
- <thead>
9
- <tr indexable="false">
10
- <th class="ng-doc-parameters-table-name">Name</th>
11
- <th class="ng-doc-parameters-table-type">Type</th>
12
- <th class="ng-doc-parameters-table-description">Description</th>
13
- </tr>
14
- </thead>
15
- <tbody>
16
- {%- for param in parameters %}
17
- {% set paramChain = param | getPropertyChain %}
18
- {% set inheritedFrom = param | getInheritedParent(origin) %}
19
- {% set overriddenMember = param | getOverriddenMember %}
20
- {% set implementedMember = param | getImplementedMember %}
21
- {% set docNode = paramChain | firstNodeWithComment %}
6
+ <div class="ng-doc-table-wrapper">
7
+ <table class="ng-doc-parameters-table">
8
+ <thead>
9
+ <tr indexable="false">
10
+ <th class="ng-doc-parameters-table-name">Name</th>
11
+ <th class="ng-doc-parameters-table-type">Type</th>
12
+ <th class="ng-doc-parameters-table-description">Description</th>
13
+ </tr>
14
+ </thead>
15
+ <tbody>
16
+ {%- for param in parameters %}
17
+ {% set paramChain = param | getPropertyChain %}
18
+ {% set inheritedFrom = param | getInheritedParent(origin) %}
19
+ {% set overriddenMember = param | getOverriddenMember %}
20
+ {% set implementedMember = param | getImplementedMember %}
21
+ {% set docNode = paramChain | firstNodeWithComment %}
22
22
 
23
- <tr {{ 'dataSlug="'+param.getName()+'" dataSlugType="member"' if slugger }}>
24
- <td indexable="false">
25
- {{ decoratorsMacro.render(param.getDecorators(), true) if param.getDecorators }}
26
- {{ tagsMacro.render(param, "badge") }}{{ param.getName() }}
27
- <div class="ng-doc-node-details">
28
- {%- if inheritedFrom %}
29
- inherited from <code>{{ inheritedFrom.getName() }}</code>
30
- {%- elseif overriddenMember %}
31
- overrides <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
32
- {%- elseif implementedMember %}
33
- implements <code>{{ (implementedMember | getMemberParent).getName() }}</code>
34
- {%- endif %}
35
- </div>
36
- </td>
37
- <td>{{ typeMacro.type(param) }}</td>
38
- <td>{{ origin | extractParameterDocs(param.getName()) }}</td>
39
- </tr>
40
- {%- endfor %}
41
- </tbody>
42
- </table>
43
- </div>
23
+ <tr {{ 'dataSlug="'+param.getName()+'" dataSlugType="member"' if slugger }}>
24
+ <td indexable="false">
25
+ {{ decoratorsMacro.render(param.getDecorators(), true) if param.getDecorators }}
26
+ {{ tagsMacro.render(param, "badge") }}{{ param.getName() }}
27
+ <div class="ng-doc-node-details">
28
+ {%- if inheritedFrom %}
29
+ inherited from <code>{{ inheritedFrom.getName() }}</code>
30
+ {%- elseif overriddenMember %}
31
+ overrides <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
32
+ {%- elseif implementedMember %}
33
+ implements <code>{{ (implementedMember | getMemberParent).getName() }}</code>
34
+ {%- endif %}
35
+ </div>
36
+ </td>
37
+ <td>{{ typeMacro.type(param) }}</td>
38
+ <td>{{ origin | extractParameterDocs(param.getName()) }}</td>
39
+ </tr>
40
+ {%- endfor %}
41
+ </tbody>
42
+ </table>
43
+ </div>
44
44
  {% endmacro %}
@@ -3,42 +3,42 @@
3
3
  {% import "helpers/decorators.html.nunj" as decoratorsMacro %}
4
4
 
5
5
  {% macro render(properties, origin) %}
6
- <div class="ng-doc-table-wrapper">
7
- <table class="ng-doc-properties-table">
8
- <thead>
9
- <tr indexable="false">
10
- <th class="ng-doc-properties-table-name">Name</th>
11
- <th class="ng-doc-properties-table-type">Type</th>
12
- <th class="ng-doc-properties-table-description">Description</th>
13
- </tr>
14
- </thead>
15
- <tbody>
16
- {%- for property in properties %}
17
- {% set propertyChain = property | getPropertyChain %}
18
- {% set inheritedFrom = property | getInheritedParent(origin) %}
19
- {% set overriddenMember = property | getOverriddenMember %}
20
- {% set implementedMember = property | getImplementedMember %}
21
- {% set docNode = propertyChain | firstNodeWithComment %}
6
+ <div class="ng-doc-table-wrapper">
7
+ <table class="ng-doc-properties-table">
8
+ <thead>
9
+ <tr indexable="false">
10
+ <th class="ng-doc-properties-table-name">Name</th>
11
+ <th class="ng-doc-properties-table-type">Type</th>
12
+ <th class="ng-doc-properties-table-description">Description</th>
13
+ </tr>
14
+ </thead>
15
+ <tbody>
16
+ {%- for property in properties %}
17
+ {% set propertyChain = property | getPropertyChain %}
18
+ {% set inheritedFrom = property | getInheritedParent(origin) %}
19
+ {% set overriddenMember = property | getOverriddenMember %}
20
+ {% set implementedMember = property | getImplementedMember %}
21
+ {% set docNode = propertyChain | firstNodeWithComment %}
22
22
 
23
- <tr dataSlug="{{ property.getName() }}" dataSlugType="member">
24
- <td indexable="false">
25
- {{ decoratorsMacro.render(property.getDecorators(), true) if property.getDecorators }}
26
- {{ tagsMacro.render(property, "badge") }}{{ property.getName() }}
27
- <div class="ng-doc-node-details">
28
- {%- if inheritedFrom %}
29
- inherited from <code>{{ inheritedFrom.getName() }}</code>
30
- {%- elseif overriddenMember %}
31
- overrides <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
32
- {%- elseif implementedMember %}
33
- implements <code>{{ (implementedMember | getMemberParent).getName() }}</code>
34
- {%- endif %}
35
- </div>
36
- </td>
37
- <td>{{ typeMacro.type(property) }}</td>
38
- <td>{{ docNode | extractDocs }}</td>
39
- </tr>
40
- {%- endfor %}
41
- </tbody>
42
- </table>
43
- </div>
23
+ <tr dataSlug="{{ property.getName() }}" dataSlugType="member">
24
+ <td indexable="false">
25
+ {{ decoratorsMacro.render(property.getDecorators(), true) if property.getDecorators }}
26
+ {{ tagsMacro.render(property, "badge") }}{{ property.getName() }}
27
+ <div class="ng-doc-node-details">
28
+ {%- if inheritedFrom %}
29
+ inherited from <code>{{ inheritedFrom.getName() }}</code>
30
+ {%- elseif overriddenMember %}
31
+ overrides <code>{{ (overriddenMember | getMemberParent).getName() }}</code>
32
+ {%- elseif implementedMember %}
33
+ implements <code>{{ (implementedMember | getMemberParent).getName() }}</code>
34
+ {%- endif %}
35
+ </div>
36
+ </td>
37
+ <td>{{ typeMacro.type(property) }}</td>
38
+ <td>{{ docNode | extractDocs }}</td>
39
+ </tr>
40
+ {%- endfor %}
41
+ </tbody>
42
+ </table>
43
+ </div>
44
44
  {% endmacro %}
@@ -1,4 +1,4 @@
1
1
  {%- macro render(content, attributeOverride) -%}
2
- <span class="ng-doc-tag" indexable="false"
3
- data-content="{{ attributeOverride if attributeOverride else content }}">{{ content }}</span>
2
+ <span class="ng-doc-tag" indexable="false"
3
+ data-content="{{ attributeOverride if attributeOverride else content }}">{{ content }}</span>
4
4
  {%- endmacro -%}
@@ -1,7 +1,7 @@
1
1
  {% macro type(node) -%}
2
- <code indexable="false">{{ node | displayType | escape }}</code>
2
+ <code indexable="false">{{ node | displayType | escape }}</code>
3
3
  {%- endmacro %}
4
4
 
5
5
  {%- macro returnType(node) -%}
6
- <code indexable="false">{{ node | displayReturnType | escape }}</code>
6
+ <code indexable="false">{{ node | displayReturnType | escape }}</code>
7
7
  {%- endmacro %}
@@ -11,45 +11,45 @@ const pageContent: string = `{{ pageContent | toTemplateString }}`
11
11
 
12
12
 
13
13
  @Component({
14
- selector: 'ng-doc-page-{{ page.fullRoute | kebabCase }}',
15
- standalone: true,
16
- template: `<ng-doc-page></ng-doc-page>`,
17
- changeDetection: ChangeDetectionStrategy.OnPush,
18
- imports: [
19
- NgDocPageComponent,
20
- {%- if page.hasImports %}
21
- ...pageEntity.imports,
22
- {%- endif %}
23
- ...PLAYGROUND_COMPONENTS,
24
- ],
25
- providers: [
26
- {provide: NgDocRootPage, useExisting: DynamicComponent},
27
- PLAYGROUND_PROVIDERS,
28
- (pageEntity.providers ?? []),
29
- ],
14
+ selector: 'ng-doc-page-{{ page.fullRoute | kebabCase }}',
15
+ standalone: true,
16
+ template: `<ng-doc-page></ng-doc-page>`,
17
+ changeDetection: ChangeDetectionStrategy.OnPush,
18
+ imports: [
19
+ NgDocPageComponent,
20
+ {%- if page.hasImports %}
21
+ ...pageEntity.imports,
22
+ {%- endif %}
23
+ ...PLAYGROUND_COMPONENTS,
24
+ ],
25
+ providers: [
26
+ {provide: NgDocRootPage, useExisting: DynamicComponent},
27
+ PLAYGROUND_PROVIDERS,
28
+ (pageEntity.providers ?? []),
29
+ ],
30
30
  })
31
31
  export class DynamicComponent extends NgDocRootPage {
32
- readonly routePrefix: string = '{{ page.context.config.routePrefix }}';
33
- readonly pageType: NgDocPageType = 'guide';
34
- readonly pageContent: string = pageContent;
35
- {%- if page.editSourceFileUrl %}
36
- readonly editSourceFileUrl: string = '{{ page.editSourceFileUrl }}';
37
- {%- endif %}{%- if page.viewSourceFileUrl %}
38
- readonly viewSourceFileUrl: string = '{{ page.viewSourceFileUrl }}';
39
- {%- endif -%}
40
- readonly page?: NgDocPage = pageEntity;
41
- readonly demoAssets: NgDocDemoAssets = demoAssets;
32
+ readonly routePrefix: string = '{{ page.context.config.routePrefix }}';
33
+ readonly pageType: NgDocPageType = 'guide';
34
+ readonly pageContent: string = pageContent;
35
+ {%- if page.editSourceFileUrl %}
36
+ readonly editSourceFileUrl: string = '{{ page.editSourceFileUrl }}';
37
+ {%- endif %}{%- if page.viewSourceFileUrl %}
38
+ readonly viewSourceFileUrl: string = '{{ page.viewSourceFileUrl }}';
39
+ {%- endif -%}
40
+ readonly page?: NgDocPage = pageEntity;
41
+ readonly demoAssets: NgDocDemoAssets = demoAssets;
42
42
 
43
- constructor() {
44
- super();
45
- }
43
+ constructor() {
44
+ super();
45
+ }
46
46
  }
47
47
 
48
48
  const routes: Routes = [{
49
- ...(isRoute(pageEntity.route) ? pageEntity.route : {}),
50
- path: '',
51
- component: DynamicComponent,
52
- title: `{{ page.title | toTemplateString }}`,
49
+ ...(isRoute(pageEntity.route) ? pageEntity.route : {}),
50
+ path: '',
51
+ component: DynamicComponent,
52
+ title: `{{ page.title | toTemplateString }}`,
53
53
  }]
54
54
 
55
55
  export default routes;