summaryrefslogtreecommitdiffstats
path: root/src/DocGen/DocGen.ts
diff options
context:
space:
mode:
authorChristoph Schlosser <christoph@linux.com>2017-10-06 17:34:19 +0200
committerChristoph Schlosser <christoph@linux.com>2017-10-06 17:35:18 +0200
commitcf5e94e992237bc2f32f0ec92c6babb4b93de612 (patch)
treeec5558e80268aaaee9acf92a877a06b562877f45 /src/DocGen/DocGen.ts
downloaddoxdocgen-cf5e94e992237bc2f32f0ec92c6babb4b93de612.tar.gz
Initial files
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();
+}