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

fake this parameters not documented #1875

Closed
zombifier opened this issue Feb 24, 2022 · 0 comments
Closed

fake this parameters not documented #1875

zombifier opened this issue Feb 24, 2022 · 0 comments
Labels
bug Functionality does not match expectation

Comments

@zombifier
Copy link

zombifier commented Feb 24, 2022

Search terms

this, globalThis

Expected Behavior

Given the following definitions:

export function test(this: typeof globalThis, param: string): string;

The generated documentation should include both the this and the param arguments.

Actual Behavior

Only the second param is present.
image

Steps to reproduce the bug

Run TypeDoc on the following files:

  • index.d.ts:
export function test(this: typeof globalThis, param: string): string;
  • tsconfig.json:
    {
        "compilerOptions": {
        },
        "typedocOptions": {
                "entryPoints": ["index.d.ts"],
                "out": "docs"
        }
    }

Environment

  • Typedoc version: 0.22.12
  • TypeScript version: 4.5.5
  • Node.js version:
  • OS: Linux
@zombifier zombifier added the bug Functionality does not match expectation label Feb 24, 2022
@zombifier zombifier changed the title fake this parameters not documented fake this parameters not documented Feb 24, 2022
@Gerrit0 Gerrit0 closed this as completed in 95fe32e Mar 6, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

1 participant