Skip to main content

resolve_standalone_pages

Function resolve_standalone_pages 

Source
fn resolve_standalone_pages(fragments: &[StandaloneFragment<'_>]) -> Vec<String>
Expand description

Resolve the standalone functions’ fragments, in emission order (#1590):

  • give a roxygen block that picks no page itself (see has_page_assignment_tag) and has no @title the function name as its title. Such a block documents the function’s own page, as in roxygen2; grouping functions on one page is opt-in through an explicit @rdname (#1289);
  • resolve each generated @param filler (marked with PARAM_FILLER_MARKER by the macro): keep it, unmarked, when the block stays on its own page or its file’s stem page (@rdname <file stem>) and no other block of that page documents the argument; drop it when the block joins a topic defined elsewhere (that topic’s block documents the arguments) or another function on the page documents the argument (roxygen2 keeps the later of two @param lines for a name, so a filler would replace the real text);
  • give a block that joins a topic defined elsewhere @order NaN (ORDER_AFTER_TOPIC_BLOCKS), so the topic’s own block names and titles the merged page whatever the R file order (an author @order is kept).

Only the wrapper file is visible here: an R-file block that joins a file-stem page does not count as documenting its arguments. Reading the package’s R/*.R blocks would tie the generated wrappers to R sources the build does not track: they are regenerated only when the shared library is relinked, so they would not follow an R-file edit.