@eagleoutice/flowr/r-bridge/roxygen2/roxygen-ast.js

Static Dataflow Analyzer and Program Slicer for the R Programming Language

"use strict";
Object.defineProperty(exports, "__esModule", { value: true });
exports.KnownRoxygenTags = void 0;
exports.isKnownRoxygenText = isKnownRoxygenText;
/**
 * Known Roxygen tags as per {@link https://roxygen2.r-lib.org/reference/index.html}
 */
var KnownRoxygenTags;
(function (KnownRoxygenTags) {
    /* ---- Tags Index Crossref ---- */
    KnownRoxygenTags["Aliases"] = "aliases";
    KnownRoxygenTags["Backref"] = "backref";
    KnownRoxygenTags["Concept"] = "concept";
    KnownRoxygenTags["Family"] = "family";
    KnownRoxygenTags["Keywords"] = "keywords";
    KnownRoxygenTags["References"] = "references";
    KnownRoxygenTags["SeeAlso"] = "seealso";
    /* ---- Tags Namespace ---- */
    KnownRoxygenTags["EvalNamespace"] = "evalNamespace";
    KnownRoxygenTags["Export"] = "export";
    KnownRoxygenTags["ExportClass"] = "exportClass";
    KnownRoxygenTags["ExportMethod"] = "exportMethod";
    KnownRoxygenTags["ExportPattern"] = "exportPattern";
    KnownRoxygenTags["ExportS3Method"] = "exportS3Method";
    KnownRoxygenTags["Import"] = "import";
    KnownRoxygenTags["ImportClassesFrom"] = "importClassesFrom";
    KnownRoxygenTags["ImportMethodsFrom"] = "importMethodsFrom";
    KnownRoxygenTags["ImportFrom"] = "importFrom";
    KnownRoxygenTags["RawNamespace"] = "rawNamespace";
    KnownRoxygenTags["UseDynLib"] = "useDynLib";
    /* ---- Tags related to Markdown formatting ---- */
    KnownRoxygenTags["Md"] = "md";
    KnownRoxygenTags["NoMd"] = "noMd";
    KnownRoxygenTags["Section"] = "section";
    /* ---- Documenting Datasets and Classes ---- */
    KnownRoxygenTags["Field"] = "field";
    KnownRoxygenTags["Format"] = "format";
    KnownRoxygenTags["Method"] = "method";
    KnownRoxygenTags["Slot"] = "slot";
    KnownRoxygenTags["Source"] = "source";
    /* ---- Documenting Functions ---- */
    KnownRoxygenTags["Description"] = "description";
    KnownRoxygenTags["Details"] = "details";
    KnownRoxygenTags["Example"] = "example";
    KnownRoxygenTags["Examples"] = "examples";
    KnownRoxygenTags["ExamplesIf"] = "examplesIf";
    KnownRoxygenTags["NoRd"] = "noRd";
    KnownRoxygenTags["Param"] = "param";
    KnownRoxygenTags["RawRd"] = "rawRd";
    KnownRoxygenTags["Return"] = "return";
    KnownRoxygenTags["Returns"] = "returns";
    KnownRoxygenTags["Title"] = "title";
    KnownRoxygenTags["Usage"] = "usage";
    /* ---- Reusing Documentation ---- */
    KnownRoxygenTags["DescribeIn"] = "describeIn";
    KnownRoxygenTags["Eval"] = "eval";
    KnownRoxygenTags["EvalRd"] = "evalRd";
    KnownRoxygenTags["IncludeRmd"] = "includeRmd";
    KnownRoxygenTags["Inherit"] = "inherit";
    KnownRoxygenTags["InheritDotParams"] = "inheritDotParams";
    KnownRoxygenTags["InheritParams"] = "inheritParams";
    KnownRoxygenTags["InheritSection"] = "inheritSection";
    KnownRoxygenTags["Order"] = "order";
    KnownRoxygenTags["RdName"] = "rdname";
    KnownRoxygenTags["Template"] = "template";
    KnownRoxygenTags["TemplateVar"] = "templateVar";
    /* ---- Other, not part of the references above ---- */
    /** Just plain old text */
    KnownRoxygenTags["Text"] = "text";
    KnownRoxygenTags["Name"] = "name";
    KnownRoxygenTags["DocType"] = "docType";
    KnownRoxygenTags["Author"] = "author";
    KnownRoxygenTags["Unknown"] = "unknown";
})(KnownRoxygenTags || (exports.KnownRoxygenTags = KnownRoxygenTags = {}));
const ValidRoxygenTagsSet = new Set(Object.values(KnownRoxygenTags));
/**
 * Checks whether the given text is a known roxygen tag.
 */
function isKnownRoxygenText(text) {
    return ValidRoxygenTagsSet.has(text);
}
//# sourceMappingURL=roxygen-ast.js.map