summaryrefslogtreecommitdiffstats
path: root/src
diff options
context:
space:
mode:
authorChristoph Schlosser <christoph@linux.com>2020-06-26 15:02:38 +0200
committerChristoph Schlosser <christophschlosser@users.noreply.github.com>2020-06-26 15:09:49 +0200
commit3e68f18e2e10d90bd094707141c943146482f68b (patch)
tree28e78a5ca625812e3241cb1917c3f34473fc3061 /src
parent42a085fbda8e742595cf5b543ac4f8202c03fb7d (diff)
downloaddoxdocgen-3e68f18e2e10d90bd094707141c943146482f68b.tar.gz
Add option to filter keywords
Diffstat (limited to 'src')
-rw-r--r--src/Config.ts2
-rw-r--r--src/Lang/Cpp/CppParser.ts2
-rw-r--r--src/test/CppTests/Config.test.ts8
3 files changed, 12 insertions, 0 deletions
diff --git a/src/Config.ts b/src/Config.ts
index b33aff2..1d942a1 100644
--- a/src/Config.ts
+++ b/src/Config.ts
@@ -57,6 +57,7 @@ class Generic {
public generateSmartText: boolean = true;
public splitCasingSmartText: boolean = true;
public order: string[] = ["brief", "empty", "tparam", "param", "return"];
+ public filteredKeywords: string[] = [];
}
export class Config {
@@ -95,6 +96,7 @@ export class Config {
values.Generic.generateSmartText = Generic.getConfiguration().get<boolean>("generateSmartText", values.Generic.generateSmartText);
values.Generic.splitCasingSmartText = Generic.getConfiguration().get<boolean>("splitCasingSmartText", values.Generic.splitCasingSmartText);
values.Generic.order = Generic.getConfiguration().get<string[]>("order", values.Generic.order);
+ values.Generic.filteredKeywords = Generic.getConfiguration().get<string[]>("filteredKeywords", values.Generic.filteredKeywords);
return values;
}
diff --git a/src/Lang/Cpp/CppParser.ts b/src/Lang/Cpp/CppParser.ts
index d59ec9b..708af68 100644
--- a/src/Lang/Cpp/CppParser.ts
+++ b/src/Lang/Cpp/CppParser.ts
@@ -145,6 +145,8 @@ export default class CppParser implements ICodeParser {
// Non type keywords will be stripped from the final return type.
this.keywords = this.typeKeywords.concat(this.stripKeywords);
+ // Remove keywords that should be filtered
+ this.keywords = this.keywords.concat(this.cfg.Generic.filteredKeywords);
this.lexerVocabulary = {
ArraySubscript: (x: string): string => (x.match("^\\[[^\\[]*?\\]") || [])[0],
diff --git a/src/test/CppTests/Config.test.ts b/src/test/CppTests/Config.test.ts
index bfccf89..1769414 100644
--- a/src/test/CppTests/Config.test.ts
+++ b/src/test/CppTests/Config.test.ts
@@ -211,4 +211,12 @@ suite("C++ - Configuration Tests", () => {
// tslint:enable:no-trailing-whitespace
});
+ test("Macro define in funtion", () => {
+ testSetup.cfg = new Config();
+ testSetup.cfg.Generic.filteredKeywords = ["MOCKABLE"];
+ // tslint:disable-next-line:max-line-length
+ const result = testSetup.SetLine("MOCKABLE void processNetworkStatusReset( const common_n::NetworkCommands_s *networkstatus );").GetResult();
+ assert.equal("/**\n * @brief \n * \n * @param networkstatus \n */", result);
+ });
+
});