import { ParameterContainer, ParamTag } from 'dgeni-packages/typescript/api-doc-types/ParameterContainer'; import { ApiDoc } from 'dgeni-packages/typescript/api-doc-types/ApiDoc'; export interface NormalizedFunctionParameters { params?: FunctionParameterInfo[]; } export interface FunctionParameterInfo extends ParamTag { type: string; isOptional: boolean; } /** * Generic type that represents Dgeni method members and standalone functions. Also it the type * combines the normalized function document so that we can update the doc with type checking. */ export type DefaultFunctionDoc = NormalizedFunctionParameters & ParameterContainer & ApiDoc; /** * The `parameters` property are the parameters extracted from TypeScript and are strings * of the form "propertyName: propertyType" (literally what's written in the source). * * The `params` property is pulled from the `@param` JsDoc tag. We need to merge * the information of these to get name + type + description. * * We will use the `params` property to store the final normalized form since it is already * an object. */ export declare function normalizeFunctionParameters(doc: DefaultFunctionDoc): void;