Add comment detection in providing doxygen command (#229)

4 files changed, 24 insertions, 7 deletions

diff --git a/README.md b/README.md
index f3c29e1..a87f85e 100644
--- a/README.md
+++ b/README.md
@@ -234,6 +234,12 @@ Each of them can be configured with its own custom text and you can decide if th
 
   // Substitute {email} with git config --get user.email.
   "doxdocgen.generic.useGitUserEmail": false
+
+  // Provide intellisense and snippet for doxygen commands
+  "doxdocgen.generic.commandSuggestion": true
+
+  // Add `\\` in doxygen command suggestion for better readbility (need to enable commandSuggestion)
+  "doxdocgen.generic.commandSuggestionAddPrefix": false
 ```
 
 ## Contributors
diff --git a/package.json b/package.json
index e24e723..d30bd48 100644
--- a/package.json
+++ b/package.json
@@ -240,6 +240,11 @@
           "description": "Provide intellisense and snippet for doxygen commands",
           "type": "boolean",
           "default": true
+        },
+        "doxdocgen.generic.commandSuggestionAddPrefix": {
+          "markdownDescription": "Add `\\` in doxygen command suggestion for better readbility (need to enable commandSuggestion)",
+          "type": "boolean",
+          "default": false
         }
       }
     }
diff --git a/src/DoxygenCompletionItemProvider.ts b/src/DoxygenCompletionItemProvider.ts
index b71b827..160158c 100644
--- a/src/DoxygenCompletionItemProvider.ts
+++ b/src/DoxygenCompletionItemProvider.ts
@@ -1,4 +1,5 @@
 import * as vscode from "vscode";
+import { inComment } from "./util";
 
 // tslint:disable:max-line-length
 
@@ -115,8 +116,10 @@ export default class DoxygenCompletionItemProvider implements vscode.CompletionI
     ];
     public static completionItems = (() => {
         const items: vscode.CompletionItem[] = [];
+        const addPrefix = vscode.workspace.getConfiguration("doxdocgen.generic").get<boolean>("commandSuggestionAddPrefix");
         for (const item of DoxygenCompletionItemProvider.commands) {
-            const newItem = new vscode.CompletionItem(item[0]);
+            // TODO: Only \ can be used, @ as label prefix causes unexpected filtering
+            const newItem = new vscode.CompletionItem(addPrefix ? `\\${item[0]}` : item[0]);
             newItem.documentation = new vscode.MarkdownString(item[2]);
             newItem.insertText = new vscode.SnippetString(`${item[0]} ${item[1]}`);
             newItem.kind = vscode.CompletionItemKind.Snippet;
@@ -128,10 +131,12 @@ export default class DoxygenCompletionItemProvider implements vscode.CompletionI
     public trigger: string = "";
     public indentSpace: number;
     public provideCompletionItems(document: vscode.TextDocument, position: vscode.Position, token: vscode.CancellationToken, context: vscode.CompletionContext) {
-        this.trigger = context.triggerCharacter;
-        this.indentSpace = position.character;
-        // TODO: check if current position is comment
-        return DoxygenCompletionItemProvider.completionItems;
+        if (inComment(vscode.window.activeTextEditor, position.line + 1)) {
+            this.trigger = context.triggerCharacter;
+            this.indentSpace = position.character;
+            return DoxygenCompletionItemProvider.completionItems;
+        }
+        return [];
     }
 
     public resolveCompletionItem(item: vscode.CompletionItem, token: vscode.CancellationToken) {
diff --git a/src/util.ts b/src/util.ts
index f2068e7..f6e429a 100644
--- a/src/util.ts
+++ b/src/util.ts
@@ -2,9 +2,10 @@ import * as env from "env-var";
 import * as vscode from "vscode";
 
 /**
- * Check if a specific line is inside a comment block
+ * Check if a specific line will be inside a comment block if comment block is inserted,
+ * that is a line before the active line
  * @param activeEditor the active editor
- * @param activeLine the line number to be checked
+ * @param activeLine the !previous! line to be checked
  */
 export function inComment(activeEditor: vscode.TextEditor, activeLine: number): boolean {
     if (activeLine === 0) {