document_it: Generate documentation for the files of a directory.

In documenter: Documents Files

Generate documentation for the files of a directory.

Description

Generate documentation for the files of a directory.

Usage

document_it(input_directory, output_file, annotation_file = NULL, title = NULL)

Arguments

input_directory	The directory of files to be documented.
output_file	The path to the output file that will be generated.
annotation_file	The path to the annotation file if present.
title	The title of the output document.

Examples

## Not run: 
input <- system.file("extdata", "example", package = "documenter")
document_it(
input_directory = input,
output_file = "documentation",
annotation_file = NULL
)

## End(Not run)

documenter documentation built on Jan. 5, 2023, 5:11 p.m.