From 0ebfa5bd12e529d8febe73c85d3bf48c4d4997e8 Mon Sep 17 00:00:00 2001 From: Rowan Goemans Date: Sat, 14 Oct 2017 22:29:02 +0200 Subject: -- Added extensive templating the be able to generated different types of doxygen comment. --- src/DocGen/DocGen.ts | 19 +++++-------------- 1 file changed, 5 insertions(+), 14 deletions(-) (limited to 'src/DocGen/DocGen.ts') diff --git a/src/DocGen/DocGen.ts b/src/DocGen/DocGen.ts index 9de9d41..40ea205 100644 --- a/src/DocGen/DocGen.ts +++ b/src/DocGen/DocGen.ts @@ -1,19 +1,10 @@ -/** - * Contains the supported doxygen commands - * - * @export - * @enum {number} - */ -export enum DoxygenCommands { - brief = "brief", - return = "return", - param = "param", - detailed = "(Detailed description)", -} +import { Range } from "vscode"; + export interface IDocGen { /** - * Generate documentation string and write it to the active editor + * @brief Generate documentation string and write it to the active editor + * @param {Range} rangeToReplace Range to replace with the generated comment. */ - GenerateDoc(); + GenerateDoc(rangeToReplace: Range); } -- cgit v1.2.3 From cc0d69edcd362c1abde9d0005c70d8e3692395bc Mon Sep 17 00:00:00 2001 From: Rowan Goemans Date: Sun, 15 Oct 2017 02:26:22 +0200 Subject: -- Fixed tslint issues. -- Added config parameter to add type information to return DoxyGen parameter. --- src/DocGen/DocGen.ts | 1 - 1 file changed, 1 deletion(-) (limited to 'src/DocGen/DocGen.ts') diff --git a/src/DocGen/DocGen.ts b/src/DocGen/DocGen.ts index 40ea205..1b5b1e1 100644 --- a/src/DocGen/DocGen.ts +++ b/src/DocGen/DocGen.ts @@ -1,6 +1,5 @@ import { Range } from "vscode"; - export interface IDocGen { /** * @brief Generate documentation string and write it to the active editor -- cgit v1.2.3