Class ParamAnnotation

Describes a module or function parameter annotation. It has the form of @param name [... optional tags] description The tags either contain a name ([positional]) for binary tags or a name and a value ([conflictsWith=abc,cba])

Constructors

Properties

description: string
link: string
tags: {
    conflictsWith: string[];
    named: boolean;
    positional: boolean;
    possibleValues: string[];
    required: boolean;
    type: string[];
    [x: string]: any;
} = ...
annotationTag: string = "param"