Skip to main content

own_block_page_lines

Function own_block_page_lines 

Source
fn own_block_page_lines(
    method: &TraitMethod,
    type_str: &str,
    default_name: Option<&str>,
    split_title: Option<&str>,
) -> Vec<String>
Expand description

The page lines of a trait method’s own wrapper block, as MethodDocBuilder writes an inherent method’s (#1590):

  • the author’s PAGE_TAGS, verbatim;
  • without an author @describeIn: @name default_name unless the author named the topic (blocks roxygen2 cannot name from their object need one), @rdname <Type> unless the author picked the page, and, on a page the author’s @rdname splits off, @title split_title (roxygen2 skips a page without a title). With @describeIn roxygen2 takes the page from the destination and rejects @name / @rdname next to it, so neither is generated;
  • @order NaN on an author topic the author did not order (roxygen::orders_after_topic_blocks).