diff options
| author | Rowan Goemans <RB.Goemans@student.han.nl> | 2017-10-14 22:29:02 +0200 |
|---|---|---|
| committer | Rowan Goemans <RB.Goemans@student.han.nl> | 2017-10-14 22:29:02 +0200 |
| commit | 0ebfa5bd12e529d8febe73c85d3bf48c4d4997e8 (patch) | |
| tree | 30f7d859a9270b4c70d366a93571054295b4e070 /src/DocGen/DocGen.ts | |
| parent | 140229888a0e4a120c11ecaae81132d07cc69e5b (diff) | |
| download | doxdocgen-0ebfa5bd12e529d8febe73c85d3bf48c4d4997e8.tar.gz | |
-- Added extensive templating the be able to generated different types of doxygen comment.
Diffstat (limited to 'src/DocGen/DocGen.ts')
| -rw-r--r-- | src/DocGen/DocGen.ts | 19 |
1 files changed, 5 insertions, 14 deletions
diff --git a/src/DocGen/DocGen.ts b/src/DocGen/DocGen.ts index 9de9d41..40ea205 100644 --- a/src/DocGen/DocGen.ts +++ b/src/DocGen/DocGen.ts @@ -1,19 +1,10 @@ -/** - * Contains the supported doxygen commands - * - * @export - * @enum {number} - */ -export enum DoxygenCommands { - brief = "brief", - return = "return", - param = "param", - detailed = "(Detailed description)", -} +import { Range } from "vscode"; + export interface IDocGen { /** - * Generate documentation string and write it to the active editor + * @brief Generate documentation string and write it to the active editor + * @param {Range} rangeToReplace Range to replace with the generated comment. */ - GenerateDoc(); + GenerateDoc(rangeToReplace: Range); } |