prettier-plugin-jsdoc/dist/roles.d.ts

A Prettier plugin to format JSDoc comments.

declare const TAGS_SYNONYMS: {
    arg: string;
    argument: string;
    const: string;
    constructor: string;
    desc: string;
    emits: string;
    examples: string;
    exception: string;
    fileoverview: string;
    func: string;
    host: string;
    method: string;
    overview: string;
    params: string;
    prop: string;
    return: string;
    var: string;
    virtual: string;
    yield: string;
    hidden: string;
};
declare const TAGS_DEFAULT: string[];
declare const TAGS_NAMELESS: string[];
declare const TAGS_TYPELESS: string[];
declare const TAGS_PEV_FORMATE_DESCRIPTION: string[];
declare const TAGS_DESCRIPTION_NEEDED: string[];
declare const TAGS_TYPE_NEEDED: string[];
declare const TAGS_VERTICALLY_ALIGN_ABLE: string[];
declare const TAGS_GROUP_HEAD: string[];
declare const TAGS_GROUP_CONDITION: string[];
declare const TAGS_ORDER: {
    remarks: number;
    privateRemarks: number;
    providesModule: number;
    module: number;
    license: number;
    flow: number;
    async: number;
    private: number;
    ignore: number;
    memberof: number;
    version: number;
    file: number;
    author: number;
    deprecated: number;
    since: number;
    category: number;
    description: number;
    example: number;
    abstract: number;
    augments: number;
    constant: number;
    default: number;
    defaultValue: number;
    external: number;
    overload: number;
    fires: number;
    template: number;
    typeParam: number;
    function: number;
    namespace: number;
    borrows: number;
    class: number;
    extends: number;
    member: number;
    typedef: number;
    type: number;
    satisfies: number;
    property: number;
    callback: number;
    param: number;
    yields: number;
    returns: number;
    throws: number;
    other: number;
    see: number;
    todo: number;
};
export { TAGS_PEV_FORMATE_DESCRIPTION, TAGS_DESCRIPTION_NEEDED, TAGS_NAMELESS, TAGS_GROUP_HEAD, TAGS_GROUP_CONDITION, TAGS_ORDER, TAGS_SYNONYMS, TAGS_TYPE_NEEDED, TAGS_TYPELESS, TAGS_VERTICALLY_ALIGN_ABLE, TAGS_DEFAULT, };