parseXmlDocComment

Kind: Function

Source: atloria-monorepo/libs/parser-core/src/openapi/doc-annotations.ts

Parse a .NET XML documentation comment.

<summary> and <remarks> map cleanly onto the two spec fields: the summary is the one-line contract and remarks is where .NET authors put the long form. When there is no <summary> element at all the comment is plain prose in /// lines, which older code does constantly, so it falls back to reading the text as-is rather than returning nothing.

Signature

ts
function parseXmlDocComment(raw: string): AuthoredDocs

Parameters

Returns: AuthoredDocs