Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[BUG] All types display in the doc as void (incorrect types) #218

Closed
altafard opened this issue Jul 8, 2017 · 1 comment
Closed

[BUG] All types display in the doc as void (incorrect types) #218

altafard opened this issue Jul 8, 2017 · 1 comment

Comments

@altafard
Copy link

altafard commented Jul 8, 2017

Overview of the issue

All function parameters and class properties are marked with a type void.

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

systeminfo: OS Microsoft Windows 10 Pro, version 10.0.15063 N/A build 15063
node -- version: 6.9.3
npm --version: 3.10.10
compodoc --version: 1.0.0-beta.11

Angular configuration, a package.json file in the root folder
{
  "name": "name",
  "version": "0.0.0",
  "license": "MIT",
  "scripts": {
    "ng": "ng",
    "start": "ng serve",
    "build": "ng build",
    "test": "ng test",
    "lint": "ng lint",
    "e2e": "ng e2e"
  },
  "private": true,
  "dependencies": {
    "@angular/animations": "^4.0.0",
    "@angular/common": "^4.0.0",
    "@angular/compiler": "^4.0.0",
    "@angular/core": "^4.0.0",
    "@angular/flex-layout": "^2.0.0-beta.8",
    "@angular/forms": "^4.0.0",
    "@angular/http": "^4.0.0",
    "@angular/material": "^2.0.0-beta.7",
    "@angular/platform-browser": "^4.0.0",
    "@angular/platform-browser-dynamic": "^4.0.0",
    "@angular/router": "^4.0.0",
    "core-js": "^2.4.1",
    "rxjs": "^5.1.0",
    "tinymce": "^4.6.4",
    "zone.js": "^0.8.4"
  },
  "devDependencies": {
    "@angular/cli": "1.1.1",
    "@angular/compiler-cli": "^4.0.0",
    "@angular/language-service": "^4.0.0",
    "@compodoc/compodoc": "^1.0.0-beta.11",
    "@types/jasmine": "2.5.45",
    "@types/node": "~6.0.60",
    "codelyzer": "~3.0.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.0.4",
    "tslint": "~5.3.2",
    "typescript": "~2.4.1"
  }
}
Compodoc installed globally or locally ?

locally

Motivation for or Use Case

I would like to see in documentation correct types in a property description and function signature.

Reproduce the error

Write follow class using JSDoc comments

export class AppComponent {

  title: string = 'Title';

  /**
   * First line
   * 
   * Second line
   * 
   * @param {number} dig  The target to process number
   * @param {string} str  The target to process string
   * @param {boolean} bool  The target to process bool
   * 
   * @example
   * This is a good example
   * testCommentFunction(1, 'test', true);
   *
   * @returns The processed target number
   */
  testCommentFunction(dig: number, str: string, bool: boolean): object {
    return {};
  }

}

Then opening documentation
image

In property description
image

@lock
Copy link

lock bot commented Oct 1, 2019

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.

@lock lock bot locked as resolved and limited conversation to collaborators Oct 1, 2019
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

2 participants