TypeDoc TypeScript documentation

typedoc_typescript_documentation.ts

/**

  A module documentation.

*/
export module BModule {

  /**

    A constant documentation.

  */
  export const ACONST: number = 9;

  /**

    Interface documentation.

  */
  export interface IInterface {
    /** a interface member. */
    a: string;
    /** b interface member. */
    b: number;
  }

  /**

    A generic function documentation.

    @typeParam T
    Generic type documentation.

    @param aParameter
    aParameter parameter documentation.

    @param __namedParameters
    General options documentation.

    @param __namedParameters.circleColor
    Option circleColor documentation.

    @param __namedParameters.circleStrokeColor
    Option circleStrokeColor documentation.

    @param __namedParameters.circleStrokeWidth
    Option circleStrokeWidth documentation.

    @param __namedParameters.circleRadius
    Option circleRadius documentation.

    @returns
    Returns docs.

  */
  export function a<T>(aParameter: number, {
      circleColor = "#eeeeee",
      circleStrokeColor = "#000000",
      circleStrokeWidth = 1,
      circleRadius = 3,
      aFunction = (a: number) => a
    }: {
      circleColor?: string,
      circleStrokeColor?: string,
      circleStrokeWidth?: number,
      circleRadius?: number,
      /**

        Option aFunction docs. This is the only way a function that is a
        parameter can be properly documented. It's a little bit disruptive but
        no other way AFAIK.

        @param a
        Parameter a of aFunction member function.

        @returns
        Returns of aFunction member function.

      */
      aFunction: (a: number) => number
    } = {
      circleColor: "#eeeeee",
      circleStrokeColor: "#000000",
      circleStrokeWidth: 1,
      circleRadius: 3,
      aFunction: (a: number) => a
  }): any {

    // Implementation here

  }

  /**

    Enumeration documentation.

  */
  export enum EENUMERATION {
    /** ITEMA documentation. */
    ITEMA,
    /** ITEMB documentation. */
    ITEMB
  }

  /**

    Dummy class.

  */
  class ParentClass {

    /**

      fromParent member.

    */
    public fromParent() {}

  }

  /**

    Class documentation.

    @typeParam T
    Generic type documentation.

  */
  export class TheClass<T> extends ParentClass implements IInterface {

    /**

      a member.

    */
    public a: string = "";

    /**

      b member.

    */
    public b: number = 0;

  }

// This closes the module
}