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ยง
- Markdown
Line - One line of doc text that roxygen2 reads as markdown.
- PkgLink
- A
pkg::topiclink as roxygen2 reads it.
Constantsยง
- MULTILINE_
TAGS ๐ - Tags whose text runs over several lines (
MULTILINE_TAGSin the macros).
Functionsยง
- bracketed_
targets ๐ - The
[...]link targets in one line of markdown, as(written, target). - has_tag
- Whether the doc comment of
attrshas a@tagline fortag: its first word for a one-wordtag(noRd), its whole text for a longer one (keywords internal), ashas_roxygen_tagin the macros matches it. - markdown_
lines - The doc text of
attrsthat roxygen2 reads as markdown. - pkg_
links - Every
pkg::topiclink in the markdown text ofattrsโ doc comments. - r_
package_ ๐of - The R package roxygen2 links
targetinto, when it reads it aspkg::topicfor a package name R accepts and a Rust path root it does not own.