diff --git a/adev/shared-docs/pipeline/api-gen/rendering/templates/class-method-info.tsx b/adev/shared-docs/pipeline/api-gen/rendering/templates/class-method-info.tsx index b37d5d5e83e..e64dd38b4b3 100644 --- a/adev/shared-docs/pipeline/api-gen/rendering/templates/class-method-info.tsx +++ b/adev/shared-docs/pipeline/api-gen/rendering/templates/class-method-info.tsx @@ -12,15 +12,18 @@ import { ParameterEntryRenderable, } from '../entities/renderables.mjs'; import {PARAM_KEYWORD_CLASS_NAME, REFERENCE_MEMBER_CARD_ITEM} from '../styling/css-classes.mjs'; +import {CodeSymbol} from './code-symbols'; import {DeprecatedLabel} from './deprecated-label'; import {Parameter} from './parameter'; import {RawHtml} from './raw-html'; -import {CodeSymbol} from './code-symbols'; /** * Component to render the method-specific parts of a class's API reference. */ -export function ClassMethodInfo(props: {entry: FunctionSignatureMetadataRenderable}) { +export function ClassMethodInfo(props: { + entry: FunctionSignatureMetadataRenderable; + hideUsageNotes?: boolean; +}) { const entry = props.entry; return ( @@ -43,7 +46,7 @@ export function ClassMethodInfo(props: {entry: FunctionSignatureMetadataRenderab @returns - {entry.htmlUsageNotes ? ( + {entry.htmlUsageNotes && !props.hideUsageNotes ? (
Usage notes diff --git a/adev/shared-docs/pipeline/api-gen/rendering/templates/function-reference.tsx b/adev/shared-docs/pipeline/api-gen/rendering/templates/function-reference.tsx index 6741bb3d3b4..e1aa46b849b 100644 --- a/adev/shared-docs/pipeline/api-gen/rendering/templates/function-reference.tsx +++ b/adev/shared-docs/pipeline/api-gen/rendering/templates/function-reference.tsx @@ -22,23 +22,22 @@ import {printInitializerFunctionSignatureLine} from '../transforms/code-transfor import {getFunctionMetadataRenderable} from '../transforms/function-transforms.mjs'; import {ClassMethodInfo} from './class-method-info'; import {CodeSymbol} from './code-symbols'; +import {DeprecationWarning} from './deprecation-warning'; import {HeaderApi} from './header-api'; import {HighlightTypeScript} from './highlight-ts'; import {SectionApi} from './section-api'; import {SectionDescription} from './section-description'; import {SectionUsageNotes} from './section-usage-notes'; -import {DeprecationWarning} from './deprecation-warning'; export const signatureCard = ( name: string, signature: FunctionSignatureMetadataRenderable, - opts: {id: string}, - printSignaturesAsHeader: boolean, + opts: {id: string; printSignaturesAsHeader: boolean; hideUsageNotes?: boolean}, ) => { return (
- {printSignaturesAsHeader ? ( + {opts.printSignaturesAsHeader ? (
- +
); @@ -75,14 +74,11 @@ export function FunctionReference(entry: FunctionEntryRenderable) {
{entry.signatures.map((s, i) => - signatureCard( - s.name, - getFunctionMetadataRenderable(s, entry.moduleName, entry.repo), - { - id: `${s.name}_${i}`, - }, + signatureCard(s.name, getFunctionMetadataRenderable(s, entry.moduleName, entry.repo), { + id: `${s.name}_${i}`, printSignaturesAsHeader, - ), + hideUsageNotes: true, + }), )}
diff --git a/adev/shared-docs/pipeline/api-gen/rendering/templates/initializer-api-function.tsx b/adev/shared-docs/pipeline/api-gen/rendering/templates/initializer-api-function.tsx index dce391ee959..0a3fb8e840b 100644 --- a/adev/shared-docs/pipeline/api-gen/rendering/templates/initializer-api-function.tsx +++ b/adev/shared-docs/pipeline/api-gen/rendering/templates/initializer-api-function.tsx @@ -40,14 +40,10 @@ export function InitializerApiFunction(entry: InitializerApiFunctionRenderable)
{entry.callFunction.signatures.map((s, i) => - signatureCard( - s.name, - getFunctionMetadataRenderable(s, entry.moduleName, entry.repo), - { - id: `${s.name}_${i}`, - }, + signatureCard(s.name, getFunctionMetadataRenderable(s, entry.moduleName, entry.repo), { + id: `${s.name}_${i}`, printSignaturesAsHeader, - ), + }), )} {entry.subFunctions.reduce( @@ -59,8 +55,8 @@ export function InitializerApiFunction(entry: InitializerApiFunctionRenderable) getFunctionMetadataRenderable(s, entry.moduleName, entry.repo), { id: `${entry.name}_${s.name}_${i}`, + printSignaturesAsHeader, }, - printSignaturesAsHeader, ), ), ],