typedoc - npm Package Compare versions

Comparing version 0.23.19 to 0.23.20

dist/lib/converter/plugins/CommentPlugin.d.ts

		import { ConverterComponent } from "../components";
		/**
		* A handler that parses TypeDoc comments and attaches {@link Comment} instances to
		* the generated reflections.
		* Handles most behavior triggered by comments. `@group` and `@category` are handled by their respective plugins, but everything else is here.
		*
		* During conversion:
		* - Handle visibility flags (`@private`, `@protected`. `@public`)
		* - Handle module renames (`@module`)
		* - Remove excluded tags & comment discovery tags (`@module`, `@packageDocumentation`)
		* - Copy comments for type parameters from the parent container
		*
		* Resolve begin:
		* - Remove hidden reflections
		*
		* Resolve:
		* - Apply `@label` tag
		* - Copy comments on signature containers to the signature if signatures don't already have a comment
		* and then remove the comment on the container.
		* - Copy comments from signatures to parameters and type parameters (again? why?)
		* - Apply `@group` and `@category` tags
		*
		* Resolve end:
		* - Copy auto inherited comments from heritage clauses
		* - Handle `@inheritDoc`
		* - Resolve `@link` tags to point to target reflections
		*/
		@@ -6,0 +26,0 @@ export declare class CommentPlugin extends ConverterComponent {

dist/lib/converter/plugins/CommentPlugin.js

		@@ -36,4 +36,24 @@ "use strict";
		/**
		* A handler that parses TypeDoc comments and attaches {@link Comment} instances to
		* the generated reflections.
		* Handles most behavior triggered by comments. `@group` and `@category` are handled by their respective plugins, but everything else is here.
		*
		* During conversion:
		* - Handle visibility flags (`@private`, `@protected`. `@public`)
		* - Handle module renames (`@module`)
		* - Remove excluded tags & comment discovery tags (`@module`, `@packageDocumentation`)
		* - Copy comments for type parameters from the parent container
		*
		* Resolve begin:
		* - Remove hidden reflections
		*
		* Resolve:
		* - Apply `@label` tag
		* - Copy comments on signature containers to the signature if signatures don't already have a comment
		* and then remove the comment on the container.
		* - Copy comments from signatures to parameters and type parameters (again? why?)
		* - Apply `@group` and `@category` tags
		*
		* Resolve end:
		* - Copy auto inherited comments from heritage clauses
		* - Handle `@inheritDoc`
		* - Resolve `@link` tags to point to target reflections
		*/
		@@ -40,0 +60,0 @@ let CommentPlugin = class CommentPlugin extends components_1.ConverterComponent {

dist/lib/converter/plugins/InheritDocPlugin.js

		@@ -92,2 +92,13 @@ "use strict";
		return;
		if (!source.comment &&
		source instanceof models_1.DeclarationReflection &&
		source.signatures) {
		source = source.signatures[0];
		}
		if (!source.comment &&
		source instanceof models_1.DeclarationReflection &&
		source.type instanceof models_1.ReflectionType &&
		source.type.declaration.signatures) {
		source = source.type.declaration.signatures[0];
		}
		if (!source.comment) {
		@@ -94,0 +105,0 @@ this.application.logger.warn(`${target.getFullName()} tried to copy a comment from ${source.getFullName()} with @inheritDoc, but the source has no associated comment.`);

package.json

		{
		"name": "typedoc",
		"description": "Create api documentation for TypeScript projects.",
		"version": "0.23.19",
		"version": "0.23.20",
		"homepage": "https://typedoc.org",
		@@ -6,0 +6,0 @@ "main": "./dist/index.js",

New alerts