summaryrefslogtreecommitdiffstats
path: root/src/DocGen/DocGen.ts
diff options
context:
space:
mode:
Diffstat (limited to 'src/DocGen/DocGen.ts')
-rw-r--r--src/DocGen/DocGen.ts19
1 files changed, 19 insertions, 0 deletions
diff --git a/src/DocGen/DocGen.ts b/src/DocGen/DocGen.ts
new file mode 100644
index 0000000..9de9d41
--- /dev/null
+++ b/src/DocGen/DocGen.ts
@@ -0,0 +1,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();
+}