diff options
| author | Rowan Goemans <RB.Goemans@student.han.nl> | 2017-12-31 02:03:08 +0100 |
|---|---|---|
| committer | Christoph Schlosser <christophschlosser@users.noreply.github.com> | 2018-02-20 22:02:22 +0100 |
| commit | 1746f21bc3720585d2fe877db8d69aae301ff02c (patch) | |
| tree | 7f0d081fd8fc3e0b54c7bb478cb8724a4cf3b798 /src/Common | |
| parent | b446b9e596fc0487b88597d8e818dae61512f309 (diff) | |
| download | doxdocgen-1746f21bc3720585d2fe877db8d69aae301ff02c.tar.gz | |
-- Added many unit tests for the C parser. Almost complete now
-- Refactored project structure to allow for more overview once we add more languages.
-- Renamed a lot of types in the CParser to be more explicit.
-- Made configuration injectable into the classes that need them. This allows to unit test configuration variables.
-- Added 2 new config params that allows to customize what gets returned for a bool return type.
-- Small changes to the logic to make it more concise.
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); +} |