insertJSDocSkeleton: Insert JSDoc skeleton into Javascript source file in RStudio

In dmurdoch/JSDocPlugin: RStudio Plugin for JSDoc Insertions

Description

With a Javascript source file open in RStudio, this function will insert a JSDoc skeleton for the documentation.

Usage

insertJSDocSkeleton(args = getArgList(),
                    tags = getOption("JSDoc.tags"),
                    addWhitespace = TRUE,
                    start = attr(args, "start"),
                    id = attr(args, "id"))

Arguments

args	The arguments that will need documenting.
tags	Extra tags (e.g. @memberof) or other markup to embed in the generated text.
addWhitespace	Should leading whitespace be added, to match the line containing the function definition?
start	Where is the function definition?
id	The id of the source file containing the Javascript.

Details

If an option named "JSDoc.memberof" is set using the options function, it will be inserted as the @memberof tag when the skeleton is created.

If no such option is present when this package is loaded, it will be initialized to c("@memberof ?", "@returns { ? }").

Value

Mainly called for the side effect of inserting the markup comments, but does return the insertion invisibly.

dmurdoch/JSDocPlugin documentation built on May 20, 2019, 7:55 a.m.