RustQ.Syn.Doc (rustq v0.6.0)

Copy Markdown View Source

Utilities for rendering Rust doc comments for downstream docs.

Summary

Functions

Normalizes one Rust doc line for Markdown output.

Renders Rust doc comment lines as Markdown suitable for consumer docs.

Functions

line(line)

@spec line(String.t()) :: String.t()

Normalizes one Rust doc line for Markdown output.

markdown(lines)

@spec markdown([String.t()]) :: String.t()

Renders Rust doc comment lines as Markdown suitable for consumer docs.

This keeps the transformation structural and conservative: it only normalizes Rust intra-doc code links into Markdown code spans and joins lines.