@microsoft/tsdoc

A parser for the TypeScript doc comment syntax


Keywords
TypeScript, documentation, doc, comments, JSDoc, parser, standard, doc-comments, markdown, rushstack, specification, syntax
License
MIT
Install
npm install @microsoft/tsdoc@0.12.12

Documentation

https://tsdoc.org/

#tsdoc chat room   Build Status

Documentation Links

Projects in this monorepo

Folder Version Changelog Description
/api-demo (local project) Code samples illustrating how to use the @microsoft/tsdoc parser
/eslint-plugin npm version changelog eslint-plugin-tsdoc plugin for ESLint
/playground (local project) Source code for the TSDoc Playground web app
/tsdoc npm version changelog @microsoft/tsdoc parser library
/tsdoc-config npm version changelog @microsoft/tsdoc-config loader for tsdoc.json

Contributor Notice

This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.microsoft.com.

When you submit a pull request, a CLA-bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., label, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.

This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.