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

marge same name's var and type as class? #2479

Closed
steve02081504 opened this issue Jan 8, 2024 · 2 comments
Closed

marge same name's var and type as class? #2479

steve02081504 opened this issue Jan 8, 2024 · 2 comments
Labels
enhancement Improved functionality

Comments

@steve02081504
Copy link
Contributor

Search Terms

marge as class

Problem

For some ts syntax limitation I have to express a class with a variable and a type.
https://ukatech.github.io/jsstp-lib/doc/EN/types/ghost_events_queryer_t.html
https://ukatech.github.io/jsstp-lib/doc/EN/variables/ghost_events_queryer_t-1.html
Is it possible to merge them into a class in the generated document for easy reading?

Suggested Solution

idk

@steve02081504 steve02081504 added the enhancement Improved functionality label Jan 8, 2024
@Gerrit0
Copy link
Collaborator

Gerrit0 commented Jan 10, 2024

Hmm.. it seems somewhat reasonable to me to look for an @class in comments for variables, and interpret that type as a class.

@steve02081504
Copy link
Contributor Author

Hmm.. it seems somewhat reasonable to me to look for an @class in comments for variables, and interpret that type as a class.

I just thought it would be nice to have some way to merge the following pages into one - considering that they would have been just defining different parts of the same class
https://ukatech.github.io/jsstp-lib/doc/EN/types/ghost_events_queryer_t.html
https://ukatech.github.io/jsstp-lib/doc/EN/variables/ghost_events_queryer_t-1.html
https://ukatech.github.io/jsstp-lib/doc/EN/classes/_internal_.ghost_events_queryer_t_class_impl.html
https://ukatech.github.io/jsstp-lib/doc/EN/types/_internal_.ghost_events_queryer_t_call_signature.html
https://ukatech.github.io/jsstp-lib/doc/EN/types/_internal_.ghost_events_queryer_t_constructor.html
Of course, typedoc doesn't have to do this, it's just that ts itself doesn't allow types with call signatures to be defined, so I had to split the class this way.
If this is really difficult to implement, you can close this issue, I completely understand!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Improved functionality
Projects
None yet
Development

No branches or pull requests

2 participants