src/DocGen/DocGen.ts


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

/**
 * Contains the supported doxygen commands
 *
 * @export
 * @enum {number}
 */
export enum DoxygenCommands {
    brief = "brief",
    return = "return",
    param = "param",
    detailed = "(Detailed description)",
}

export interface IDocGen {
    /**
     * Generate documentation string and write it to the active editor
     */
    GenerateDoc();
}