Function pushRpcMethodXmlDocs

scripts/codegen/csharp.ts:158–179

(
    lines: string[],
    method: RpcMethod,
    indent: string,
    parameterDescriptions: Array<{ name: string; description?: string; escapeDescription?: boolean }>,
    resultSchema: JSONSchema7 | undefined,
    summaryFallback?: string
)

}

function pushRpcMethodXmlDocs(
    lines: string[],
    method: RpcMethod,
    indent: string,
    parameterDescriptions: Array<{ name: string; description?: string; escapeDescription?: boolean }>,
    resultSchema: JSONSchema7 | undefined,
    summaryFallback?: string
): void {
    lines.push(...xmlDocComment(method.description ?? summaryFallback ?? `Calls "${method.rpcMethod}".`, indent));
    for (const parameter of parameterDescriptions) {
        lines.push(
            ...xmlDocNamedElement(
                "param",
                parameter.name,
                parameter.description ?? fallbackParameterDescription(parameter.name),
                indent,
                parameter.escapeDescription
            )
        );
    }
    lines.push(...xmlDocElement("returns", rpcResultDescription(method, resultSchema), indent));
}

const CANCELLATION_TOKEN_DESCRIPTION =
    'The <see cref="CancellationToken"/> to monitor for cancellation requests. The default is <see cref="CancellationToken.None"/>.';