Skip to main content

Module doc_links

Module doc_links 

Source
Expand description

The doc-comment text of #[miniextendr] items that reaches roxygen2 as markdown, and the pkg::topic links inside it (MXL204).

The walk mirrors miniextendr-macros/src/roxygen.rs: leading prose comes first, then @tag sections. The text of a code tag (@examples, โ€ฆ) is not markdown, and the lines after a single-line tag (@export, โ€ฆ) stay in rustdoc only. Fenced code blocks are skipped. Keep MULTILINE_TAGS and CODE_TAGS in sync with that file.

Structsยง

MarkdownLine
One line of doc text that roxygen2 reads as markdown.
PkgLink
A pkg::topic link as roxygen2 reads it.

Constantsยง

MULTILINE_TAGS ๐Ÿ”’
Tags whose text runs over several lines (MULTILINE_TAGS in the macros).

Functionsยง

bracketed_targets ๐Ÿ”’
The [...] link targets in one line of markdown, as (written, target).
has_tag
Whether the doc comment of attrs has a @tag line for tag: its first word for a one-word tag (noRd), its whole text for a longer one (keywords internal), as has_roxygen_tag in the macros matches it.
markdown_lines
The doc text of attrs that roxygen2 reads as markdown.
pkg_links
Every pkg::topic link in the markdown text of attrsโ€™ doc comments.
r_package_of ๐Ÿ”’
The R package roxygen2 links target into, when it reads it as pkg::topic for a package name R accepts and a Rust path root it does not own.