compodoc / compodoc

:notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application
https://compodoc.app
MIT License
4k stars 400 forks source link

[FEATURE] Unmanaged Namespaces #341

Closed zeeroa closed 6 years ago

zeeroa commented 6 years ago
Overview of the issue

I'm creating an app with angular4. In the "src" folder I have a file called "typings.ts" with custom interfaces and namespaces inside this.

exemple

namespace BSBO {

    export namespace Events {
        export interface WindowOnResizeEvent {
            ViewportWidth: number;
            ViewportHeight: number;
            Width: number;
            Height: number;
        }

        export interface ModalCloseEvent {
            Titile: string,
            Data?: any;
            Id?: string;
            DisableClose?: boolean;
            Width?: number;
            Height?: number;
            Position: UtilsSrv.ModalPosition;
        }

        export interface NavigationEndEvent {
            oldUrl: string;
            newUrl: string;
            instanceName: string;
        }
    }

}

When I launch the command to create the doc, not any namespace or interface is rendered in any menu voice

Operating System, Node.js, npm, compodoc version(s)

Windows 10 Enterprise 1703 NodeJs v6.11.1 npm 4.5.0 compodoc 1.0.1 angularcli 1.4.2

Angular configuration, a package.json file in the root folder
{
    "name": "web-app",
    "version": "0.0.0",
    "license": "MIT",
    "scripts": {
        "ng": "ng",
        "start": "ng serve",
        "build": "ng build",
        "test": "ng test",
        "lint": "ng lint",
        "e2e": "ng e2e",
        "doc:serve": "compodoc -p src/tsconfig.app.json -n \"Backoffice Test Doc\" --disablePrivateOrInternalSupport --theme vagrant --hideGenerator -s -o",
        "doc:build": "compodoc -p src/tsconfig.app.json -n \"BestStore Backoffice Doc\" --disableSourceCode --disablePrivateOrInternalSupport --theme vagrant --hideGenerator"
    },
    "private": true,
    "dependencies": {
        "@angular/animations": "^4.4.4",
        "@angular/cdk": "^2.0.0-beta.12",
        "@angular/common": "^4.2.4",
        "@angular/compiler": "^4.2.4",
        "@angular/core": "^4.2.4",
        "@angular/forms": "^4.2.4",
        "@angular/http": "^4.2.4",
        "@angular/material": "^2.0.0-beta.12",
        "@angular/platform-browser": "^4.2.4",
        "@angular/platform-browser-dynamic": "^4.2.4",
        "@angular/router": "^4.2.4",
        "core-js": "^2.4.1",
        "hammerjs": "^2.0.8",
        "rxjs": "^5.4.2",
        "zone.js": "^0.8.14"
    },
    "devDependencies": {
        "@angular/cli": "1.4.2",
        "@angular/compiler-cli": "^4.2.4",
        "@angular/language-service": "^4.2.4",
        "@types/jasmine": "~2.5.53",
        "@types/jasminewd2": "~2.0.2",
        "@types/node": "~6.0.60",
        "codelyzer": "~3.1.1",
        "jasmine-core": "~2.6.2",
        "jasmine-spec-reporter": "~4.1.0",
        "karma": "~1.7.0",
        "karma-chrome-launcher": "~2.1.1",
        "karma-cli": "~1.0.1",
        "karma-coverage-istanbul-reporter": "^1.2.1",
        "karma-jasmine": "~1.1.0",
        "karma-jasmine-html-reporter": "^0.2.2",
        "protractor": "~5.1.2",
        "ts-node": "~3.2.0",
        "tslint": "~5.3.2",
        "typedoc": "^0.9.0",
        "typescript": "~2.3.3"
    }
}
Compodoc installed globally or locally ?

globally

Motivation for or Use Case

create a technical doc for my app

vogloblinsky commented 6 years ago

Namespace is not supported in Compodoc, i will add it soon. Regards

lock[bot] commented 4 years ago

This issue has been automatically locked due to inactivity. Please file a new issue if you are encountering a similar or related problem. Why locking ? Having issues with the most up-to-date context.