adev/shared-docs/pipeline/api-gen/rendering/entities/traits.mts - main - githubmirror/angular

adev/shared-docs/pipeline/api-gen/rendering/entities/traits.mts
128 строк3 KB
Matthieu Riegler
docs(docs-infra): Handle additional description format
21 янв 2026, 22:37
21 янв 2026, 22:37f0b1061
/**
 * @license
 * Copyright Google LLC All Rights Reserved.
 *
 * Use of this source code is governed by an MIT-style license that can be
 * found in the LICENSE file at https://angular.dev/license
 */

import {JsDocTagEntry, MemberEntry, ParameterEntry, PropertyEntry} from '../entities.mjs';

import {
  CodeLineRenderable,
  JsDocTagRenderable,
  LinkEntryRenderable,
  MemberEntryRenderable,
  ParameterEntryRenderable,
  PropertyEntryRenderable,
} from './renderables.mjs';

/** A doc entry that has jsdoc tags. */
export interface HasJsDocTags {
  jsdocTags: JsDocTagEntry[];
}

export interface MaybeJsDocTags {
  jsdocTags?: JsDocTagEntry[];
}

export interface HasAdditionalLinks {
  additionalLinks: LinkEntryRenderable[];
}

/** A doc entry that has jsdoc tags transformed for rendering. */
export interface HasRenderableJsDocTags {
  jsdocTags: JsDocTagRenderable[];
}

/** A doc entry that has a description. */
export interface HasDescription {
  description: string;
}

/** A doc entry that has a transformed html description. */
export interface HasHtmlDescription {
  htmlDescription: string;
  shortHtmlDescription: string;
}

/** A doc entry that has a usage notes. */
export interface HasUsageNotes {
  usageNotes: string;
}

/** A doc entry that has a transformed html usage notes. */
export interface HasHtmlUsageNotes {
  htmlUsageNotes: string;
}

/** A doc entry that has members transformed for rendering. */
export interface HasMembers {
  members: MemberEntry[];
}

export interface HasPropertyMembers {
  members: PropertyEntry[];
}

/** A doc entry that has members groups transformed for rendering. */
export interface HasRenderableMembersGroups {
  membersGroups: Map<string, MemberEntryRenderable[]>;
}

/** A doc entry that has members transformed for rendering. */
export interface HasRenderableMembers {
  members: MemberEntryRenderable[];
}

export interface HasRenderablePropertyMembers {
  members: PropertyEntryRenderable[];
}

/** A doc entry that has an associated JS module name. */
export interface HasModuleName {
  moduleName: string;
}

/** A doc entry that has an associated github repo. */
export interface HasRepo {
  repo: string;
}

/** A doc entry that has ToC transformed for rendering. */
export interface HasRenderableToc {
  // Prefer formatted code if defined,
  formattedCode: string | null;

  // Else use this more messy but more flexible structure (which supports deprecation info)
  beforeCodeGroups: string;
  codeLinesGroups: Map<string, CodeLineRenderable[]>;
  afterCodeGroups: string;
}

/** A doc entry that has params transformed for rendering. */
export interface HasParams {
  params: ParameterEntry[];
}

/** A doc entry that has params for rendering. */
export interface HasRenderableParams {
  params: ParameterEntryRenderable[];
}

export interface HasDeprecatedFlag {
  deprecated: {version: string | undefined} | undefined;
  deprecationMessage: string | null;
}

export interface HasDeveloperPreviewFlag {
  developerPreview: {version: string | undefined} | undefined;
}

export interface hasExperimentalFlag {
  experimental: {version: string | undefined} | undefined;
}

export interface HasStableFlag {
  stable: {version: string | undefined} | undefined;
}