microsoft/tsdoc

Features

• Doc-Comment Extractors - Parses existing documentation comments into structured objects to facilitate rendering in different output formats.
• TypeScript - Establishes a standardized way to write documentation comments for TypeScript code across different tools.
• API Reference Generators - Converts source code comments into searchable public documentation with cross-references and stability markers.
• API Stability Frameworks - Implements a system for designating the release stage and stability level of API items.
• API Documentation Linting - Validates that documentation comments follow a specific syntax and style to ensure consistent API references.
• Syntax Validation - Analyzes comments during linting to ensure they adhere to official specifications and style guidelines.
• Documentation Tooling Frameworks - Provides a foundation for building parsers and generators that extract structured metadata from TypeScript comments.
• Syntax Validation - Enforces syntax consistency using strict or lax modes to catch typos and ensure reliable rendering of doc comments.
• Cross-Reference Syntax - Provides standardized syntax to link documentation comments to other code entities for cross-referencing.
• API Specification Standards - Defines a portable standard for metadata, tags, and cross-references within source code comments.
• API Stability Markers - Implements markers to communicate whether an API feature is stable, experimental, or beta.
• Deprecated Feature Markings - Provides standard markers to flag code elements as obsolete and suggest alternatives for migration.
• Source Coordinate Mapping - Maps every input token to its exact source code location for precise error reporting.
• Source Coordinate Tracking - Records line and column offsets for tokens to map parse tree elements back to original source code for precise error reporting.
• Abstract Syntax Tree Parsing - Transforms documentation comments into a structured tree representation for consistent analysis and rendering across different tools.
• Documentation Validators - Enforces syntax consistency and validates doc comment adherence to the TSDoc formal specification.
• Documentation Standards - Defines the specification for writing structured doc comments in TypeScript to ensure consistent parsing.
• Internal Visibility Markers - Designates code elements as unsuitable for third-party use to exclude them from public documentation.
• Documentation Reference Resolution - Resolves symbolic links and references across multiple documentation files or packages using project metadata.
• Experimental API Markers - Allows flagging specific code members as unstable to warn users that functionality may change.
• Documentation Tag Extractions - Extracts structured metadata from comments by identifying block, modifier, and inline tags using a standard specification.
• Custom Documentation Tag Definitions - Specifies custom tags using a portable configuration file so they can be recognized across different tooling.
• Documentation Configuration - Configures how documentation is parsed and processed via repository metadata and configuration files.
• Documentation Inheritance - Implements logic for automatically propagating documentation from parent definitions to child implementations.
• Parser Extension Configurations - Uses portable external configuration files to define custom documentation tags and behaviors without modifying the core parser.
• Programmatic Documentation Maintenance - Supports the programmatic modification and regeneration of documentation comments via structured syntax trees.
• Documentation Usage Examples - Allows defining documentation sections as illustrative usage examples with optional titles and code samples.
• Return Value Documentation - Enables specifying the type and meaning of the value a function returns to the caller.
• AST-to-Comment Regeneration - Converts a structured syntax tree back into plain text comments to support automated modifications.
• Visibility Modifiers - Provides mechanisms to mark documentation sections as private to exclude them from public API references.
• Inheritance Intent Markers - Allows developers to identify functions or properties that redefine inherited members via documentation tags.
• Summary-Detail Separation - Allows dividing documentation into brief summaries for index pages and detailed remarks for full pages.
• Class Inheritance Restrictions - Provides mechanisms to mark classes as non-inheritable to enforce architectural boundaries in documentation.
• Documentation Default Values - Provides a standard way to specify the default value for a member in the documentation.
• Exception Documentation - Allows describing the specific error types a function may throw to inform the caller of failure modes.
• Specification Reference Resolvers - Resolves remote file pointers and inheritance markers within API specifications to distribute code across packages.
• Operation Parameter Documentation - Uses structured tags to associate descriptive explanations with specific function parameters.
• Multi-Mode Syntax Validations - Analyzes comments using strict, lax, or transitional rules to enforce specification compliance while allowing for gradual migration.
• Bidirectional Transformations - Converts structured syntax trees back into plain text comments to allow for automated modification of source code.
• Parser Tag Extensions - Defines and recognizes custom documentation tags that go beyond the standard specification.

Star history