Skip to main content

PARAM_FILLER_MARKER

Constant PARAM_FILLER_MARKER 

Source
pub(crate) const PARAM_FILLER_MARKER: &str = ".__MX_PARAM_FILLER__ ";
Expand description

Prefix of a generated @param line in a standalone function’s wrapper (#' .__MX_PARAM_FILLER__ @param x (no documentation available)), for the wrapper registry to resolve when it writes the file (resolve_standalone_pages in miniextendr-api/src/registry.rs, which spells the same prefix). Whether an author @rdname topic names the function’s own page or its file’s stem page (the opt-in group page, #1289), and whether another function on the page documents the argument, is only known then. The registry keeps the line (without the prefix) when the function stays on its own or file-stem page and no other function there documents the argument, and drops it otherwise. roxygen2 keeps the later of two @param lines for one name, so a filler written after the real description would replace it.