col_roclet: Roclet for processing the @col tag

In mstr3336/mandrake: Bringing Reading the man Page a Little Closer to the drake Workflow.

Description

Roclet for processing the @col tag

Usage

col_roclet()

## S3 method for class 'roclet_col'
roclet_process(roc, blocks, env, base_path)

## S3 method for class 'roclet_col'
roclet_output(roc, results, base_path, ...)

Output Paths Configuration

• by default, for a package pkgname, mandrake will store its output under "pkgname.yaml" at:

  • pkgname/inst/mandrake

• If you need to customize this, use:

  • This can be done by setting the following in DESCRIPTION:

    • Roxygen: list(mandrake_output = "path/from/pkg/root")

  • See the documentation for roxygen2::roxy_meta_get for more information..

mstr3336/mandrake documentation built on April 27, 2021, 1:53 p.m.