@skyux/docs-tools 12.0.0-alpha.0 → 12.0.0-alpha.5

package/modules/type-definitions/type-definitions.service.d.ts

@@ -1,20 +0,0 @@
-import { SkyDocsTypeDefinitions } from './type-definitions';
-import { SkyDocsTypeDefinitionsProvider } from './type-definitions-provider';
-import { SkyDocsTypeDocAdapterService } from './typedoc-adapter.service';
-import * as i0 from "@angular/core";
-/**
- * Handles all type definitions that have been converted from the third-party documentation generator.
- */
-export declare class SkyDocsTypeDefinitionsService {
-    private typeDefinitionsProvider;
-    private adapter;
-    constructor(typeDefinitionsProvider: SkyDocsTypeDefinitionsProvider, adapter: SkyDocsTypeDocAdapterService);
-    /**
-     * Returns type definitions from a specific source code location.
-     * @param sourceCodePath The directory of the source code you wish to pull type definitions from,
-     * relative to the application's root directory.
-     */
-    getTypeDefinitions(sourceCodePath: string, additionalSourceCodePaths?: string[]): SkyDocsTypeDefinitions;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDefinitionsService, never>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<SkyDocsTypeDefinitionsService>;
-}

package/modules/type-definitions/type-parameter-definition.d.ts

@@ -1,8 +0,0 @@
-import { SkyDocsTypeDefinition } from './type-definition';
-/**
- * Describes a type parameter, e.g. `<T>`.
- */
-export interface SkyDocsTypeParameterDefinition {
-    name: string;
-    type?: SkyDocsTypeDefinition;
-}

package/modules/type-definitions/typedoc-adapter.service.d.ts

@@ -1,49 +0,0 @@
-import { SkyDocsClassDefinition } from './class-definition';
-import { SkyDocsDirectiveDefinition } from './directive-definition';
-import { SkyDocsEnumerationDefinition } from './enumeration-definition';
-import { SkyDocsInterfaceDefinition } from './interface-definition';
-import { SkyDocsPipeDefinition } from './pipe-definition';
-import { SkyDocsTypeAliasDefinition } from './type-alias-definition';
-import { SkyDocsTypeDefinitionsProvider } from './type-definitions-provider';
-import { TypeDocEntry } from './typedoc-types';
-import * as i0 from "@angular/core";
-/**
- * Converts TypeDoc types into SKY UX docs-tools types, to be supplied to the various definitions components.
- */
-export declare class SkyDocsTypeDocAdapterService {
-    #private;
-    private typeDefinitionsProvider?;
-    constructor(typeDefinitionsProvider?: SkyDocsTypeDefinitionsProvider);
-    toClassDefinition(entry: TypeDocEntry): SkyDocsClassDefinition;
-    toDirectiveDefinition(entry: TypeDocEntry): SkyDocsDirectiveDefinition;
-    toEnumerationDefinition(entry: TypeDocEntry): SkyDocsEnumerationDefinition;
-    toInterfaceDefinition(entry: TypeDocEntry): SkyDocsInterfaceDefinition;
-    toPipeDefinition(entry: TypeDocEntry): SkyDocsPipeDefinition;
-    toTypeAliasDefinition(entry: TypeDocEntry): SkyDocsTypeAliasDefinition;
-    private getSelector;
-    private getClassProperties;
-    private getClassMethods;
-    private getInterfaceProperties;
-    private getEnumerationMembers;
-    private getTypeDefinition;
-    private getParameterDefinitions;
-    private getTypeArgumentDefinitions;
-    private getCallSignatureDefinition;
-    private getIndexSignatureDefinition;
-    private getTypeParameterDefinitions;
-    private getCommentTags;
-    /**
-     * Parameter descriptions are derived from the parent's (function/method) comment.
-     */
-    private getParameterCommentTags;
-    /**
-     * Applies comment tag (e.g. `@param`) values to the provided definition, if the value is defined.
-     */
-    private applyCommentTagValues;
-    private getDecorator;
-    private getPropertyName;
-    private getDefaultValue;
-    private getAnchorId;
-    static ɵfac: i0.ɵɵFactoryDeclaration<SkyDocsTypeDocAdapterService, [{ optional: true; }]>;
-    static ɵprov: i0.ɵɵInjectableDeclaration<SkyDocsTypeDocAdapterService>;
-}

package/modules/type-definitions/typedoc-types.d.ts

@@ -1,142 +0,0 @@
-export interface TypeDocComment {
-    summary?: {
-        kind: string;
-        text: string;
-    }[];
-    blockTags?: {
-        param?: string;
-        content?: {
-            kind: string;
-            text: string;
-        }[];
-        tag: '@default' | '@defaultValue' | '@deprecated' | '@example' | '@param' | '@preview' | '@required';
-    }[];
-}
-export interface TypeDocSource {
-    fileName: string;
-}
-export interface TypeDocSignature {
-    comment?: TypeDocComment;
-    kind?: TypeDocKind.CallSignature | TypeDocKind.ConstructorSignature | TypeDocKind.IndexSignature;
-    name: string;
-    parameters?: TypeDocParameter[];
-    returnType?: TypeDocType;
-    type?: TypeDocType;
-    typeParameters?: TypeDocTypeParameter[];
-}
-export interface TypeDocTypeParameter {
-    name: string;
-    kind: TypeDocKind.TypeParameter;
-    type?: TypeDocType;
-}
-export interface TypeDocType {
-    constraint?: {
-        name: string;
-    };
-    callSignature?: TypeDocSignature;
-    declaration?: {
-        children?: TypeDocEntryChild[];
-        indexSignature?: TypeDocSignature;
-        signatures?: TypeDocSignature[];
-    };
-    elementType?: TypeDocType;
-    name?: string;
-    operator?: 'keyof';
-    target?: {
-        name: string;
-    };
-    type?: 'array' | 'intrinsic' | 'literal' | 'reference' | 'reflection' | 'typeParameter' | 'typeOperator' | 'union' | 'unknown';
-    typeArguments?: TypeDocType[];
-    types?: TypeDocType[];
-    value?: string;
-    package?: string;
-}
-export interface TypeDocParameter {
-    comment?: TypeDocComment;
-    defaultValue?: string;
-    kind: TypeDocKind.Parameter;
-    name: string;
-    type: TypeDocType;
-    flags?: {
-        isOptional?: boolean;
-    };
-}
-export interface TypeDocEntryChild {
-    comment?: TypeDocComment;
-    decorators?: {
-        arguments?: {
-            bindingPropertyName?: string;
-        };
-        name: 'Input' | 'Output';
-        type: TypeDocType;
-    }[];
-    defaultValue?: string;
-    flags?: {
-        isOptional?: boolean;
-        isStatic?: boolean;
-    };
-    kind?: TypeDocKind.Accessor | TypeDocKind.CallSignature | TypeDocKind.Constructor | TypeDocKind.ConstructorSignature | TypeDocKind.IndexSignature | TypeDocKind.EnumMember | TypeDocKind.Parameter | TypeDocKind.Property | TypeDocKind.Method;
-    getSignature?: {
-        comment: TypeDocComment;
-        name: string;
-        type: TypeDocType;
-    };
-    name?: string;
-    setSignature?: {
-        comment: TypeDocComment;
-        name: string;
-        parameters?: TypeDocParameter[];
-        type: TypeDocType;
-    };
-    signatures?: TypeDocSignature[];
-    sources?: TypeDocSource[];
-    type?: TypeDocType;
-}
-export interface TypeDocEntry {
-    anchorId?: string;
-    children?: TypeDocEntryChild[];
-    comment?: TypeDocComment;
-    decorators?: {
-        arguments?: {
-            obj?: string;
-        };
-        name: 'Component' | 'Directive' | 'Injectable' | 'NgModule' | 'Pipe';
-        type: TypeDocType;
-    }[];
-    kind?: TypeDocKind.Class | TypeDocKind.Enum | TypeDocKind.Interface | TypeDocKind.TypeAlias;
-    indexSignature?: TypeDocSignature;
-    name?: string;
-    sources?: TypeDocSource[];
-    type?: TypeDocType;
-    typeParameters?: TypeDocTypeParameter[];
-}
-/**
- * This enum comes from:
- * https://github.com/TypeStrong/typedoc/blob/v0.25.13/src/lib/models/reflections/kind.ts
- * The enum is up to date as of version `0.25.13`.
- */
-export declare enum TypeDocKind {
-    Project = 1,
-    Module = 2,
-    Namespace = 4,
-    Enum = 8,
-    EnumMember = 16,
-    Variable = 32,
-    Function = 64,
-    Class = 128,
-    Interface = 256,
-    Constructor = 512,
-    Property = 1024,
-    Method = 2048,
-    CallSignature = 4096,
-    IndexSignature = 8192,
-    ConstructorSignature = 16384,
-    Parameter = 32768,
-    TypeLiteral = 65536,
-    TypeParameter = 131072,
-    Accessor = 262144,
-    GetSignature = 524288,
-    SetSignature = 1048576,
-    TypeAlias = 2097152,
-    Reference = 4194304
-}

package/public-api.d.ts

@@ -1,66 +0,0 @@
-export * from './modules/anatomy/anatomy.module';
-export * from './modules/code-examples/code-examples.module';
-export * from './modules/code-examples/code-example-theme';
-export * from './modules/demo/demo-content-alignment';
-export * from './modules/demo/demo-control-panel-change';
-export * from './modules/demo/demo-control-panel-radio-choice';
-export * from './modules/demo/demo.module';
-export * from './modules/demo-page/demo-page.module';
-export * from './modules/design-guidelines/design-guidelines.module';
-export * from './modules/heading-anchor/heading-anchor.module';
-export * from './modules/markdown/markdown.module';
-export * from './modules/markdown/markdown.pipe';
-export * from './modules/module-info/module-info.module';
-export * from './modules/shared/docs-tools-component-info';
-export * from './modules/shared/docs-tools-options';
-export * from './modules/shared/docs-tools-site-options';
-export * from './modules/shared/docs-tools-supportal.service';
-export * from './modules/source-code/source-code-provider';
-export * from './modules/thumbnail/thumbnail.module';
-export * from './modules/type-definitions/class-definition';
-export * from './modules/type-definitions/directive-definition';
-export * from './modules/type-definitions/enumeration-definition';
-export * from './modules/type-definitions/interface-definition';
-export * from './modules/type-definitions/interface-property-definition';
-export * from './modules/type-definitions/method-definition';
-export * from './modules/type-definitions/parameter-definition';
-export * from './modules/type-definitions/pipe-definition';
-export * from './modules/type-definitions/property-decorator';
-export * from './modules/type-definitions/property-definition';
-export * from './modules/type-definitions/type-alias-definition';
-export * from './modules/type-definitions/type-definitions-provider';
-export * from './modules/type-definitions/type-definitions.module';
-export * from './modules/type-definitions/type-definitions.service';
-export * from './docs-tools.module';
-export { SkyDocsAnatomyItemComponent as λ1 } from './modules/anatomy/anatomy-item.component';
-export { SkyDocsAnatomyComponent as λ2 } from './modules/anatomy/anatomy.component';
-export { SkyDocsCodeExampleComponent as λ3 } from './modules/code-examples/code-example.component';
-export { SkyDocsCodeExamplesComponent as λ4 } from './modules/code-examples/code-examples.component';
-export { SkyDocsDemoControlPanelCheckboxComponent as λ5 } from './modules/demo/demo-control-panel-checkbox.component';
-export { SkyDocsDemoControlPanelRadioGroupComponent as λ6 } from './modules/demo/demo-control-panel-radio-group.component';
-export { SkyDocsDemoControlPanelSectionComponent as λ7 } from './modules/demo/demo-control-panel-section.component';
-export { SkyDocsDemoControlPanelComponent as λ8 } from './modules/demo/demo-control-panel.component';
-export { SkyDocsDemoComponent as λ9 } from './modules/demo/demo.component';
-export { SkyDocsDemoCustomControlPanelComponent as λ32 } from './modules/demo/demo-custom-control-panel.component';
-export { SkyDocsDemoPageModuleInfoComponent as λ10 } from './modules/demo-page/demo-page-module-info.component';
-export { SkyDocsDemoPageSectionComponent as λ11 } from './modules/demo-page/demo-page-section.component';
-export { SkyDocsDemoPageSummaryComponent as λ12 } from './modules/demo-page/demo-page-summary.component';
-export { SkyDocsDemoPageTypeDefinitionsComponent as λ13 } from './modules/demo-page/demo-page-type-definitions.component';
-export { SkyDocsDemoPageComponent as λ14 } from './modules/demo-page/demo-page.component';
-export { SkyDocsDesignGuidelineThumbnailComponent as λ15 } from './modules/design-guidelines/design-guideline-thumbnail.component';
-export { SkyDocsDesignGuidelineComponent as λ16 } from './modules/design-guidelines/design-guideline.component';
-export { SkyDocsDesignGuidelinesComponent as λ17 } from './modules/design-guidelines/design-guidelines.component';
-export { SkyDocsHeadingAnchorComponent as λ18 } from './modules/heading-anchor/heading-anchor.component';
-export { SkyDocsModuleInfoComponent as λ19 } from './modules/module-info/module-info.component';
-export { SkyDocsThumbnailComponent as λ20 } from './modules/thumbnail/thumbnail.component';
-export { SkyDocsCallSignatureDefinitionComponent as λ21 } from './modules/type-definitions/call-signature-definition.component';
-export { SkyDocsClassDefinitionComponent as λ22 } from './modules/type-definitions/class-definition.component';
-export { SkyDocsDirectiveDefinitionComponent as λ23 } from './modules/type-definitions/directive-definition.component';
-export { SkyDocsEnumerationDefinitionComponent as λ24 } from './modules/type-definitions/enumeration-definition.component';
-export { SkyDocsInterfaceDefinitionComponent as λ25 } from './modules/type-definitions/interface-definition.component';
-export { SkyDocsMethodDefinitionsComponent as λ26 } from './modules/type-definitions/method-definitions.component';
-export { SkyDocsPipeDefinitionComponent as λ27 } from './modules/type-definitions/pipe-definition.component';
-export { SkyDocsPropertyDefinitionsComponent as λ28 } from './modules/type-definitions/property-definitions.component';
-export { SkyDocsTypeAliasDefinitionComponent as λ29 } from './modules/type-definitions/type-alias-definition.component';
-export { SkyDocsTypeAnchorLinksPipe as λ30 } from './modules/type-definitions/type-anchor-links.pipe';
-export { SkyDocsAnatomyThumbnailComponent as λ31 } from './modules/anatomy/anatomy-thumbnail.component';