mirror of
https://github.com/angular/angular.git
synced 2026-09-14 13:54:52 +08:00
Shuaib Hasan Akib
cc066cb31f
Block entries (@if, @defer, @for,@let, @switch) were falling back to the generic
DocsReference template, causing the description to appear twice - once in
the header section and once in the main content area.
This commit adds a dedicated rendering path for block entries:
- Creates BlockEntryRenderable type and associated transforms
- Adds BlockReference template that uses RawHtml directly
- Modifies HeaderApi to accept hideDescription prop
- Updates processing and rendering pipelines to handle blocks
The fix ensures block documentation displays only one description section
while preserving the existing behavior for all other API entry types.
Update adev/shared-docs/pipeline/api-gen/rendering/transforms/block-transforms.mts
Co-authored-by: Matthieu Riegler <kyro38@gmail.com>
(cherry picked from commit 8bdd98ef41)
91 lines
2.9 KiB
TypeScript
91 lines
2.9 KiB
TypeScript
/*!
|
|
* @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 {DocEntry} from './entities.mjs';
|
|
|
|
import {CliCommand} from './cli-entities.mjs';
|
|
import {
|
|
isClassEntry,
|
|
isCliEntry,
|
|
isConstantEntry,
|
|
isDecoratorEntry,
|
|
isEnumEntry,
|
|
isFunctionEntry,
|
|
isInitializerApiFunctionEntry,
|
|
isInterfaceEntry,
|
|
isTypeAliasEntry,
|
|
isBlockEntry,
|
|
} from './entities/categorization.mjs';
|
|
import {CliCommandRenderable, DocEntryRenderable} from './entities/renderables.mjs';
|
|
import {getClassRenderable} from './transforms/class-transforms.mjs';
|
|
import {getCliRenderable} from './transforms/cli-transforms.mjs';
|
|
import {getConstantRenderable} from './transforms/constant-transforms.mjs';
|
|
import {getDecoratorRenderable} from './transforms/decorator-transforms.mjs';
|
|
import {getEnumRenderable} from './transforms/enum-transforms.mjs';
|
|
import {getFunctionRenderable} from './transforms/function-transforms.mjs';
|
|
import {getInitializerApiFunctionRenderable} from './transforms/initializer-api-functions-transform.mjs';
|
|
import {getInterfaceRenderable} from './transforms/interface-transforms.mjs';
|
|
import {
|
|
addHtmlAdditionalLinks,
|
|
addHtmlDescription,
|
|
addHtmlJsDocTagComments,
|
|
addHtmlUsageNotes,
|
|
setEntryFlags,
|
|
} from './transforms/jsdoc-transforms.mjs';
|
|
import {addModuleName} from './transforms/module-name.mjs';
|
|
import {addRepo} from './transforms/repo.mjs';
|
|
import {getTypeAliasRenderable} from './transforms/type-alias-transforms.mjs';
|
|
import {getBlockRenderable} from './transforms/block-transforms.mjs';
|
|
|
|
export async function getRenderable(
|
|
entry: DocEntry | CliCommand,
|
|
moduleName: string,
|
|
repo: string,
|
|
): Promise<DocEntryRenderable | CliCommandRenderable> {
|
|
if (isCliEntry(entry)) {
|
|
return getCliRenderable(entry);
|
|
}
|
|
|
|
if (isClassEntry(entry)) {
|
|
return getClassRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isDecoratorEntry(entry)) {
|
|
return getDecoratorRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isConstantEntry(entry)) {
|
|
return getConstantRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isEnumEntry(entry)) {
|
|
return getEnumRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isInterfaceEntry(entry)) {
|
|
return getInterfaceRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isFunctionEntry(entry)) {
|
|
return getFunctionRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isTypeAliasEntry(entry)) {
|
|
return getTypeAliasRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isInitializerApiFunctionEntry(entry)) {
|
|
return getInitializerApiFunctionRenderable(entry, moduleName, repo);
|
|
}
|
|
if (isBlockEntry(entry)) {
|
|
return getBlockRenderable(entry, moduleName, repo);
|
|
}
|
|
|
|
// Fallback to an uncategorized renderable.
|
|
return setEntryFlags(
|
|
addHtmlAdditionalLinks(
|
|
addHtmlDescription(
|
|
addHtmlUsageNotes(addHtmlJsDocTagComments(addRepo(addModuleName(entry, moduleName), repo))),
|
|
),
|
|
),
|
|
);
|
|
}
|