Logo for jsDocs.io

compodoc

  • Version 0.0.41
  • Published
  • 17 dependencies
  • MIT license

Install

npm i compodoc
yarn add compodoc
pnpm add compodoc

Overview

The missing documentation tool for your Angular application

Index

Classes

Classes

class Application

class Application {}

    constructor

    constructor(options?: Object);

    • Create a new compodoc application instance.

      Parameter options

      An object containing the options that should be used.

    property application

    readonly application: Application;

    • Return the application / root component instance.

    property configuration

    configuration: IConfiguration;

      property files

      files: string[];

        property isCLI

        readonly isCLI: boolean;

          property options

          options: Object;

            property prepareClasses

            prepareClasses: () => void;

              property prepareDirectives

              prepareDirectives: () => void;

                property preparePipes

                preparePipes: () => void;

                  method generate

                  protected generate: () => void;

                  • Start compodoc

                  method getDependenciesData

                  getDependenciesData: () => void;

                    method prepareComponents

                    prepareComponents: () => Promise<unknown>;

                      method prepareCoverage

                      prepareCoverage: () => void;

                        method prepareInjectables

                        prepareInjectables: () => void;

                          method prepareInterfaces

                          prepareInterfaces: () => void;

                            method prepareMiscellaneous

                            prepareMiscellaneous: () => void;

                              method prepareModules

                              prepareModules: () => void;

                                method prepareRoutes

                                prepareRoutes: () => void;

                                  method processAssetsFolder

                                  processAssetsFolder: () => void;

                                    method processGraphs

                                    processGraphs: () => void;

                                      method processMarkdown

                                      processMarkdown: () => void;

                                        method processPackageJson

                                        processPackageJson: () => void;

                                          method processPages

                                          processPages: () => void;

                                            method processResources

                                            processResources: () => void;

                                              method runWebServer

                                              runWebServer: (folder: any) => void;

                                                method setFiles

                                                setFiles: (files: Array<string>) => void;

                                                  class CliApplication

                                                  class CliApplication extends Application {}

                                                    method generate

                                                    protected generate: () => void;

                                                    • Run compodoc from the command line.

                                                    Package Files (3)

                                                    Dependencies (17)

                                                    Dev Dependencies (22)

                                                    Peer Dependencies (0)

                                                    No peer dependencies.

                                                    Badge

                                                    To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                                                    You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/compodoc.

                                                    • Markdown
                                                      [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/compodoc)
                                                    • HTML
                                                      <a href="https://www.jsdocs.io/package/compodoc"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>