typedoc 0.26.11 → 0.27.0-beta.0

package/dist/lib/models/ReflectionCategory.js

@@ -1,7 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReflectionCategory = void 0;
-const comments_1 = require("./comments");
+import { Comment } from "./comments/index.js";
 /**
  * A category of reflections.
  *
@@ -9,17 +6,25 @@ const comments_1 = require("./comments");
  * of the dispatcher. The main purpose of categories is to be able to more easily
  * render human readable children lists in templates.
  */
-class ReflectionCategory {
+export class ReflectionCategory {
+    /**
+     * The title, a string representation of this category.
+     */
+    title;
+    /**
+     * The user specified description, if any, set with `@categoryDescription`
+     */
+    description;
+    /**
+     * All reflections of this category.
+     */
+    children = [];
     /**
      * Create a new ReflectionCategory instance.
      *
      * @param title The title of this category.
      */
     constructor(title) {
-        /**
-         * All reflections of this category.
-         */
-        this.children = [];
         this.title = title;
     }
     /**
@@ -32,7 +37,7 @@ class ReflectionCategory {
         return {
             title: this.title,
             description: this.description
-                ? comments_1.Comment.serializeDisplayParts(serializer, this.description)
+                ? Comment.serializeDisplayParts(serializer, this.description)
                 : undefined,
             children: this.children.length > 0
                 ? this.children.map((child) => child.id)
@@ -41,7 +46,7 @@ class ReflectionCategory {
     }
     fromObject(de, obj) {
         if (obj.description) {
-            this.description = comments_1.Comment.deserializeDisplayParts(de, obj.description);
+            this.description = Comment.deserializeDisplayParts(de, obj.description);
         }
         if (obj.children) {
             de.defer((project) => {
@@ -55,4 +60,3 @@ class ReflectionCategory {
         }
     }
 }
-exports.ReflectionCategory = ReflectionCategory;

package/dist/lib/models/ReflectionGroup.d.ts

@@ -1,6 +1,6 @@
-import { ReflectionCategory } from "./ReflectionCategory";
-import type { CommentDisplayPart, DeclarationReflection, DocumentReflection, Reflection } from ".";
-import type { Serializer, JSONOutput, Deserializer } from "../serialization";
+import { ReflectionCategory } from "./ReflectionCategory.js";
+import type { CommentDisplayPart, DeclarationReflection, DocumentReflection, Reflection } from "./index.js";
+import type { Serializer, JSONOutput, Deserializer } from "../serialization/index.js";
 /**
  * A group of reflections. All reflections in a group are of the same kind.
  *

package/dist/lib/models/ReflectionGroup.js

@@ -1,8 +1,5 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ReflectionGroup = void 0;
-const ReflectionCategory_1 = require("./ReflectionCategory");
-const comments_1 = require("./comments");
+import { ReflectionCategory } from "./ReflectionCategory.js";
+import { Comment } from "./comments/index.js";
 /**
  * A group of reflections. All reflections in a group are of the same kind.
  *
@@ -10,7 +7,24 @@ const comments_1 = require("./comments");
  * of the dispatcher. The main purpose of groups is to be able to more easily
  * render human readable children lists in templates.
  */
-class ReflectionGroup {
+export class ReflectionGroup {
+    owningReflection;
+    /**
+     * The title, a string representation of the typescript kind, of this group.
+     */
+    title;
+    /**
+     * User specified description via `@groupDescription`, if specified.
+     */
+    description;
+    /**
+     * All reflections of this group.
+     */
+    children = [];
+    /**
+     * Categories contained within this group.
+     */
+    categories;
     /**
      * Create a new ReflectionGroup instance.
      *
@@ -19,10 +33,6 @@ class ReflectionGroup {
      */
     constructor(title, owningReflection) {
         this.owningReflection = owningReflection;
-        /**
-         * All reflections of this group.
-         */
-        this.children = [];
         this.title = title;
     }
     /**
@@ -35,7 +45,7 @@ class ReflectionGroup {
         return {
             title: this.title,
             description: this.description
-                ? comments_1.Comment.serializeDisplayParts(serializer, this.description)
+                ? Comment.serializeDisplayParts(serializer, this.description)
                 : undefined,
             children: this.children.length > 0
                 ? this.children.map((child) => child.id)
@@ -45,11 +55,11 @@ class ReflectionGroup {
     }
     fromObject(de, obj) {
         if (obj.description) {
-            this.description = comments_1.Comment.deserializeDisplayParts(de, obj.description);
+            this.description = Comment.deserializeDisplayParts(de, obj.description);
         }
         if (obj.categories) {
             this.categories = obj.categories.map((catObj) => {
-                const cat = new ReflectionCategory_1.ReflectionCategory(catObj.title);
+                const cat = new ReflectionCategory(catObj.title);
                 de.fromObject(cat, catObj);
                 return cat;
             });
@@ -66,4 +76,3 @@ class ReflectionGroup {
         }
     }
 }
-exports.ReflectionGroup = ReflectionGroup;

package/dist/lib/models/comments/comment.d.ts

@@ -1,6 +1,6 @@
-import type { Reflection } from "../reflections";
-import { ReflectionSymbolId } from "../reflections/ReflectionSymbolId";
-import type { Serializer, Deserializer, JSONOutput } from "../../serialization";
+import type { Reflection } from "../reflections/index.js";
+import { ReflectionSymbolId } from "../reflections/ReflectionSymbolId.js";
+import type { Serializer, Deserializer, JSONOutput } from "../../serialization/index.js";
 /**
  * Represents a parsed piece of a comment.
  * @category Comments
@@ -21,23 +21,16 @@ export type CommentDisplayPart =
  | {
     kind: "code";
     text: string;
-}
+} | InlineTagDisplayPart | RelativeLinkDisplayPart;
 /**
  * Represents an inline tag like `{@link Foo}`
- */
- | InlineTagDisplayPart
-/**
- * Represents a reference to a path relative to where the comment resides.
- * This is used to detect and copy relative image links.
- * Use {@link FileRegistry} to determine what path on disc this refers to.
- */
- | RelativeLinkDisplayPart;
-/**
+ *
  * The `@link`, `@linkcode`, and `@linkplain` tags may have a `target`
  * property set indicating which reflection/url they link to. They may also
  * have a `tsLinkText` property which includes the part of the `text` which
  * TypeScript thinks should be displayed as the link text.
  * @category Comments
+ * @expand
  */
 export interface InlineTagDisplayPart {
     kind: "inline-tag";
@@ -47,9 +40,16 @@ export interface InlineTagDisplayPart {
     tsLinkText?: string;
 }
 /**
+ * Represents a reference to a path relative to where the comment resides.
+ * This is used to detect and copy relative image links.
+ *
+ * Use {@link FileRegistry} to determine what path on disc this refers to.
+ *
  * This is used for relative links within comments/documents.
  * It is used to mark pieces of text which need to be replaced
  * to make links work properly.
+ * @category Comments
+ * @expand
  */
 export interface RelativeLinkDisplayPart {
     kind: "relative-link";
@@ -62,6 +62,10 @@ export interface RelativeLinkDisplayPart {
      * This may be `undefined` if the relative path does not exist.
      */
     target: number | undefined;
+    /**
+     * Anchor within the target page, validated after rendering if possible
+     */
+    targetAnchor: string | undefined;
 }
 /**
  * A model that represents a single TypeDoc comment tag.
@@ -119,30 +123,7 @@ export declare class Comment {
     /**
      * Helper utility to clone {@link Comment.summary} or {@link CommentTag.content}
      */
-    static cloneDisplayParts(parts: readonly CommentDisplayPart[]): ({
-        kind: "text";
-        text: string;
-    } | {
-        kind: "code";
-        text: string;
-    } | {
-        kind: "inline-tag";
-        tag: `@${string}`;
-        text: string;
-        target?: Reflection | string | ReflectionSymbolId;
-        tsLinkText?: string;
-    } | {
-        kind: "relative-link";
-        /**
-         * The original relative text from the parsed comment.
-         */
-        text: string;
-        /**
-         * A link to either some document outside of the project or a reflection.
-         * This may be `undefined` if the relative path does not exist.
-         */
-        target: number | undefined;
-    })[];
+    static cloneDisplayParts(parts: readonly CommentDisplayPart[]): CommentDisplayPart[];
     static serializeDisplayParts(serializer: Serializer, parts: CommentDisplayPart[]): JSONOutput.CommentDisplayPart[];
     /** @hidden no point in showing this signature in api docs */
     static serializeDisplayParts(serializer: Serializer, parts: CommentDisplayPart[] | undefined): JSONOutput.CommentDisplayPart[] | undefined;
@@ -197,6 +178,11 @@ export declare class Comment {
      * Creates a new Comment instance.
      */
     constructor(summary?: CommentDisplayPart[], blockTags?: CommentTag[], modifierTags?: Set<`@${string}`>);
+    /**
+     * Gets either the `@summary` tag, or a short version of the comment summary
+     * section for rendering in module/namespace pages.
+     */
+    getShortSummary(useFirstParagraph: boolean): readonly CommentDisplayPart[];
     /**
      * Checks if this comment is roughly equal to the other comment.
      * This isn't exactly equal, but just "roughly equal" by the comment