Struct RoxygenBuilder 

pub struct RoxygenBuilder {
    name: Option<String>,
    rdname: Option<String>,
    title: Option<String>,
    description: Option<String>,
    source: Option<String>,
    export: bool,
    export_method: Option<String>,
    method: Option<(String, String)>,
    custom_tags: Vec<String>,
}

Builder for generating roxygen2 documentation tags.

Provides a fluent API for building common roxygen tag patterns used across all class systems.

Example

let tags = RoxygenBuilder::new()
    .name("Counter$increment")
    .rdname("Counter")
    .export()
    .build();
// => vec!["#' @name Counter$increment", "#' @rdname Counter", "#' @export"]

Fields

name: Option<String>

Value for @name tag. Identifies the documented topic (e.g., "Counter$increment").

rdname: Option<String>

Value for @rdname tag. Groups multiple entries onto a single help page (e.g., all methods of "Counter" share one Rd file).

title: Option<String>

Value for @title tag. The one-line title shown in help page headers.

description: Option<String>

Value for @description tag. Longer description text below the title.

source: Option<String>

Value for @source tag. Typically "Generated by miniextendr" provenance info.

export: bool

Whether to emit @export. When true, the item is exported from the package NAMESPACE.

export_method: Option<String>

Value for @exportMethod tag. Used for S4 method exports (e.g., "show").

method: Option<(String, String)>

Values for @method tag as (generic, class). Used for S3 method dispatch (e.g., ("print", "Counter") emits @method print Counter).

custom_tags: Vec<String>

Additional custom tag lines emitted verbatim (without the #' prefix, which is added during build). Used for tags like @keywords internal or @param entries.

Implementations

impl RoxygenBuilder

pub fn new() -> Self

Create a new empty builder.

pub fn name(self, name: impl Into<String>) -> Self

Set the @name tag.

pub fn rdname(self, rdname: impl Into<String>) -> Self

Set the @rdname tag (groups docs into one page).

pub fn title(self, title: impl Into<String>) -> Self

Set the @title tag.

pub fn description(self, desc: impl Into<String>) -> Self

Set the @description tag.

pub fn source(self, source: impl Into<String>) -> Self

Set the @source tag (typically “Generated by miniextendr…”).

pub fn export(self) -> Self

Add @export tag.

pub fn export_method(self, method: impl Into<String>) -> Self

Add @exportMethod tag (for S4).

pub fn method( self, generic: impl Into<String>, class: impl Into<String>, ) -> Self

Add @method tag (for S3).

pub fn custom(self, tag: impl Into<String>) -> Self

Add a custom tag line (without the #' prefix).

pub fn build(&self) -> Vec<String>

Build the roxygen tag lines (each prefixed with #' ).

Trait Implementations

impl Default for RoxygenBuilder

Creates an empty builder with no tags set.

fn default() -> Self

Returns the “default value” for a type.

Layout

Note: Most layout information is completely unstable and may even differ between compilations. The only exception is types with certain repr(...) attributes. Please see the Rust Reference's “Type Layout” chapter for details on type layout guarantees.

Size: 224 bytes