Docs

module Docs


Assembly	`Nacara.Plugin.Rocq`
Attributes	`[<RequireQualifiedAccess>]`

Renders comment bodies to HTML. Raw HTML in a body is displayed as text.

Functions and values

firstBoldLine (format: CommentFormat) (body: string) : string option

The text of the opening line when the body starts with a line wholly in bold.

pipeline (extensions: IMarkdownExtension list) : MarkdownPipeline

A Markdig pipeline with raw HTML disabled, pipe tables enabled and the given extensions applied.

render (pipeline: MarkdownPipeline) (resolve: Resolve) (format: CommentFormat) (body: string) : string

Renders a comment body to HTML according to its format.

Parameter
`pipeline`	The Markdown pipeline for Markdown comments.
`resolve`	Turns code spans and relative links into references.
`format`	The comment's markup.
`body`	The comment's text.

renderArgument (pipeline: MarkdownPipeline) (resolve: Resolve) (format: CommentFormat) (text: string) : string

Renders an argument entry's text to inline HTML according to its format.

Parameter
`pipeline`	The Markdown pipeline for Markdown comments.
`resolve`	Turns code spans and relative links into references.
`format`	The comment's markup.
`text`	The entry's text.

splitArguments (format: CommentFormat) (firstColumn: int) (body: string) : ArgumentEntry array * string

The argument entries of a comment body, and the body without them. A body with no entries returns unchanged.

An entry continues over the following non-blank lines indented past its dash. Fenced or verbatim text holds no entries.

Parameter
`format`	The comment's markup.
`firstColumn`	The source column of the body's first line.
`body`	The comment's text.