summaryrefslogtreecommitdiffstats
path: root/src/DocGen/DocGen.ts
diff options
context:
space:
mode:
authorChristoph Schlosser <christophschlosser@users.noreply.github.com>2017-10-15 20:12:01 +0200
committerGitHub <noreply@github.com>2017-10-15 20:12:01 +0200
commitc7ebe707bbfbe52c75646a111600986d6c584d03 (patch)
treef5435eda43b5d9bd22348f4400028c07b4a446c8 /src/DocGen/DocGen.ts
parent140229888a0e4a120c11ecaae81132d07cc69e5b (diff)
parent32baa67d95609fc2b0f20c582fe152eeee98ff35 (diff)
downloaddoxdocgen-c7ebe707bbfbe52c75646a111600986d6c584d03.tar.gz
Merge pull request #16 from rowanG077/master
-- Added extensive templating the be able to generated different type…
Diffstat (limited to 'src/DocGen/DocGen.ts')
-rw-r--r--src/DocGen/DocGen.ts18
1 files changed, 4 insertions, 14 deletions
diff --git a/src/DocGen/DocGen.ts b/src/DocGen/DocGen.ts
index 9de9d41..1b5b1e1 100644
--- a/src/DocGen/DocGen.ts
+++ b/src/DocGen/DocGen.ts
@@ -1,19 +1,9 @@
-/**
- * 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);
}