tests/testthat/_snaps/rd-r6-field.md

warns about undocumented fields

Code
  docs <- r6_doc(text)
Message
  x In topic 'C': Undocumented R6 field: undocumented_field.

warns about fields documented multiple times

Code
  docs <- r6_doc(text)
Message
  x <text>:5: R6 field documented multiple times: x.

warns about unknown fields

Code
  docs <- r6_doc(text)
Message
  x <text>:4: Unknown R6 field: nosuch.
  x In topic 'C': Undocumented R6 field: x.

format.rd_r6_field produces \item markup

Code
  cat(format(rd_r6_field("x", "A number.")))
Output
  \item{\code{x}}{A number.}

format.rd_r6_fields produces fields & bindings sections

Code
  cat(format(fields), sep = "\n")
Output
  \section{Public fields}{
    \if{html}{\out{<div class="r6-fields">}}
    \describe{
      \item{\code{x}}{A number.}

      \item{\code{y}}{A string.}
    }
    \if{html}{\out{</div>}}
  }
Code
  cat(format(bindings), sep = "\n")
Output
  \section{Active bindings}{
    \if{html}{\out{<div class="r6-active-bindings">}}
    \describe{
      \item{\code{val}}{A value.}
    }
    \if{html}{\out{</div>}}
  }


Try the roxygen2 package in your browser

Any scripts or data that you put into this service are public.

roxygen2 documentation built on May 1, 2026, 5:06 p.m.