needs_roxygenize

A lightweight check that compares modification times of <code>.Rd</code> files in
<code>man/</code> with the source files listed in their backrefs. This is much faster
than running <code>roxygenize()</code> but can suffer from both false negatives (e.g.
if an inherited documentation topic has changed) and false positives (e.g.
if a source file was modified but the change doesn't affect the
documentation).

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 

needs_roxygenize function

<dl><dt>package.dir</dt>
<dd>Location of package top level directory. Default is
working directory.</dd>
<dt>quiet</dt>
<dd>If <code>TRUE</code>, suppresses the message listing out-of-date
man pages.</dd></dl>

Arguments

Check if documentation needs to be updated — needs_roxygenize

<dl>

<dt>package.dir</dt>
<dd>Location of package top level directory. Default is
working directory.</dd>


<dt>quiet</dt>
<dd>If <code>TRUE</code>, suppresses the message listing out-of-date
man pages.</dd>

</dl>

needs_roxygenize: Check if documentation needs to be updated

Description

Usage

Value

Arguments

Examples