@ng-doc/builder 22.0.0-beta.1 → 22.0.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.
- package/README.md +19 -28
- package/application/index.js +7 -2
- package/application/index.js.map +1 -1
- package/application/schema.json +11 -4
- package/builders.json +23 -13
- package/classes/observable-map.d.ts +1 -0
- package/classes/observable-map.js +14 -3
- package/classes/observable-map.js.map +1 -1
- package/classes/observable-set.js +2 -1
- package/classes/observable-set.js.map +1 -1
- package/dev-server/index.js +5 -3
- package/dev-server/index.js.map +1 -1
- package/engine/build-ng-doc.js +1 -16
- package/engine/build-ng-doc.js.map +1 -1
- package/engine/builders/api-list/api-list-component.builder.js +4 -4
- package/engine/builders/api-list/api-list-component.builder.js.map +1 -1
- package/engine/builders/api-list/api-page-template.builder.js +2 -2
- package/engine/builders/api-list/api-page-template.builder.js.map +1 -1
- package/engine/builders/global/keywords.builder.d.ts +1 -4
- package/engine/builders/global/keywords.builder.js +5 -9
- package/engine/builders/global/keywords.builder.js.map +1 -1
- package/engine/builders/global/search-indexes.builder.js +1 -1
- package/engine/builders/global/search-indexes.builder.js.map +1 -1
- package/engine/builders/helpers/create-entry-metadata.js +2 -1
- package/engine/builders/helpers/create-entry-metadata.js.map +1 -1
- package/engine/builders/helpers/create-import-path.js.map +1 -1
- package/engine/builders/helpers/get-entry-relative-path.js.map +1 -1
- package/engine/builders/page/demo-assets.builder.js +8 -5
- package/engine/builders/page/demo-assets.builder.js.map +1 -1
- package/engine/builders/page/playground.builder.js +1 -0
- package/engine/builders/page/playground.builder.js.map +1 -1
- package/engine/builders/shared/content.builder.js +3 -3
- package/engine/builders/shared/content.builder.js.map +1 -1
- package/engine/builders/shared/entry.builder.js +1 -13
- package/engine/builders/shared/entry.builder.js.map +1 -1
- package/engine/builders/shared/page-component.builder.js +16 -6
- package/engine/builders/shared/page-component.builder.js.map +1 -1
- package/engine/builders/shared/page-wrapper.builder.js +8 -5
- package/engine/builders/shared/page-wrapper.builder.js.map +1 -1
- package/engine/core/operators/distinct-pending.js.map +1 -1
- package/engine/core/operators/entries-emitter.js +2 -6
- package/engine/core/operators/entries-emitter.js.map +1 -1
- package/engine/core/operators/factory.js +1 -4
- package/engine/core/operators/factory.js.map +1 -1
- package/engine/core/operators/merge-factory.js +19 -17
- package/engine/core/operators/merge-factory.js.map +1 -1
- package/engine/core/operators/when-builders-done.js.map +1 -1
- package/engine/core/stores/index.d.ts +0 -1
- package/engine/core/stores/index.js +0 -1
- package/engine/core/stores/index.js.map +1 -1
- package/engine/core/triggers/on-dependencies-change.d.ts +1 -1
- package/engine/core/triggers/on-dependencies-change.js +2 -2
- package/engine/core/triggers/on-dependencies-change.js.map +1 -1
- package/engine/core/watcher/watch.js +19 -1
- package/engine/core/watcher/watch.js.map +1 -1
- package/engine/variables.d.ts +1 -0
- package/engine/variables.js +1 -0
- package/engine/variables.js.map +1 -1
- package/generator/artifacts/index.d.ts +317 -0
- package/generator/bootstrap/bin.d.ts +18 -0
- package/generator/bootstrap/bin.js +7274 -0
- package/generator/bootstrap/candidate-output-committer.d.ts +12 -0
- package/generator/bootstrap/cli.d.ts +42 -0
- package/generator/bootstrap/cli.js +7123 -0
- package/generator/bootstrap/constants.d.ts +4 -0
- package/generator/bootstrap/index.d.ts +111 -0
- package/generator/bootstrap/index.js +5020 -0
- package/generator/bootstrap/prerender-command.d.ts +31 -0
- package/generator/bootstrap/process-tree.d.ts +49 -0
- package/generator/build-metafile.json +11701 -0
- package/generator/build-provenance.json +119 -0
- package/generator/compiler/assemble.d.ts +41 -0
- package/generator/compiler/classify.d.ts +161 -0
- package/generator/compiler/closure-store.d.ts +55 -0
- package/generator/compiler/common.d.ts +32 -0
- package/generator/compiler/describe.d.ts +21 -0
- package/generator/compiler/dry-run.d.ts +108 -0
- package/generator/compiler/fast-start.d.ts +104 -0
- package/generator/compiler/fold.d.ts +116 -0
- package/generator/compiler/index.d.ts +111 -0
- package/generator/compiler/index.js +17759 -0
- package/generator/compiler/link.d.ts +38 -0
- package/generator/compiler/memo.d.ts +44 -0
- package/generator/compiler/plan.d.ts +92 -0
- package/generator/compiler/progress.d.ts +54 -0
- package/generator/compiler/render.d.ts +27 -0
- package/generator/compiler/retention.d.ts +181 -0
- package/generator/compiler/semantic-closure.d.ts +46 -0
- package/generator/compiler/targeted.d.ts +280 -0
- package/generator/content/content-compiler.d.ts +118 -0
- package/generator/content/highlight-cache.d.ts +139 -0
- package/generator/content/html-pipeline.d.ts +170 -0
- package/generator/content/html-pool.d.ts +239 -0
- package/generator/content/html-worker.js +1598 -0
- package/generator/content-module-ids.d.ts +8 -0
- package/generator/contracts.d.ts +1063 -0
- package/generator/contracts.js +15 -0
- package/generator/discovery/index.d.ts +77 -0
- package/generator/graph/index.d.ts +211 -0
- package/generator/graph/unit-index.d.ts +216 -0
- package/generator/kernel/canonical.d.ts +57 -0
- package/generator/kernel/flags.d.ts +49 -0
- package/generator/kernel/footprint.d.ts +88 -0
- package/generator/kernel/observations.d.ts +68 -0
- package/generator/kernel/paths.d.ts +22 -0
- package/generator/kernel/runtime-identity.d.ts +11 -0
- package/generator/outputs/index.d.ts +67 -0
- package/generator/package.json +3 -0
- package/generator/progress/ci.d.ts +22 -0
- package/generator/progress/detect.d.ts +60 -0
- package/generator/progress/events.d.ts +126 -0
- package/generator/progress/format.d.ts +83 -0
- package/generator/progress/gate.d.ts +49 -0
- package/generator/progress/host.d.ts +29 -0
- package/generator/progress/lines.d.ts +42 -0
- package/generator/progress/live.d.ts +115 -0
- package/generator/progress/model.d.ts +85 -0
- package/generator/progress/reporter.d.ts +87 -0
- package/generator/progress/settings.d.ts +60 -0
- package/generator/semantic/angular.d.ts +9 -0
- package/generator/semantic/api-enumeration.d.ts +19 -0
- package/generator/semantic/api-summary.d.ts +33 -0
- package/generator/semantic/dependencies.d.ts +20 -0
- package/generator/semantic/derived-classes.d.ts +58 -0
- package/generator/semantic/documentation-cache.d.ts +23 -0
- package/generator/semantic/fragments.d.ts +28 -0
- package/generator/semantic/owned-roots.d.ts +59 -0
- package/generator/semantic/program-builder.d.ts +55 -0
- package/generator/semantic/program-index.d.ts +124 -0
- package/generator/semantic/program-inputs.d.ts +26 -0
- package/generator/semantic/program-observations.d.ts +158 -0
- package/generator/semantic/program-retention.d.ts +147 -0
- package/generator/semantic/program-state.d.ts +196 -0
- package/generator/semantic/program-verify.d.ts +22 -0
- package/generator/semantic/recorder.d.ts +89 -0
- package/generator/semantic/rendering.d.ts +34 -0
- package/generator/semantic/semantic-closure.d.ts +129 -0
- package/generator/semantic/semantic-service.d.ts +186 -0
- package/generator/semantic/type-text.d.ts +5 -0
- package/generator/session/build-session.d.ts +206 -0
- package/generator/session/input-verification.d.ts +38 -0
- package/generator/session/parcel-event-source.d.ts +22 -0
- package/generator/session/progress.d.ts +72 -0
- package/generator/session/unchanged-saves.d.ts +63 -0
- package/generator/session/watch-inputs.d.ts +6 -0
- package/generator/session/watch-signals.d.ts +10 -0
- package/generator/templates/api/base.html.nunj +26 -0
- package/generator/templates/api/class-declaration.html.nunj +57 -0
- package/generator/templates/api/details/class-declaration.html.nunj +47 -0
- package/generator/templates/api/details/enum-declaration.html.nunj +0 -0
- package/generator/templates/api/details/function-declaration.html.nunj +14 -0
- package/generator/templates/api/details/helpers/decorators.html.nunj +14 -0
- package/generator/templates/api/details/helpers/extends.html.nunj +6 -0
- package/generator/templates/api/details/helpers/selectors.html.nunj +12 -0
- package/generator/templates/api/details/helpers/type-parameters.html.nunj +14 -0
- package/generator/templates/api/details/interface-declaration.html.nunj +27 -0
- package/generator/templates/api/details/type-alias-declaration.html.nunj +14 -0
- package/generator/templates/api/details/variable-declaration.html.nunj +0 -0
- package/generator/templates/api/details.html.nunj +9 -0
- package/generator/templates/api/enum-declaration.html.nunj +12 -0
- package/generator/templates/api/function-declaration.html.nunj +35 -0
- package/generator/templates/api/interface-declaration.html.nunj +37 -0
- package/generator/templates/api/type-alias-declaration.html.nunj +16 -0
- package/generator/templates/api/variable-declaration.html.nunj +8 -0
- package/generator/templates/api-header.html.nunj +11 -0
- package/generator/templates/api-list.ts.nunj +22 -0
- package/generator/templates/api-page-content.html.nunj +1 -0
- package/generator/templates/api-scope.ts.nunj +22 -0
- package/generator/templates/category.ts.nunj +22 -0
- package/generator/templates/code.html.nunj +3 -0
- package/generator/templates/context.ts.nunj +55 -0
- package/generator/templates/demo-assets.ts.nunj +25 -0
- package/generator/templates/helpers/accessor.html.nunj +76 -0
- package/generator/templates/helpers/accessors.html.nunj +7 -0
- package/generator/templates/helpers/badge.html.nunj +4 -0
- package/generator/templates/helpers/call-signature.html.nunj +70 -0
- package/generator/templates/helpers/code.html.nunj +3 -0
- package/generator/templates/helpers/constructor.html.nunj +32 -0
- package/generator/templates/helpers/declaration-modifiers.html.nunj +45 -0
- package/generator/templates/helpers/decorators.html.nunj +11 -0
- package/generator/templates/helpers/members.html.nunj +29 -0
- package/generator/templates/helpers/method.html.nunj +89 -0
- package/generator/templates/helpers/methods.html.nunj +7 -0
- package/generator/templates/helpers/modifier.html.nunj +4 -0
- package/generator/templates/helpers/no-content.html.nunj +3 -0
- package/generator/templates/helpers/overload.html.nunj +57 -0
- package/generator/templates/helpers/parameters.html.nunj +44 -0
- package/generator/templates/helpers/properties.html.nunj +61 -0
- package/generator/templates/helpers/status.html.nunj +33 -0
- package/generator/templates/helpers/tag.html.nunj +4 -0
- package/generator/templates/helpers/type.html.nunj +11 -0
- package/generator/templates/index.ts.nunj +2 -0
- package/generator/templates/page-header.html.nunj +5 -0
- package/generator/templates/page-wrapper.ts.nunj +64 -0
- package/generator/templates/page.ts.nunj +97 -0
- package/generator/templates/parts/examples.html.nunj +11 -0
- package/generator/templates/parts/member-examples.html.nunj +12 -0
- package/generator/templates/parts/member-remarks.html.nunj +8 -0
- package/generator/templates/parts/page-tags.html.nunj +10 -0
- package/generator/templates/parts/remarks.html.nunj +10 -0
- package/generator/templates/parts/see-also.html.nunj +23 -0
- package/generator/templates/parts/usage-notes.html.nunj +8 -0
- package/generator/templates/playgrounds.ts.nunj +63 -0
- package/generator/templates/routes.ts.nunj +49 -0
- package/generator/templates/symbol/decorators.html.nunj +12 -0
- package/generator/templates/symbol/details.html.nunj +62 -0
- package/generator/templates/symbol/extended-by.html.nunj +17 -0
- package/generator/templates/symbol/header.html.nunj +22 -0
- package/generator/templates/symbol/members.html.nunj +301 -0
- package/generator/templates/symbol/page.html.nunj +76 -0
- package/generator/templates/symbol/see-also.html.nunj +16 -0
- package/generator/vite/angular/ANALOG-LICENSE +21 -0
- package/generator/vite/angular/analog-provenance.json +880 -0
- package/generator/vite/angular/index.d.ts +14 -0
- package/generator/vite/angular/index.js +7300 -0
- package/generator/vite/angular-compatibility.d.ts +6 -0
- package/generator/vite/angular-composition.d.ts +68 -0
- package/generator/vite/angular-version.d.ts +38 -0
- package/generator/vite/application-builder.js +331 -0
- package/generator/vite/application-builder.schema.json +46 -0
- package/generator/vite/application.d.ts +91 -0
- package/generator/vite/assets.d.ts +11 -0
- package/generator/vite/bounded-close.d.ts +33 -0
- package/generator/vite/component-updates.d.ts +21 -0
- package/generator/vite/configuration.d.ts +3 -0
- package/generator/vite/dev-server-builder.js +334 -0
- package/generator/vite/dev-server-builder.schema.json +27 -0
- package/generator/vite/dev-styles.d.ts +65 -0
- package/generator/vite/diagnostics.d.ts +4 -0
- package/generator/vite/external-probes.d.ts +40 -0
- package/generator/vite/host-updates.d.ts +145 -0
- package/generator/vite/index.d.ts +13 -0
- package/generator/vite/index.js +11589 -0
- package/generator/vite/lease.d.ts +6 -0
- package/generator/vite/lifecycle.d.ts +119 -0
- package/generator/vite/mime.d.ts +2 -0
- package/generator/vite/missing-paths.d.ts +44 -0
- package/generator/vite/options.d.ts +87 -0
- package/generator/vite/output-watch.d.ts +41 -0
- package/generator/vite/paths.d.ts +7 -0
- package/generator/vite/plugin.d.ts +3 -0
- package/generator/vite/prerender-entry.js +395 -0
- package/generator/vite/prerender-runtime.d.ts +66 -0
- package/generator/vite/prerender.d.ts +27 -0
- package/generator/vite/production.d.ts +66 -0
- package/generator/vite/progress.d.ts +33 -0
- package/generator/vite/restore-theme.js +13 -0
- package/generator/vite/route-inventory.d.ts +24 -0
- package/generator/vite/ssr-renderer-control.d.ts +1 -0
- package/generator/vite/ssr-renderer-entry.js +444 -0
- package/generator/vite/ssr-renderer-protocol.d.ts +101 -0
- package/generator/vite/ssr-renderer.d.ts +74 -0
- package/generator/vite/theme-index.d.ts +13 -0
- package/generator/vite/tsconfig-paths.d.ts +64 -0
- package/generator/vite/vite-event-source.d.ts +198 -0
- package/generator/vite/vite-version.d.ts +26 -0
- package/generator/vite/watch-inputs.d.ts +39 -0
- package/generator/worker/entry.d.ts +1 -0
- package/generator/worker/entry.js +614 -0
- package/generator/worker/index.d.ts +156 -0
- package/generator/worker/index.js +1030 -0
- package/generator/worker/protocol.d.ts +160 -0
- package/helpers/angular/get-component-decorator.js +6 -6
- package/helpers/angular/get-component-decorator.js.map +1 -1
- package/helpers/angular/get-directive-decorator.js +3 -3
- package/helpers/angular/get-directive-decorator.js.map +1 -1
- package/helpers/angular/get-pipe-decorator.js +3 -3
- package/helpers/angular/get-pipe-decorator.js.map +1 -1
- package/helpers/build-indexes.js +5 -2
- package/helpers/build-indexes.js.map +1 -1
- package/helpers/construct-page-keyword.js +2 -1
- package/helpers/construct-page-keyword.js.map +1 -1
- package/helpers/extract-selectors.d.ts +1 -1
- package/helpers/extract-selectors.js +5 -3
- package/helpers/extract-selectors.js.map +1 -1
- package/helpers/filter-useless-members.d.ts +1 -1
- package/helpers/format-code.d.ts +2 -1
- package/helpers/format-code.js +13 -4
- package/helpers/format-code.js.map +1 -1
- package/helpers/import-fresh-esm.js.map +1 -1
- package/helpers/index.d.ts +2 -0
- package/helpers/index.js +2 -0
- package/helpers/index.js.map +1 -1
- package/helpers/keyword-heading-title.d.ts +7 -0
- package/helpers/keyword-heading-title.js +21 -0
- package/helpers/keyword-heading-title.js.map +1 -0
- package/helpers/markdown-to-html.js +3 -3
- package/helpers/markdown-to-html.js.map +1 -1
- package/helpers/navigation-title-order.d.ts +8 -0
- package/helpers/navigation-title-order.js +15 -0
- package/helpers/navigation-title-order.js.map +1 -0
- package/helpers/playground/get-playground-inputs.js +8 -4
- package/helpers/playground/get-playground-inputs.js.map +1 -1
- package/helpers/playground/get-playground-template-inputs.js +2 -1
- package/helpers/playground/get-playground-template-inputs.js.map +1 -1
- package/helpers/presentation.d.ts +7 -7
- package/helpers/presentation.js +23 -23
- package/helpers/presentation.js.map +1 -1
- package/helpers/print.js +32 -5
- package/helpers/print.js.map +1 -1
- package/helpers/process-snippets.d.ts +1 -1
- package/helpers/process-snippets.js +3 -3
- package/helpers/process-snippets.js.map +1 -1
- package/helpers/snippets-from-asset.d.ts +1 -1
- package/helpers/snippets-from-asset.js +2 -2
- package/helpers/snippets-from-asset.js.map +1 -1
- package/helpers/sort-navigation-entities.js +2 -1
- package/helpers/sort-navigation-entities.js.map +1 -1
- package/helpers/stable-generated-id.d.ts +2 -0
- package/helpers/stable-generated-id.js +12 -0
- package/helpers/stable-generated-id.js.map +1 -0
- package/helpers/text-order.d.ts +8 -0
- package/helpers/text-order.js +26 -0
- package/helpers/text-order.js.map +1 -0
- package/helpers/typescript/member/get-inherited-parent.d.ts +1 -1
- package/helpers/typescript/member/get-inherited-parent.js +2 -2
- package/helpers/typescript/member/get-inherited-parent.js.map +1 -1
- package/helpers/typescript/node/sort-by-nodes-name.d.ts +4 -2
- package/helpers/typescript/node/sort-by-nodes-name.js +6 -3
- package/helpers/typescript/node/sort-by-nodes-name.js.map +1 -1
- package/helpers/typescript/property/get-property-assignment.js.map +1 -1
- package/interfaces/schema.d.ts +1 -0
- package/package.json +87 -30
- package/parsers/helpers/number.d.ts +1 -1
- package/parsers/helpers/number.js +2 -2
- package/parsers/helpers/number.js.map +1 -1
- package/parsers/helpers/param-value.d.ts +1 -1
- package/parsers/helpers/param-value.js +2 -2
- package/parsers/helpers/param-value.js.map +1 -1
- package/parsers/helpers/param.js +3 -3
- package/parsers/helpers/param.js.map +1 -1
- package/parsers/parse-code-block-params.d.ts +1 -1
- package/parsers/parse-code-block-params.js +22 -16
- package/parsers/parse-code-block-params.js.map +1 -1
- package/parsers/parse-snippet.js +10 -10
- package/parsers/parse-snippet.js.map +1 -1
- package/schematics/collection.json +34 -23
- package/schematics/migrate-to-vite/analyze.d.ts +76 -0
- package/schematics/migrate-to-vite/analyze.js +816 -0
- package/schematics/migrate-to-vite/analyze.js.map +1 -0
- package/schematics/migrate-to-vite/index.d.ts +9 -0
- package/schematics/migrate-to-vite/index.js +585 -0
- package/schematics/migrate-to-vite/index.js.map +1 -0
- package/schematics/migrate-to-vite/legacy-folder.d.ts +84 -0
- package/schematics/migrate-to-vite/legacy-folder.js +340 -0
- package/schematics/migrate-to-vite/legacy-folder.js.map +1 -0
- package/schematics/migrate-to-vite/report.d.ts +32 -0
- package/schematics/migrate-to-vite/report.js +97 -0
- package/schematics/migrate-to-vite/report.js.map +1 -0
- package/schematics/migrate-to-vite/schema.d.ts +13 -0
- package/schematics/migrate-to-vite/schema.js +3 -0
- package/schematics/migrate-to-vite/schema.js.map +1 -0
- package/schematics/migrate-to-vite/schema.json +31 -0
- package/schematics/migrate-to-vite/setup/dependencies.d.ts +64 -0
- package/schematics/migrate-to-vite/setup/dependencies.js +183 -0
- package/schematics/migrate-to-vite/setup/dependencies.js.map +1 -0
- package/schematics/migrate-to-vite/setup/index.d.ts +6 -0
- package/schematics/migrate-to-vite/setup/index.js +13 -0
- package/schematics/migrate-to-vite/setup/index.js.map +1 -0
- package/schematics/migrate-to-vite/setup/json-file.d.ts +51 -0
- package/schematics/migrate-to-vite/setup/json-file.js +115 -0
- package/schematics/migrate-to-vite/setup/json-file.js.map +1 -0
- package/schematics/migrate-to-vite/setup/source.d.ts +30 -0
- package/schematics/migrate-to-vite/setup/source.js +202 -0
- package/schematics/migrate-to-vite/setup/source.js.map +1 -0
- package/schematics/migrate-to-vite/setup/targets.d.ts +51 -0
- package/schematics/migrate-to-vite/setup/targets.js +48 -0
- package/schematics/migrate-to-vite/setup/targets.js.map +1 -0
- package/schematics/migrate-to-vite/setup/vite-config.d.ts +100 -0
- package/schematics/migrate-to-vite/setup/vite-config.js +175 -0
- package/schematics/migrate-to-vite/setup/vite-config.js.map +1 -0
- package/schematics/migrate-to-vite/setup/workspace.d.ts +100 -0
- package/schematics/migrate-to-vite/setup/workspace.js +225 -0
- package/schematics/migrate-to-vite/setup/workspace.js.map +1 -0
- package/schematics/migrate-to-vite/state.d.ts +65 -0
- package/schematics/migrate-to-vite/state.js +92 -0
- package/schematics/migrate-to-vite/state.js.map +1 -0
- package/schematics/migrate-to-vite/testing/fixtures.d.ts +18 -0
- package/schematics/migrate-to-vite/testing/fixtures.js +279 -0
- package/schematics/migrate-to-vite/testing/fixtures.js.map +1 -0
- package/schematics/migrate-to-vite/update-note.d.ts +6 -0
- package/schematics/migrate-to-vite/update-note.js +23 -0
- package/schematics/migrate-to-vite/update-note.js.map +1 -0
- package/schematics/migration.json +5 -0
- package/schematics/migrations/standalone-pages/index.js +7 -6
- package/schematics/migrations/standalone-pages/index.js.map +1 -1
- package/schematics/vite-setup/index.d.ts +20 -0
- package/schematics/vite-setup/index.js +206 -0
- package/schematics/vite-setup/index.js.map +1 -0
- package/schematics/vite-setup/schema.d.ts +7 -0
- package/schematics/vite-setup/schema.js +3 -0
- package/schematics/vite-setup/schema.js.map +1 -0
- package/schematics/vite-setup/schema.json +19 -0
- package/scripts/restore-theme.js +9 -2
- package/templates/context.ts.nunj +3 -0
- package/templates/helpers/badge.html.nunj +1 -1
- package/templates/helpers/status.html.nunj +4 -8
- package/templates/page-wrapper.ts.nunj +24 -1
- package/templates/page.ts.nunj +25 -0
- package/templates/parts/page-tags.html.nunj +1 -1
- package/templates/playgrounds.ts.nunj +8 -9
- package/templates/routes.ts.nunj +6 -1
- package/templates/symbol/decorators.html.nunj +12 -0
- package/templates/symbol/details.html.nunj +62 -0
- package/templates/symbol/extended-by.html.nunj +17 -0
- package/templates/symbol/header.html.nunj +22 -0
- package/templates/symbol/members.html.nunj +301 -0
- package/templates/symbol/page.html.nunj +76 -0
- package/templates/symbol/see-also.html.nunj +16 -0
- package/engine/.cache/apps/ng-doc/docs/api-documentation/auto-generation/ng-doc.page.mjs +0 -20
- package/engine/.cache/apps/ng-doc/docs/api-documentation/documenting-declarations/ng-doc.page.mjs +0 -20
- package/engine/.cache/apps/ng-doc/docs/api-documentation/rendering-api/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/icons/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/layout/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/page-processors/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/page-skeleton/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/search/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/customization/themes/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/develop/ng-doc.page.mjs +0 -36
- package/engine/.cache/apps/ng-doc/docs/getting-started/configuration/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/getting-started/installation/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/getting-started/migrations/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/getting-started/ssr/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/getting-started/what-is-ng-doc/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/ng-doc.api.mjs +0 -42
- package/engine/.cache/apps/ng-doc/docs/recipes/ignoring-file-lines/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/recipes/performance/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/writing-content/blockquotes/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/code-blocks/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/demo-and-demo-pane/ng-doc.page.mjs +0 -19
- package/engine/.cache/apps/ng-doc/docs/writing-content/images-videos-and-embeds/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/keywords/ng-doc.page.mjs +0 -17
- package/engine/.cache/apps/ng-doc/docs/writing-content/mermaid-diagrams/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/nunjucks/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/pages-and-categories/ng-doc.page.mjs +0 -18
- package/engine/.cache/apps/ng-doc/docs/writing-content/playground/ng-doc.page.mjs +0 -33
- package/engine/core/stores/entry-status.d.ts +0 -23
- package/engine/core/stores/entry-status.js +0 -36
- package/engine/core/stores/entry-status.js.map +0 -1
|
@@ -0,0 +1,301 @@
|
|
|
1
|
+
{#-
|
|
2
|
+
The members of a class or an interface as one table, which the `ng-doc-members` host filters by
|
|
3
|
+
group and name at runtime. Every group row holds the heading and every member row the anchor
|
|
4
|
+
that the per-section layout rendered (same ids, titles and anchor types), so page keywords and
|
|
5
|
+
links do not change. Only the chevron and the name of an expandable row form its button.
|
|
6
|
+
-#}
|
|
7
|
+
{% import "helpers/type.html.nunj" as typeMacro %}
|
|
8
|
+
{% import "helpers/badge.html.nunj" as badgeMacro %}
|
|
9
|
+
{% import "helpers/status.html.nunj" as statusMacro %}
|
|
10
|
+
{% import "helpers/code.html.nunj" as codeMacro %}
|
|
11
|
+
{% import "helpers/parameters.html.nunj" as parametersMacro %}
|
|
12
|
+
{% import "helpers/overload.html.nunj" as overloadMacro %}
|
|
13
|
+
{% import "symbol/decorators.html.nunj" as decoratorsMacro %}
|
|
14
|
+
|
|
15
|
+
{% macro chevron() -%}
|
|
16
|
+
<svg class="ng-doc-member-chevron" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="m9 18 6-6-6-6"></path></svg>
|
|
17
|
+
{%- endmacro %}
|
|
18
|
+
|
|
19
|
+
{% macro description(node, docNode) -%}
|
|
20
|
+
<div class="ng-doc-api-status">{{ statusMacro.render(node) }}</div>
|
|
21
|
+
{%- set text = docNode | getJsDocDescription %}
|
|
22
|
+
{%- if text %}
|
|
23
|
+
{{ text }}
|
|
24
|
+
{%- else %}
|
|
25
|
+
<span class="ng-doc-members-none" indexable="false" aria-label="No documentation">—</span>
|
|
26
|
+
{%- endif %}
|
|
27
|
+
{%- set remarks = docNode | getJsDocTags('remarks') %}
|
|
28
|
+
{%- if remarks.length %}
|
|
29
|
+
<div class="ng-doc-member-label" indexable="false">Notes</div>
|
|
30
|
+
{%- for remark in remarks %}
|
|
31
|
+
{{ remark | markdownToHtml }}
|
|
32
|
+
{%- endfor %}
|
|
33
|
+
{%- endif %}
|
|
34
|
+
{%- endmacro %}
|
|
35
|
+
|
|
36
|
+
{% macro examples(docNode) -%}
|
|
37
|
+
{%- set items = docNode | getJsDocTags('example') %}
|
|
38
|
+
{%- if items.length %}
|
|
39
|
+
<div indexable="false">
|
|
40
|
+
<div class="ng-doc-member-label">Example usage</div>
|
|
41
|
+
{%- for example in items %}
|
|
42
|
+
{{ example }}
|
|
43
|
+
{%- endfor %}
|
|
44
|
+
</div>
|
|
45
|
+
{%- endif %}
|
|
46
|
+
{%- endmacro %}
|
|
47
|
+
|
|
48
|
+
{% macro tags(node, inheritedFrom, definedIn) -%}
|
|
49
|
+
{%- set isAbstract = node.isAbstract and node.isAbstract() %}
|
|
50
|
+
{%- set isStatic = node.isStatic and node.isStatic() %}
|
|
51
|
+
{%- set isAsync = node.isAsync and node.isAsync() %}
|
|
52
|
+
{%- set isReadonly = node.isReadonly and node.isReadonly() %}
|
|
53
|
+
{%- set isProtected = node.getScope and node.getScope() == 'protected' %}
|
|
54
|
+
{%- set overriddenMember = (node | getOverriddenMember) if node.getName %}
|
|
55
|
+
{%- set implementedMember = (node | getImplementedMember) if node.getName %}
|
|
56
|
+
{%- set signal = node | signalMember %}
|
|
57
|
+
{%- set decorators = node.getDecorators() if node.getDecorators else [] %}
|
|
58
|
+
<div class="ng-doc-member-tags" indexable="false">
|
|
59
|
+
{{- badgeMacro.render("protected") if isProtected }}
|
|
60
|
+
{{- badgeMacro.render("abstract") if isAbstract }}
|
|
61
|
+
{{- badgeMacro.render("static") if isStatic }}
|
|
62
|
+
{{- badgeMacro.render("async") if isAsync }}
|
|
63
|
+
{{- badgeMacro.render("readonly") if isReadonly }}
|
|
64
|
+
{%- if decorators.length or signal %}
|
|
65
|
+
<span class="ng-doc-decorators-group">
|
|
66
|
+
{%- for decorator in decorators %}{{ decoratorsMacro.chip(decorator.getName()) }}{% endfor -%}
|
|
67
|
+
{%- if signal %}<code data-ng-doc-decorator="{{ 'Output' if signal.kind == 'output' else 'Input' }}" data-ng-doc-signal="{{ signal.kind }}">{{ signal.kind }}()</code>{% endif -%}
|
|
68
|
+
</span>
|
|
69
|
+
{%- if signal and signal.required %}{{ badgeMacro.render("required") }}{% endif %}
|
|
70
|
+
{%- endif %}
|
|
71
|
+
{%- if definedIn %}
|
|
72
|
+
<span class="ng-doc-member-from">defined in <code>{{ definedIn.getName() }}</code></span>
|
|
73
|
+
{%- elseif inheritedFrom %}
|
|
74
|
+
<span class="ng-doc-member-from">inherited from <code>{{ inheritedFrom.getName() }}</code></span>
|
|
75
|
+
{%- elseif overriddenMember %}
|
|
76
|
+
<span class="ng-doc-member-from">overrides <code>{{ (overriddenMember | getMemberParent).getName() }}</code></span>
|
|
77
|
+
{%- elseif implementedMember %}
|
|
78
|
+
<span class="ng-doc-member-from">implements <code>{{ (implementedMember | getMemberParent).getName() }}</code></span>
|
|
79
|
+
{%- endif %}
|
|
80
|
+
</div>
|
|
81
|
+
{%- endmacro %}
|
|
82
|
+
|
|
83
|
+
{#- `definedIn` mode (type aliases) names the named type that declares a property, as the
|
|
84
|
+
per-section layout does; classes and interfaces name the parent it is inherited from. #}
|
|
85
|
+
{% macro propertyRow(property, group, origin, mode) -%}
|
|
86
|
+
{%- set inheritedFrom = none %}
|
|
87
|
+
{%- set definedIn = none %}
|
|
88
|
+
{%- if mode == 'definedIn' %}
|
|
89
|
+
{%- set parent = property | getDefinedInParent(origin) %}
|
|
90
|
+
{%- set definedIn = parent if (parent and (parent | isNamed)) else none %}
|
|
91
|
+
{%- else %}
|
|
92
|
+
{%- set inheritedFrom = property | getInheritedParent(origin) %}
|
|
93
|
+
{%- endif %}
|
|
94
|
+
{%- set docNode = property | getPropertyChain | firstNodeWithComment %}
|
|
95
|
+
<tr class="ng-doc-member {{ statusMacro.class(property) }}" data-group="{{ group }}" data-name="{{ property.getName() }}"{{ ' data-inherited' if inheritedFrom }} dataSlug="{{ property.getName() }}" dataSlugType="member">
|
|
96
|
+
<td class="ng-doc-member-declaration" indexable="false">
|
|
97
|
+
<div class="ng-doc-member-signature"><span class="ng-doc-member-name">{{ property.getName() }}</span>{{ '?' if property.hasQuestionToken and property.hasQuestionToken() }}: {{ typeMacro.type(property) }}</div>
|
|
98
|
+
{{ tags(property, inheritedFrom, definedIn) }}
|
|
99
|
+
</td>
|
|
100
|
+
<td class="ng-doc-member-description">
|
|
101
|
+
{{ description(property, docNode) }}
|
|
102
|
+
{{ examples(docNode) }}
|
|
103
|
+
</td>
|
|
104
|
+
</tr>
|
|
105
|
+
{%- endmacro %}
|
|
106
|
+
|
|
107
|
+
{% macro enumRow(member, group) -%}
|
|
108
|
+
<tr class="ng-doc-member {{ statusMacro.class(member) }}" data-group="{{ group }}" data-name="{{ member.getName() }}" dataSlug="{{ member.getName() }}" dataSlugType="member">
|
|
109
|
+
<td class="ng-doc-member-declaration" indexable="false">
|
|
110
|
+
<div class="ng-doc-member-signature"><span class="ng-doc-member-name">{{ member.getName() }}</span> = <code>{{ member.getValue() | dump | escape }}</code></div>
|
|
111
|
+
</td>
|
|
112
|
+
<td class="ng-doc-member-description">
|
|
113
|
+
{{ description(member, member) }}
|
|
114
|
+
</td>
|
|
115
|
+
</tr>
|
|
116
|
+
{%- endmacro %}
|
|
117
|
+
|
|
118
|
+
{% macro accessorRow(accessor, type, group, origin) -%}
|
|
119
|
+
{%- set inheritedFrom = accessor | getInheritedParent(origin) %}
|
|
120
|
+
{%- set docNode = accessor | getAccessorChain | firstNodeWithComment %}
|
|
121
|
+
<tr class="ng-doc-member {{ statusMacro.class(accessor) }}" data-group="{{ group }}" data-name="{{ accessor.getName() }}"{{ ' data-inherited' if inheritedFrom }} dataSlug="{{ type + '-' + accessor.getName() }}" dataSlugType="member" dataSlugTitle="{{ accessor.getName() }}">
|
|
122
|
+
<td class="ng-doc-member-declaration" indexable="false">
|
|
123
|
+
<div class="ng-doc-member-signature">{{ type }} <span class="ng-doc-member-name">{{ accessor.getName() }}</span>: {{ typeMacro.type(accessor) }}</div>
|
|
124
|
+
{{ tags(accessor, inheritedFrom) }}
|
|
125
|
+
</td>
|
|
126
|
+
<td class="ng-doc-member-description">
|
|
127
|
+
{{ description(accessor, docNode) }}
|
|
128
|
+
</td>
|
|
129
|
+
</tr>
|
|
130
|
+
{%- endmacro %}
|
|
131
|
+
|
|
132
|
+
{#- A row with a detail row: a method, the constructor or a call signature (`kind`). #}
|
|
133
|
+
{% macro callableRow(node, kind, name, slug, group, origin, presentation, detailId) -%}
|
|
134
|
+
{%- if kind == 'method' %}
|
|
135
|
+
{%- set docNode = node | getMethodChain | firstNodeWithComment %}
|
|
136
|
+
{%- elseif kind == 'call' %}
|
|
137
|
+
{%- set docNode = node | getCallSignatureChain | firstNodeWithComment %}
|
|
138
|
+
{%- else %}
|
|
139
|
+
{%- set docNode = node %}
|
|
140
|
+
{%- endif %}
|
|
141
|
+
{%- set inheritedFrom = none %}
|
|
142
|
+
{%- if kind != 'constructor' %}
|
|
143
|
+
{%- set inheritedFrom = node | getInheritedParent(origin) %}
|
|
144
|
+
{%- endif %}
|
|
145
|
+
{%- set parameters = node.getParameters() %}
|
|
146
|
+
{%- set overloads = node.getOverloads() if node.getOverloads else [] %}
|
|
147
|
+
{%- set returnsTag = docNode | getJsDocTag('returns') %}
|
|
148
|
+
<tr class="ng-doc-member {{ statusMacro.class(node) }}" data-group="{{ group }}" data-name="{{ name }}"{{ ' data-inherited' if inheritedFrom }}{% if kind != 'constructor' %} dataSlug="{{ slug }}" dataSlugType="method"{% endif %}>
|
|
149
|
+
<td class="ng-doc-member-declaration" indexable="false">
|
|
150
|
+
<div class="ng-doc-member-signature"><button type="button" class="ng-doc-member-expand" aria-expanded="false" aria-controls="{{ detailId }}" aria-label="{{ name }}: show the signature">{{ chevron() }}<span class="ng-doc-member-name">{{ name }}</span></button>({{ '…' if parameters.length }}){% if kind != 'constructor' %}: {{ typeMacro.returnType(node) }}{% endif %}</div>
|
|
151
|
+
{{ tags(node, inheritedFrom) }}
|
|
152
|
+
</td>
|
|
153
|
+
<td class="ng-doc-member-description">
|
|
154
|
+
{{ description(node, docNode) }}
|
|
155
|
+
</td>
|
|
156
|
+
</tr>
|
|
157
|
+
<tr class="ng-doc-member-detail" id="{{ detailId }}" data-group="{{ group }}" hidden>
|
|
158
|
+
<td colspan="2">
|
|
159
|
+
<div class="ng-doc-member-label" indexable="false">Signature</div>
|
|
160
|
+
{{ codeMacro.render(presentation, "typescript", false) }}
|
|
161
|
+
{%- if parameters.length %}
|
|
162
|
+
<div class="ng-doc-member-label" indexable="false">Parameters</div>
|
|
163
|
+
{{ parametersMacro.render(parameters, (node if kind == 'constructor' else docNode), kind == 'constructor') }}
|
|
164
|
+
{%- endif %}
|
|
165
|
+
{%- if kind != 'constructor' %}
|
|
166
|
+
<div class="ng-doc-member-label" indexable="false">Returns</div>
|
|
167
|
+
<div class="ng-doc-returns">
|
|
168
|
+
{{ typeMacro.returnType(node) }}
|
|
169
|
+
{%- if returnsTag.length %}
|
|
170
|
+
<span> - </span>
|
|
171
|
+
{{ returnsTag | markdownToHtml }}
|
|
172
|
+
{%- endif %}
|
|
173
|
+
</div>
|
|
174
|
+
{%- endif %}
|
|
175
|
+
{{ examples(docNode) }}
|
|
176
|
+
{%- if overloads.length %}
|
|
177
|
+
<div class="ng-doc-member-label" indexable="false">Overloads</div>
|
|
178
|
+
{{ overloadMacro.render(overloads) }}
|
|
179
|
+
{%- endif %}
|
|
180
|
+
</td>
|
|
181
|
+
</tr>
|
|
182
|
+
{%- endmacro %}
|
|
183
|
+
|
|
184
|
+
{#- The number of rows of a group: an accessor pair has a row per get and set. #}
|
|
185
|
+
{% macro count(group) -%}
|
|
186
|
+
{%- if group.kind == 'accessor' -%}
|
|
187
|
+
{%- set marks %}{% for pair in group.members %}{{ 'x' if pair.get }}{{ 'x' if pair.set }}{% endfor %}{% endset -%}
|
|
188
|
+
{{- marks | length -}}
|
|
189
|
+
{%- else -%}
|
|
190
|
+
{{- group.members.length -}}
|
|
191
|
+
{%- endif -%}
|
|
192
|
+
{%- endmacro %}
|
|
193
|
+
|
|
194
|
+
{% macro groupRow(group, title, total) -%}
|
|
195
|
+
<tr class="ng-doc-members-group" data-group="{{ group }}">
|
|
196
|
+
<td colspan="2"><h3 class="ng-doc-members-group-title">{{ title }}</h3><span class="ng-doc-members-count" indexable="false">{{ total }}</span></td>
|
|
197
|
+
</tr>
|
|
198
|
+
{%- endmacro %}
|
|
199
|
+
|
|
200
|
+
{% macro render(declaration) %}
|
|
201
|
+
{%- if Node.isClassDeclaration(declaration) %}
|
|
202
|
+
{%- set constructors = declaration.getConstructors() | filterByScope("public") | excludeByJsDocTags('internal') -%}
|
|
203
|
+
{%- set allProperties = declaration | getClassProperties | excludeByJsDocTags('internal') | filterByScope(["public", "protected"]) | filterUselessMembers | sortByNodesName -%}
|
|
204
|
+
{%- set allMethods = declaration | getClassMethods | excludeByJsDocTags('internal') | filterByScope(["public", "protected"]) | filterUselessMembers | sortByNodesName -%}
|
|
205
|
+
{%- set allAccessors = declaration | getClassAccessors | excludeByJsDocTags('internal') | filterByScope(["public", "protected"]) | filterUselessMembers | sortByNodesName -%}
|
|
206
|
+
{%- set staticProperties = allProperties | filterByStatic(true) -%}
|
|
207
|
+
{%- set properties = allProperties | filterByStatic(false) -%}
|
|
208
|
+
{%- set staticAccessors = allAccessors | filterByStatic(true) | groupAccessors -%}
|
|
209
|
+
{%- set accessors = allAccessors | filterByStatic(false) | groupAccessors -%}
|
|
210
|
+
{%- set staticMethods = allMethods | filterByStatic(true) -%}
|
|
211
|
+
{%- set methods = allMethods | filterByStatic(false) -%}
|
|
212
|
+
{%- set groups = [
|
|
213
|
+
{ id: 'constructor', title: 'Constructor', kind: 'constructor', members: constructors.slice(0, 1) },
|
|
214
|
+
{ id: 'static-properties', title: 'Static Properties', kind: 'property', members: staticProperties },
|
|
215
|
+
{ id: 'properties', title: 'Properties', kind: 'property', members: properties },
|
|
216
|
+
{ id: 'static-accessors', title: 'Static Accessors', kind: 'accessor', members: staticAccessors },
|
|
217
|
+
{ id: 'accessors', title: 'Accessors', kind: 'accessor', members: accessors },
|
|
218
|
+
{ id: 'static-methods', title: 'Static Methods', kind: 'method', members: staticMethods },
|
|
219
|
+
{ id: 'methods', title: 'Methods', kind: 'method', members: methods }
|
|
220
|
+
] -%}
|
|
221
|
+
{%- elseif Node.isInterfaceDeclaration(declaration) %}
|
|
222
|
+
{%- set properties = declaration | getInterfaceProperties | excludeByJsDocTags('internal') | filterUselessMembers | sortByNodesName -%}
|
|
223
|
+
{%- set accessors = declaration | getInterfaceAccessors | excludeByJsDocTags('internal') | filterUselessMembers | sortByNodesName | groupAccessors -%}
|
|
224
|
+
{%- set methods = declaration | getInterfaceMethods | excludeByJsDocTags('internal') | filterUselessMembers | sortByNodesName -%}
|
|
225
|
+
{%- set callSignatures = declaration | getInterfaceCallSignatures | excludeByJsDocTags('internal') -%}
|
|
226
|
+
{%- set groups = [
|
|
227
|
+
{ id: 'properties', title: 'Properties', kind: 'property', members: properties },
|
|
228
|
+
{ id: 'accessors', title: 'Accessors', kind: 'accessor', members: accessors },
|
|
229
|
+
{ id: 'methods', title: 'Methods', kind: 'method', members: methods },
|
|
230
|
+
{ id: 'call-signatures', title: 'Call Signatures', kind: 'call', members: callSignatures }
|
|
231
|
+
] -%}
|
|
232
|
+
{%- elseif Node.isTypeAliasDeclaration(declaration) %}
|
|
233
|
+
{%- set properties = declaration | getTypeAliasProperties | excludeByJsDocTags('internal') | filterUselessMembers | sortByNodesName -%}
|
|
234
|
+
{%- set groups = [{ id: 'properties', title: 'Properties', kind: 'defined-property', members: properties }] -%}
|
|
235
|
+
{%- elseif Node.isEnumDeclaration(declaration) %}
|
|
236
|
+
{%- set groups = [{ id: 'members', title: 'Members', kind: 'enum', members: declaration.getMembers() | excludeByJsDocTags('internal') }] -%}
|
|
237
|
+
{%- else %}
|
|
238
|
+
{%- set groups = [] -%}
|
|
239
|
+
{%- endif %}
|
|
240
|
+
{%- set populated = [] %}
|
|
241
|
+
{%- for group in groups %}{% if group.members.length %}{% set populated = (populated.push(group), populated) %}{% endif %}{% endfor %}
|
|
242
|
+
|
|
243
|
+
{%- set rows %}
|
|
244
|
+
{%- for group in groups %}
|
|
245
|
+
{%- if group.members.length %}
|
|
246
|
+
{{ groupRow(group.id, group.title, count(group)) }}
|
|
247
|
+
{%- for member in group.members %}
|
|
248
|
+
{%- if group.kind == 'property' %}
|
|
249
|
+
{{ propertyRow(member, group.id, declaration) }}
|
|
250
|
+
{%- elseif group.kind == 'defined-property' %}
|
|
251
|
+
{{ propertyRow(member, group.id, declaration, 'definedIn') }}
|
|
252
|
+
{%- elseif group.kind == 'enum' %}
|
|
253
|
+
{{ enumRow(member, group.id) }}
|
|
254
|
+
{%- elseif group.kind == 'accessor' %}
|
|
255
|
+
{{ accessorRow(member.get, 'get', group.id, declaration) if member.get }}
|
|
256
|
+
{{ accessorRow(member.set, 'set', group.id, declaration) if member.set }}
|
|
257
|
+
{%- elseif group.kind == 'method' %}
|
|
258
|
+
{{ callableRow(member, 'method', member.getName(), member.getName() + '()', group.id, declaration, member | methodPresentation, 'ng-doc-member-detail-' + group.id + '-' + member.getName()) }}
|
|
259
|
+
{%- elseif group.kind == 'constructor' %}
|
|
260
|
+
{{ callableRow(member, 'constructor', 'constructor', 'constructor', group.id, declaration, member | constructorPresentation, 'ng-doc-member-detail-constructor') }}
|
|
261
|
+
{%- else %}
|
|
262
|
+
{{ callableRow(member, 'call', 'Call Signature #' + loop.index, 'Call Signature #' + loop.index, group.id, declaration, member | callSignaturePresentation, 'ng-doc-member-detail-call-signature-' + loop.index) }}
|
|
263
|
+
{%- endif %}
|
|
264
|
+
{%- endfor %}
|
|
265
|
+
{%- endif %}
|
|
266
|
+
{%- endfor %}
|
|
267
|
+
{%- endset %}
|
|
268
|
+
|
|
269
|
+
{%- if rows | trim %}
|
|
270
|
+
{%- set total = rows.split('class="ng-doc-member ').length - 1 %}
|
|
271
|
+
{%- set inherited = rows.split(' data-inherited ').length - 1 %}
|
|
272
|
+
{#- An enum's only group is its members, whose row already holds the Members heading. #}
|
|
273
|
+
{%- if not (populated.length == 1 and populated[0].kind == 'enum') %}
|
|
274
|
+
<h2 id="ng-doc-members">Members</h2>
|
|
275
|
+
{%- endif %}
|
|
276
|
+
<ng-doc-members>
|
|
277
|
+
<div class="ng-doc-members-bar" indexable="false">
|
|
278
|
+
{%- if populated.length > 1 or inherited %}
|
|
279
|
+
<div class="ng-doc-members-tabs" role="tablist" aria-label="Filter members">
|
|
280
|
+
<button type="button" role="tab" data-ng-doc-members-tab="all" aria-selected="true">All <span class="ng-doc-members-count">{{ total }}</span></button>
|
|
281
|
+
{%- for group in groups %}
|
|
282
|
+
{%- if group.members.length %}
|
|
283
|
+
<button type="button" role="tab" data-ng-doc-members-tab="{{ group.id }}" aria-selected="false" tabindex="-1">{{ group.title }} <span class="ng-doc-members-count">{{ count(group) }}</span></button>
|
|
284
|
+
{%- endif %}
|
|
285
|
+
{%- endfor %}
|
|
286
|
+
{%- if inherited %}
|
|
287
|
+
<button type="button" role="tab" data-ng-doc-members-tab="inherited" aria-selected="false" tabindex="-1">Inherited <span class="ng-doc-members-count">{{ inherited }}</span></button>
|
|
288
|
+
{%- endif %}
|
|
289
|
+
</div>
|
|
290
|
+
{%- endif %}
|
|
291
|
+
<label class="ng-doc-members-filter"><svg width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M22 3H2l8 9.46V19l4 2v-8.54L22 3z"></path></svg><input type="text" placeholder="Filter by name" aria-label="Filter members by name" data-ng-doc-members-filter aria-keyshortcuts="F"></label>
|
|
292
|
+
</div>
|
|
293
|
+
<div class="ng-doc-members-table-wrapper">
|
|
294
|
+
<table class="ng-doc-members-table">
|
|
295
|
+
<tbody>{{ rows }}</tbody>
|
|
296
|
+
</table>
|
|
297
|
+
<div class="ng-doc-members-empty" indexable="false" hidden>No members match.</div>
|
|
298
|
+
</div>
|
|
299
|
+
</ng-doc-members>
|
|
300
|
+
{%- endif %}
|
|
301
|
+
{% endmacro %}
|
|
@@ -0,0 +1,76 @@
|
|
|
1
|
+
{#-
|
|
2
|
+
An API page in the symbol view: the description, the details (also in the right rail), the
|
|
3
|
+
declaration panel, the kind's own sections and the page-level notes, see-also, examples and
|
|
4
|
+
usage notes. Every heading and member anchor of the per-section layout
|
|
5
|
+
(`api-page-content.html.nunj`) is kept, so page keywords and links do not change: the
|
|
6
|
+
declaration panel carries the `presentation` anchor of the declarations that had one.
|
|
7
|
+
-#}
|
|
8
|
+
{% import "helpers/no-content.html.nunj" as noContentMacro %}
|
|
9
|
+
{% import "helpers/code.html.nunj" as codeMacro %}
|
|
10
|
+
{% import "helpers/type.html.nunj" as typeMacro %}
|
|
11
|
+
{% import "helpers/parameters.html.nunj" as parametersMacro %}
|
|
12
|
+
{% import "helpers/overload.html.nunj" as overloadMacro %}
|
|
13
|
+
{% import "symbol/members.html.nunj" as membersMacro %}
|
|
14
|
+
{% import "symbol/details.html.nunj" as detailsMacro %}
|
|
15
|
+
|
|
16
|
+
{% set isClass = Node.isClassDeclaration(declaration) %}
|
|
17
|
+
{% set isInterface = Node.isInterfaceDeclaration(declaration) %}
|
|
18
|
+
{% set isFunction = Node.isFunctionDeclaration(declaration) %}
|
|
19
|
+
{% set isTypeAlias = Node.isTypeAliasDeclaration(declaration) %}
|
|
20
|
+
{% set isVariable = Node.isVariableDeclaration(declaration) %}
|
|
21
|
+
|
|
22
|
+
{% set description = docNode | getJsDocDescription %}
|
|
23
|
+
<div class="ng-doc-api-description">
|
|
24
|
+
{{ description if description else noContentMacro.render('No documentation has been provided.') }}
|
|
25
|
+
</div>
|
|
26
|
+
|
|
27
|
+
{{ detailsMacro.render(declaration, scope) }}
|
|
28
|
+
{{ detailsMacro.render(declaration, scope, 'rail') }}
|
|
29
|
+
|
|
30
|
+
{%- if isFunction %}
|
|
31
|
+
{% set code = declaration | functionPresentation %}
|
|
32
|
+
{%- elseif isTypeAlias %}
|
|
33
|
+
{% set code = declaration | typeAliasPresentation %}
|
|
34
|
+
{%- elseif isVariable %}
|
|
35
|
+
{% set code = declaration | variablePresentation %}
|
|
36
|
+
{%- else %}
|
|
37
|
+
{% set code = declaration | apiDeclaration %}
|
|
38
|
+
{%- endif %}
|
|
39
|
+
<div class="ng-doc-api-declaration" indexable="false"{% if isFunction or isTypeAlias or isVariable %} dataSlug="Presentation" dataSlugType="heading"{% endif %}>
|
|
40
|
+
<pre><code class="language-typescript" lang="typescript" metastring='{"name":"Declaration"}'>{{ code | escape }}</code></pre>
|
|
41
|
+
</div>
|
|
42
|
+
|
|
43
|
+
{% include "symbol/extended-by.html.nunj" %}
|
|
44
|
+
|
|
45
|
+
{% include "parts/remarks.html.nunj" %}
|
|
46
|
+
{% include "symbol/see-also.html.nunj" %}
|
|
47
|
+
|
|
48
|
+
{% if isFunction %}
|
|
49
|
+
{%- set parameters = declaration.getParameters() -%}
|
|
50
|
+
{%- set overloads = declaration.getOverloads() -%}
|
|
51
|
+
{%- set returnsTag = docNode | getJsDocTag('returns') -%}
|
|
52
|
+
|
|
53
|
+
<h2>Returns</h2>
|
|
54
|
+
<div class="ng-doc-returns">
|
|
55
|
+
{{ typeMacro.returnType(declaration) }}
|
|
56
|
+
{%- if returnsTag.length %}
|
|
57
|
+
<span> - </span>
|
|
58
|
+
{{ returnsTag | markdownToHtml }}
|
|
59
|
+
{%- endif %}
|
|
60
|
+
</div>
|
|
61
|
+
|
|
62
|
+
{% if parameters.length -%}
|
|
63
|
+
<h2>Parameters</h2>
|
|
64
|
+
{{ parametersMacro.render(parameters, declaration) }}
|
|
65
|
+
{%- endif %}
|
|
66
|
+
|
|
67
|
+
{% if overloads.length %}
|
|
68
|
+
<h2>Overloads</h2>
|
|
69
|
+
{{ overloadMacro.render(overloads) }}
|
|
70
|
+
{% endif %}
|
|
71
|
+
{% else %}
|
|
72
|
+
{{ membersMacro.render(declaration) }}
|
|
73
|
+
{% endif %}
|
|
74
|
+
|
|
75
|
+
{% include "parts/examples.html.nunj" %}
|
|
76
|
+
{% include "parts/usage-notes.html.nunj" %}
|
|
@@ -0,0 +1,16 @@
|
|
|
1
|
+
{#-
|
|
2
|
+
The `@see` tags of a declaration; derived classes are listed by `symbol/extended-by.html.nunj`.
|
|
3
|
+
-#}
|
|
4
|
+
{%- set seeDocs = docNode | getJsDocTags('see') %}
|
|
5
|
+
|
|
6
|
+
{%- if seeDocs.length %}
|
|
7
|
+
<section indexable="false">
|
|
8
|
+
<h2>See Also</h2>
|
|
9
|
+
|
|
10
|
+
<ul class="ng-doc-see-also">
|
|
11
|
+
{%- for see in seeDocs %}
|
|
12
|
+
<li>{{ see }}</li>
|
|
13
|
+
{%- endfor %}
|
|
14
|
+
</ul>
|
|
15
|
+
</section>
|
|
16
|
+
{%- endif %}
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
// apps/ng-doc/docs/api-documentation/ng-doc.category.ts
|
|
2
|
-
var ApiDocumentationCategory = {
|
|
3
|
-
title: "API Documentation",
|
|
4
|
-
route: "api-documentation",
|
|
5
|
-
expandable: true,
|
|
6
|
-
order: 4
|
|
7
|
-
};
|
|
8
|
-
var ng_doc_category_default = ApiDocumentationCategory;
|
|
9
|
-
|
|
10
|
-
// apps/ng-doc/docs/api-documentation/auto-generation/apps/ng-doc/docs/api-documentation/auto-generation/ng-doc.page.ts
|
|
11
|
-
var AutoGenerationPage = {
|
|
12
|
-
title: "Auto generation",
|
|
13
|
-
mdFile: "./index.md",
|
|
14
|
-
category: ng_doc_category_default,
|
|
15
|
-
order: 1
|
|
16
|
-
};
|
|
17
|
-
var ng_doc_page_default = AutoGenerationPage;
|
|
18
|
-
export {
|
|
19
|
-
ng_doc_page_default as default
|
|
20
|
-
};
|
package/engine/.cache/apps/ng-doc/docs/api-documentation/documenting-declarations/ng-doc.page.mjs
DELETED
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
// apps/ng-doc/docs/api-documentation/ng-doc.category.ts
|
|
2
|
-
var ApiDocumentationCategory = {
|
|
3
|
-
title: "API Documentation",
|
|
4
|
-
route: "api-documentation",
|
|
5
|
-
expandable: true,
|
|
6
|
-
order: 4
|
|
7
|
-
};
|
|
8
|
-
var ng_doc_category_default = ApiDocumentationCategory;
|
|
9
|
-
|
|
10
|
-
// apps/ng-doc/docs/api-documentation/documenting-declarations/apps/ng-doc/docs/api-documentation/documenting-declarations/ng-doc.page.ts
|
|
11
|
-
var DocumentingDeclarationsPage = {
|
|
12
|
-
title: "Documenting declarations",
|
|
13
|
-
mdFile: "./index.md",
|
|
14
|
-
category: ng_doc_category_default,
|
|
15
|
-
order: 2
|
|
16
|
-
};
|
|
17
|
-
var ng_doc_page_default = DocumentingDeclarationsPage;
|
|
18
|
-
export {
|
|
19
|
-
ng_doc_page_default as default
|
|
20
|
-
};
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
// apps/ng-doc/docs/api-documentation/ng-doc.category.ts
|
|
2
|
-
var ApiDocumentationCategory = {
|
|
3
|
-
title: "API Documentation",
|
|
4
|
-
route: "api-documentation",
|
|
5
|
-
expandable: true,
|
|
6
|
-
order: 4
|
|
7
|
-
};
|
|
8
|
-
var ng_doc_category_default = ApiDocumentationCategory;
|
|
9
|
-
|
|
10
|
-
// apps/ng-doc/docs/api-documentation/rendering-api/apps/ng-doc/docs/api-documentation/rendering-api/ng-doc.page.ts
|
|
11
|
-
var RenderingAPIPage = {
|
|
12
|
-
title: `Rendering API`,
|
|
13
|
-
mdFile: "./index.md",
|
|
14
|
-
category: ng_doc_category_default
|
|
15
|
-
};
|
|
16
|
-
var ng_doc_page_default = RenderingAPIPage;
|
|
17
|
-
export {
|
|
18
|
-
ng_doc_page_default as default
|
|
19
|
-
};
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
// apps/ng-doc/docs/customization/ng-doc.category.ts
|
|
2
|
-
var CustomizationCategory = {
|
|
3
|
-
title: "Customization",
|
|
4
|
-
order: 6,
|
|
5
|
-
expandable: true
|
|
6
|
-
};
|
|
7
|
-
var ng_doc_category_default = CustomizationCategory;
|
|
8
|
-
|
|
9
|
-
// apps/ng-doc/docs/customization/icons/apps/ng-doc/docs/customization/icons/ng-doc.page.ts
|
|
10
|
-
var IconsPage = {
|
|
11
|
-
title: `Icons`,
|
|
12
|
-
mdFile: "./index.md",
|
|
13
|
-
category: ng_doc_category_default,
|
|
14
|
-
order: 4
|
|
15
|
-
};
|
|
16
|
-
var ng_doc_page_default = IconsPage;
|
|
17
|
-
export {
|
|
18
|
-
ng_doc_page_default as default
|
|
19
|
-
};
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
// apps/ng-doc/docs/customization/ng-doc.category.ts
|
|
2
|
-
var CustomizationCategory = {
|
|
3
|
-
title: "Customization",
|
|
4
|
-
order: 6,
|
|
5
|
-
expandable: true
|
|
6
|
-
};
|
|
7
|
-
var ng_doc_category_default = CustomizationCategory;
|
|
8
|
-
|
|
9
|
-
// apps/ng-doc/docs/customization/layout/apps/ng-doc/docs/customization/layout/ng-doc.page.ts
|
|
10
|
-
var LayoutPage = {
|
|
11
|
-
title: `Layout`,
|
|
12
|
-
mdFile: "./index.md",
|
|
13
|
-
category: ng_doc_category_default,
|
|
14
|
-
order: 2
|
|
15
|
-
};
|
|
16
|
-
var ng_doc_page_default = LayoutPage;
|
|
17
|
-
export {
|
|
18
|
-
ng_doc_page_default as default
|
|
19
|
-
};
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
// apps/ng-doc/docs/customization/ng-doc.category.ts
|
|
2
|
-
var CustomizationCategory = {
|
|
3
|
-
title: "Customization",
|
|
4
|
-
order: 6,
|
|
5
|
-
expandable: true
|
|
6
|
-
};
|
|
7
|
-
var ng_doc_category_default = CustomizationCategory;
|
|
8
|
-
|
|
9
|
-
// apps/ng-doc/docs/customization/page-processors/apps/ng-doc/docs/customization/page-processors/ng-doc.page.ts
|
|
10
|
-
var PageProcessorsPage = {
|
|
11
|
-
title: `Page Processors`,
|
|
12
|
-
mdFile: "./index.md",
|
|
13
|
-
category: ng_doc_category_default,
|
|
14
|
-
order: 1
|
|
15
|
-
};
|
|
16
|
-
var ng_doc_page_default = PageProcessorsPage;
|
|
17
|
-
export {
|
|
18
|
-
ng_doc_page_default as default
|
|
19
|
-
};
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
// apps/ng-doc/docs/customization/ng-doc.category.ts
|
|
2
|
-
var CustomizationCategory = {
|
|
3
|
-
title: "Customization",
|
|
4
|
-
order: 6,
|
|
5
|
-
expandable: true
|
|
6
|
-
};
|
|
7
|
-
var ng_doc_category_default = CustomizationCategory;
|
|
8
|
-
|
|
9
|
-
// apps/ng-doc/docs/customization/page-skeleton/apps/ng-doc/docs/customization/page-skeleton/ng-doc.page.ts
|
|
10
|
-
var PageSkeletonPage = {
|
|
11
|
-
title: `Page Skeleton`,
|
|
12
|
-
mdFile: "./index.md",
|
|
13
|
-
category: ng_doc_category_default,
|
|
14
|
-
order: 1
|
|
15
|
-
};
|
|
16
|
-
var ng_doc_page_default = PageSkeletonPage;
|
|
17
|
-
export {
|
|
18
|
-
ng_doc_page_default as default
|
|
19
|
-
};
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
// apps/ng-doc/docs/customization/ng-doc.category.ts
|
|
2
|
-
var CustomizationCategory = {
|
|
3
|
-
title: "Customization",
|
|
4
|
-
order: 6,
|
|
5
|
-
expandable: true
|
|
6
|
-
};
|
|
7
|
-
var ng_doc_category_default = CustomizationCategory;
|
|
8
|
-
|
|
9
|
-
// apps/ng-doc/docs/customization/search/apps/ng-doc/docs/customization/search/ng-doc.page.ts
|
|
10
|
-
var SearchPage = {
|
|
11
|
-
title: "Search",
|
|
12
|
-
mdFile: "./index.md",
|
|
13
|
-
order: 2,
|
|
14
|
-
category: ng_doc_category_default
|
|
15
|
-
};
|
|
16
|
-
var ng_doc_page_default = SearchPage;
|
|
17
|
-
export {
|
|
18
|
-
ng_doc_page_default as default
|
|
19
|
-
};
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
// apps/ng-doc/docs/customization/ng-doc.category.ts
|
|
2
|
-
var CustomizationCategory = {
|
|
3
|
-
title: "Customization",
|
|
4
|
-
order: 6,
|
|
5
|
-
expandable: true
|
|
6
|
-
};
|
|
7
|
-
var ng_doc_category_default = CustomizationCategory;
|
|
8
|
-
|
|
9
|
-
// apps/ng-doc/docs/customization/themes/apps/ng-doc/docs/customization/themes/ng-doc.page.ts
|
|
10
|
-
var ThemesPage = {
|
|
11
|
-
title: "Themes",
|
|
12
|
-
mdFile: "./index.md",
|
|
13
|
-
category: ng_doc_category_default,
|
|
14
|
-
order: 3
|
|
15
|
-
};
|
|
16
|
-
var ng_doc_page_default = ThemesPage;
|
|
17
|
-
export {
|
|
18
|
-
ng_doc_page_default as default
|
|
19
|
-
};
|
|
@@ -1,36 +0,0 @@
|
|
|
1
|
-
// libs/core/constants/angular-entities.ts
|
|
2
|
-
var NgDocAngularEntities = [
|
|
3
|
-
"Component",
|
|
4
|
-
"Directive",
|
|
5
|
-
"Pipe",
|
|
6
|
-
"Injectable",
|
|
7
|
-
"NgModule"
|
|
8
|
-
];
|
|
9
|
-
|
|
10
|
-
// libs/core/constants/declarations.ts
|
|
11
|
-
var NgDocDeclarations = [
|
|
12
|
-
"Class",
|
|
13
|
-
"Interface",
|
|
14
|
-
"Enum",
|
|
15
|
-
"Function",
|
|
16
|
-
"TypeAlias",
|
|
17
|
-
"Variable"
|
|
18
|
-
];
|
|
19
|
-
|
|
20
|
-
// apps/ng-doc/docs/develop/apps/ng-doc/docs/develop/ng-doc.page.ts
|
|
21
|
-
var DevelopPage = {
|
|
22
|
-
title: "Develop",
|
|
23
|
-
mdFile: "./index.md.nunj",
|
|
24
|
-
onlyForTags: ["development"],
|
|
25
|
-
data: {
|
|
26
|
-
modifiers: ["abstract", "static", "async", "readonly"],
|
|
27
|
-
entities: {
|
|
28
|
-
typescript: NgDocDeclarations,
|
|
29
|
-
angular: NgDocAngularEntities
|
|
30
|
-
}
|
|
31
|
-
}
|
|
32
|
-
};
|
|
33
|
-
var ng_doc_page_default = DevelopPage;
|
|
34
|
-
export {
|
|
35
|
-
ng_doc_page_default as default
|
|
36
|
-
};
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
// apps/ng-doc/docs/getting-started/ng-doc.category.ts
|
|
2
|
-
var GettingStartedCategory = {
|
|
3
|
-
title: "Getting Started",
|
|
4
|
-
order: 1,
|
|
5
|
-
expandable: true
|
|
6
|
-
};
|
|
7
|
-
var ng_doc_category_default = GettingStartedCategory;
|
|
8
|
-
|
|
9
|
-
// apps/ng-doc/docs/getting-started/configuration/apps/ng-doc/docs/getting-started/configuration/ng-doc.page.ts
|
|
10
|
-
var Configuration = {
|
|
11
|
-
title: `Configuration`,
|
|
12
|
-
mdFile: "./index.md",
|
|
13
|
-
category: ng_doc_category_default,
|
|
14
|
-
order: 3
|
|
15
|
-
};
|
|
16
|
-
var ng_doc_page_default = Configuration;
|
|
17
|
-
export {
|
|
18
|
-
ng_doc_page_default as default
|
|
19
|
-
};
|
|
@@ -1,19 +0,0 @@
|
|
|
1
|
-
// apps/ng-doc/docs/getting-started/ng-doc.category.ts
|
|
2
|
-
var GettingStartedCategory = {
|
|
3
|
-
title: "Getting Started",
|
|
4
|
-
order: 1,
|
|
5
|
-
expandable: true
|
|
6
|
-
};
|
|
7
|
-
var ng_doc_category_default = GettingStartedCategory;
|
|
8
|
-
|
|
9
|
-
// apps/ng-doc/docs/getting-started/installation/apps/ng-doc/docs/getting-started/installation/ng-doc.page.ts
|
|
10
|
-
var page = {
|
|
11
|
-
title: `Installation`,
|
|
12
|
-
mdFile: ["./automatic.md", "manual.md"],
|
|
13
|
-
category: ng_doc_category_default,
|
|
14
|
-
order: 2
|
|
15
|
-
};
|
|
16
|
-
var ng_doc_page_default = page;
|
|
17
|
-
export {
|
|
18
|
-
ng_doc_page_default as default
|
|
19
|
-
};
|