summaryrefslogtreecommitdiffstats
path: root/src/Common/IDocGen.ts
diff options
context:
space:
mode:
Diffstat (limited to 'src/Common/IDocGen.ts')
-rw-r--r--src/Common/IDocGen.ts9
1 files changed, 9 insertions, 0 deletions
diff --git a/src/Common/IDocGen.ts b/src/Common/IDocGen.ts
new file mode 100644
index 0000000..1b5b1e1
--- /dev/null
+++ b/src/Common/IDocGen.ts
@@ -0,0 +1,9 @@
+import { Range } from "vscode";
+
+export interface IDocGen {
+ /**
+ * @brief Generate documentation string and write it to the active editor
+ * @param {Range} rangeToReplace Range to replace with the generated comment.
+ */
+ GenerateDoc(rangeToReplace: Range);
+}