roxy_tag_rd

Provide a method for this generic if you want a tag to generate output
in <code>.Rd</code> files. See <code>vignette("extending")</code> for more details.

internal

Generate your Rd documentation, 'NAMESPACE' file, and
collation field using specially formatted comments. Writing
documentation in-line with code makes it easier to keep your
documentation up-to-date as your requirements change. 'roxygen2' is
inspired by the 'Doxygen' system for C++.

Hadley Wickham

roxygen2

In-Line Documentation for R

Peter Danenberg

Gábor Csárdi

Manuel Eugster

Posit Software, PBC 

roxy_tag_rd function

<dl><dt>x</dt>
<dd>The tag</dd>
<dt>base_path</dt>
<dd>Path to package root directory.</dd>
<dt>env</dt>
<dd>Environment in which to evaluate code (if needed)</dd></dl>

Arguments

Generate Rd output from a tag — roxy_tag_rd

<dl>

<dt>x</dt>
<dd>The tag</dd>


<dt>base_path</dt>
<dd>Path to package root directory.</dd>


<dt>env</dt>
<dd>Environment in which to evaluate code (if needed)</dd>

</dl>

roxy_tag_rd: Generate Rd output from a tag

Description

Usage

Value

Arguments