roxy_tag

roxy_tag_parse

roxy_tag_warning

warn_roxy_tag

<code>roxy_tag()</code> is the constructor for tag objects.
<code>roxy_tag_warning()</code> is superseded by <code>warn_roxy_tag()</code>; use to generate a
warning that includes the location of the tag.

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 function

<dl><dt>tag</dt>
<dd>Tag name. Arguments starting with <code>.</code> are reserved for internal
usage.</dd>
<dt>raw</dt>
<dd>Raw tag value, a string.</dd>
<dt>val</dt>
<dd>Parsed tag value, typically a character vector, but sometimes
a list. Usually filled in by <code>tag_parsers</code></dd>
<dt>file, line</dt>
<dd>Location of the tag</dd>
<dt>x</dt>
<dd>A tag</dd></dl>

Arguments

Define a method for <code>roxy_tag_parse</code> to support new tags. See tag_parsers
for more details.

Methods

roxy_tag S3 constructor — roxy_tag

<dl>

<dt>tag</dt>
<dd>Tag name. Arguments starting with <code>.</code> are reserved for internal
usage.</dd>


<dt>raw</dt>
<dd>Raw tag value, a string.</dd>


<dt>val</dt>
<dd>Parsed tag value, typically a character vector, but sometimes
a list. Usually filled in by <code>tag_parsers</code></dd>


<dt>file, line</dt>
<dd>Location of the tag</dd>


<dt>x</dt>
<dd>A tag</dd>

</dl>

Define a method for <code>roxy_tag_parse</code> to support new tags. See tag_parsers
for more details.

roxy_tag: `roxy_tag` S3 constructor

Description

Usage

Arguments

Methods