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

Feature support for additional JSDoc tags @interface, @enum, @license #296

Open
houghtonap opened this issue Jun 29, 2021 · 1 comment
Open

Comments

@houghtonap
Copy link

Problem

TypeScript may be used in a mixed mode environment where you may have some TypeScript source files and some JavaScript source files. The TypeScript compiler will process both source file types. In the case when TypeScript processes a .ts source file it can determine when a class is an interface, for example, however, when TypeScript processes a .js source file it cannot. Since both types of source files will be processed by tsdoc there needs to be some mechanism to determine missing information when a .js source file is processed, otherwise the documentation will be incomplete and inaccurate when compared with the TypeScript documentation in the same project.

@interface tag

The @interface tag is supported in JSDoc and it is proposed that it also be supported in tsdoc to allow .js source files to indicate that a class is an interface.

@enum tag

The @enum tag is supported in JSDoc and it is proposed that it also be supported in tsdoc to allow .js source files to indicate that a class is an enumeration.

@license tag

The @license tag is supported in JSDoc and it is proposed that it also be supported in tsdoc to allow both .ts and .js source files to indicate the license associated with the source file.

@crystalfp
Copy link

I dare to add also @module tag used by TypeDoc to mark a comment as global description of the module.

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