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

Document a simple .d.ts file with no export keyword #1546

Closed
librehome opened this issue Mar 22, 2021 · 3 comments
Closed

Document a simple .d.ts file with no export keyword #1546

librehome opened this issue Mar 22, 2021 · 3 comments
Labels
bug Functionality does not match expectation needs reproduction Needs a minimal reproducible case

Comments

@librehome
Copy link

Expected Behavior

I would expect to see the generated document.

Actual Behavior

But the output is empty.

Can anybody point me a direction? is it possible?

@librehome librehome added the bug Functionality does not match expectation label Mar 22, 2021
@krisztianb
Copy link
Contributor

krisztianb commented Mar 23, 2021

As far as I know only exports are documented. See: https://typedoc.org/guides/options/#entrypoints

But someone posted this about an hour ago: #1549

@Gerrit0 Gerrit0 added the needs reproduction Needs a minimal reproducible case label Mar 25, 2021
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Mar 25, 2021

TypeDoc has some special casing for global files that makes most reasonable cases work.. and without more information here I'm not sure what you aren't seeing @librehome. The following:

const x: number
function y(): boolean

Will result in documentation for x and y

image

@librehome
Copy link
Author

Thanks. I've got it to work.
I had to copy the .d.ts file into a separate folder and generate doc only with that file so that other source filed won't pollute the result.

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 needs reproduction Needs a minimal reproducible case
Projects
None yet
Development

No branches or pull requests

3 participants