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

Documenting namespaces #32

Closed
sedghi opened this issue Mar 17, 2022 · 4 comments
Closed

Documenting namespaces #32

sedghi opened this issue Mar 17, 2022 · 4 comments

Comments

@sedghi
Copy link

sedghi commented Mar 17, 2022

Is it possible to add documentation for namespaces?

image

@milesj
Copy link
Owner

milesj commented Mar 17, 2022

@sedghi Does a docblock on the namespace work?

/**
 * Description
 */
export * as foo from './foo';

@sedghi
Copy link
Author

sedghi commented Mar 17, 2022

I have tried putting docBlock in various places but non works for me

@milesj
Copy link
Owner

milesj commented Mar 17, 2022

@sedghi It's most likely on the TypeDoc side and this seems relevant: TypeStrong/typedoc#1855

@milesj
Copy link
Owner

milesj commented May 9, 2022

I was able to verify this works in the latest version.

/**
 * TESTING COMMENT!
 */
export * as cursor from './cursor';

Screen Shot 2022-05-09 at 12 19 49 PM

@milesj milesj closed this as completed May 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants