tsdoc | A doc comment standard for TypeScript | Parser library

by microsoft TypeScript Version: @microsoft/tsdoc_v0.13.0 License: MIT

X-Ray Key Features Code Snippets Community Discussions(7)Vulnerabilities Install Support

kandi X-RAY | tsdoc Summary

tsdoc is a TypeScript library typically used in Utilities, Parser, Nodejs applications. tsdoc has no bugs, it has no vulnerabilities, it has a Permissive License and it has medium support. You can download it from GitHub.

A doc comment standard for TypeScript

Support

Quality

Security

License

Reuse

Support

tsdoc has a medium active ecosystem.

It has 4387 star(s) with 131 fork(s). There are 53 watchers for this library.

It had no major release in the last 12 months.

There are 115 open issues and 55 have been closed. On average issues are closed in 112 days. There are 6 open pull requests and 0 closed requests.

It has a neutral sentiment in the developer community.

The latest version of tsdoc is @microsoft/tsdoc_v0.13.0

Quality

tsdoc has no bugs reported.

Security

tsdoc has no vulnerabilities reported, and its dependent libraries have no vulnerabilities reported.

License

tsdoc is licensed under the MIT License. This license is Permissive.

Permissive licenses have the least restrictions, and you can use them in most projects.

Reuse

tsdoc releases are available to install and integrate.

Top functions reviewed by kandi - BETA

kandi's functional review helps you automatically verify the functionalities of the libraries and avoid rework.
Currently covering the most popular Java, JavaScript and Python libraries. See a Sample of tsdoc

Get all kandi verified functions for this library.

tsdoc Key Features

No Key Features are available at this moment for tsdoc.

tsdoc Examples and Code Snippets

No Code Snippets are available at this moment for tsdoc.

Community Discussions

Trending Discussions on tsdoc

prevent asking "Missing JSDoc comment" for standard react methods in typescript project

What is the proper format for typing React props in TSDoc?

Is there a way to describe a field in typedoc?

TSDoc eslint-plugin-tsdoc ignore specific files

Ignore specific file from specific eslint plugin

How to document union types in typescript?

tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name (TypeScript ESLint and React)

QUESTION

prevent asking "Missing JSDoc comment" for standard react methods in typescript project

Asked 2021-May-16 at 13:29

we have React project with Typescript. We use TSDoc to standardize the doc comments used in TypeScript code

Our eslint.trc file as follow:

...

ANSWER

Answered 2021-May-16 at 13:29

I've resolved this problem with this plugin https://www.npmjs.com/package/eslint-plugin-require-jsdoc-except?activeTab=readme

You can add your function names at ignore:

Source https://stackoverflow.com/questions/67447335

QUESTION

What is the proper format for typing React props in TSDoc?

Asked 2021-Feb-19 at 17:28

I'm trying to apply the TSDoc standard for comments to a React project written in Typescript (with an eye towards generating documentation with Typedoc), but can't find any definitive answers for the preferred way to annotate a React props object. I've got this so far, where MyProps is an interface:

...

ANSWER

Answered 2021-Feb-19 at 17:28

You want to document the props interface, and not the component itself. Which means this is the same as documenting fields of an interface.

Source https://stackoverflow.com/questions/66281986

QUESTION

Is there a way to describe a field in typedoc?

Asked 2021-Feb-15 at 01:49

The code is:

...

ANSWER

Answered 2021-Feb-15 at 01:49

The TSDoc playground is extremely limited - it will only parse and display the first doc comment it finds. There is an open issue with others also being confused by its scope.

TypeDoc is not the same thing as TSDoc. TSDoc is a doc comment standard that will eventually be adopted by TypeDoc, whereas TypeDoc is a documentation generator. If you give TypeDoc that class (assuming it is exported), then it will properly document it as a class with a property message having the provided description.

Source https://stackoverflow.com/questions/66174349

QUESTION

TSDoc eslint-plugin-tsdoc ignore specific files

Asked 2021-Feb-11 at 03:02

I have just started using TSDoc combined with TypeDoc and I love it.

I have a little problem, well, annoyance really. I want the eslint-plugin-tsdoc to ignore files that will be used to generate the api documentation, which I will be using apidocjs.com to generate for me.

In PhpStorm and command line I get warnings for these files, I would like to be able to ignore these. I have not seen any settings to allow for this.

I have excluded the api tags via typedoc.json config file, but this doesn't work for the eslint plugin, which makes sense as they are different.

Is there a setting for this?

...

ANSWER

Answered 2021-Feb-11 at 03:02

Thanks to another question I asked, but similar we have a resolution for this question

see https://stackoverflow.com/a/66134916/9431766

Source https://stackoverflow.com/questions/65835679

QUESTION

Ignore specific file from specific eslint plugin

Asked 2021-Feb-10 at 10:16

I am using eslint-plugin-tsdoc which works well, except for files where I don't require the linting, for instance, any api routes which use apidoc instead of tsdoc commenting styles.

This is causing errors when running any linting. Is there anyway that I can ignore files for the eslint-plugin-tsdoc? I don’t want to ignore the file altogether by eslint because I still need the typescript to be checked.

...

ANSWER

Answered 2021-Feb-10 at 10:16

You can use the override property in .eslintrc file. Using configuration files to disable for a group of files

Since eslint-plugin-tsdoc only has one rule tsdoc/syntax.

You need to add this to your .eslintrc file.

Source https://stackoverflow.com/questions/66129002

QUESTION

How to document union types in typescript?

Asked 2021-Feb-03 at 11:55

How to document Union type in typescript so typedoc can pull/show relevant info? This below is a JSDoc reference but is there one for TSDoc?

Example

...

ANSWER

Answered 2021-Feb-03 at 11:55

It appears that it doesn't matter what comments we put there the DocFx is unable to generate pages for type aliases and functions but only for classes, interfaces, etc ... at least at the specified version.

I have confirmed this by inspecting the generated *.json output file and the resulting *.yml files. All mentioned files include the metadata but the docfx doesn't generate the html pages for them the right way.

Now I'm using only typedoc with typedoc-plugin-markdown to generate docs and its working fine in its own capacity.

Source https://stackoverflow.com/questions/65941422

QUESTION

tsdoc-param-tag-with-invalid-name: The @param block should be followed by a valid parameter name (TypeScript ESLint and React)

Asked 2020-Sep-07 at 12:14

I'm using JSDoc and TSDoc for a React Native project with TypeScript. There is some strange behavior when documentings props.

All @param: props.propName are underlined with message:

...

ANSWER

Answered 2020-Sep-07 at 12:14

Just move the property description to the interface definition, like on below:

Source https://stackoverflow.com/questions/63775660

Community Discussions, Code Snippets contain sources that include Stack Exchange Network

Vulnerabilities

No vulnerabilities reported

Install tsdoc

You can download it from GitHub.

Support

What is TSDoc? - project overview and roadmapZulip chat room - live help from other developersTSDoc tag reference - learn about syntax elements such as @param, @remarks, etc.TSDoc Playground - interactive demo of the parser engineContributing: Building the projects - how to build and debug the projects in this repoContributing: Submitting a PR - instructions for making a pull request

Find more information at: