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] Return type of top-level functions are not documented #700

Closed
hiranya911 opened this issue Dec 9, 2018 · 1 comment
Closed

[BUG] Return type of top-level functions are not documented #700

hiranya911 opened this issue Dec 9, 2018 · 1 comment

Comments

@hiranya911
Copy link

Overview of the issue

I have the following function:

/**
 * Does something.
 * 
 * @returns {string} A non-empty string
 */
export function doSomething(): string {
    return 'Hello';
}

The return type and description are not mentioned in the generated documentation:

screenshot from 2018-12-08 21-59-23

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

Ubuntu 16.04
NPM 5.6.0
Node 8.11.1
Compodoc 1.1.7

Angular configuration, a package.json file in the root folder
{
  "name": "experimental-sdk",
  "version": "6.3.0",
  "license": "Apache-2.0",
  "engines": {
    "node": ">=6.0.0"
  },
  "scripts": {
    "build": "gulp build",
    "compodoc": "./node_modules/.bin/compodoc -p src/tsconfig.app.json --disableInternal --disablePrivate",
    "lint": "run-p lint:src lint:unit lint:integration",
    "test": "run-s lint test:unit",
    "integration": "run-s build test:integration",
    "test:unit": "mocha test/unit/*.spec.ts --require ts-node/register",
    "test:integration": "mocha test/integration/*.ts --slow 5000 --timeout 20000 --require ts-node/register",
    "test:coverage": "nyc npm run test:unit",
    "lint:src": "tslint --format stylish -p tsconfig.json",
    "lint:unit": "tslint -c tslint-test.json --format stylish test/unit/*.ts test/unit/**/*.ts",
    "lint:integration": "tslint -c tslint-test.json --format stylish test/integration/*.ts"
  },
  "nyc": {
    "extension": [
      ".ts"
    ],
    "include": [
      "src"
    ],
    "exclude": [
      "**/*.d.ts"
    ],
    "all": true
  },
  "types": "./index.d.ts",
  "dependencies": {
    "@types/node": "^8.0.53"
  },
  "devDependencies": {
    "@compodoc/compodoc": "^1.1.7",
    "@types/bcrypt": "^2.0.0",
    "@types/chai": "^3.4.34",
    "@types/chai-as-promised": "0.0.29",
    "@types/firebase-token-generator": "^2.0.28",
    "@types/jsonwebtoken": "^7.2.8",
    "@types/lodash": "^4.14.104",
    "@types/minimist": "^1.2.0",
    "@types/mocha": "^2.2.48",
    "@types/nock": "^9.1.0",
    "@types/request": "^2.47.0",
    "@types/request-promise": "^4.1.41",
    "@types/scrypt": "^6.0.0",
    "@types/sinon": "^4.1.3",
    "@types/sinon-chai": "^2.7.27",
    "chalk": "^1.1.3",
    "del": "^2.2.1",
    "gulp": "^3.9.1",
    "gulp-exit": "0.0.2",
    "gulp-header": "^1.8.8",
    "gulp-replace": "^0.5.4",
    "gulp-typescript": "^3.2.4",
    "lodash": "^4.17.5",
    "merge2": "^1.2.1",
    "minimist": "^1.2.0",
    "mocha": "^5.2.0",
    "nock": "^9.6.0",
    "npm-run-all": "^4.1.5",
    "nyc": "^11.5.0",
    "request": "^2.75.0",
    "request-promise": "^4.1.1",
    "run-sequence": "^1.1.5",
    "ts-node": "^3.3.0",
    "tslint": "^5.9.0",
    "typedoc": "^0.13.0",
    "typescript": "^2.7.2"
  }
}
Compodoc installed globally or locally ?

Locally

@lock
Copy link

lock bot commented Sep 30, 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 Sep 30, 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