diff options
Diffstat (limited to 'src/Common')
| -rw-r--r-- | src/Common/ICodeParser.ts | 9 | ||||
| -rw-r--r-- | src/Common/IDocGen.ts | 9 |
2 files changed, 18 insertions, 0 deletions
diff --git a/src/Common/ICodeParser.ts b/src/Common/ICodeParser.ts new file mode 100644 index 0000000..afe2967 --- /dev/null +++ b/src/Common/ICodeParser.ts @@ -0,0 +1,9 @@ +import { TextEditor } from "vscode"; +import { IDocGen } from "./IDocGen"; + +export default interface ICodeParser { + /** + * @param {TextEditor} activeEditor The open active Editor where the event came from + */ + Parse(activeEditor: TextEditor): IDocGen; +} 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); +} |