diff options
| author | Dean Anderson <dean@locomation.ai> | 2018-09-28 16:04:52 -0400 |
|---|---|---|
| committer | Christoph Schlosser <christophschlosser@users.noreply.github.com> | 2018-09-29 19:08:20 +0200 |
| commit | b52d8dd0e95d1f67ebb91007de05724955e555e5 (patch) | |
| tree | 4c6fe8b74faa63d12932d0420bf9142ae5860604 | |
| parent | 4df2f7179c12d3a674866bf05e4bd185ac3e2d87 (diff) | |
| download | doxdocgen-b52d8dd0e95d1f67ebb91007de05724955e555e5.tar.gz | |
Added additional documentation to package.json
Cleaned up FIXME comments in CppDocGen.ts
| -rw-r--r-- | package.json | 6 | ||||
| -rw-r--r-- | src/Lang/Cpp/CppDocGen.ts | 2 |
2 files changed, 3 insertions, 5 deletions
diff --git a/package.json b/package.json index 1aed081..fdb883d 100644 --- a/package.json +++ b/package.json @@ -92,7 +92,7 @@ "default": "@file {name}" }, "doxdocgen.file.copyrightTag": { - "description": "File copyright documentation tag.", + "description": "File copyright documentation tag. Array of strings will be converted to one line per element. Can template {year}.", "type": ["array", "string"], "default": ["@copyright Copyright (c) {year}"] }, @@ -102,7 +102,7 @@ "default": "@version 0.1" }, "doxdocgen.file.customTag": { - "description": "Additional file documentation.", + "description": "Additional file documentation. Array of strings will be converted to one line per element. Can template {year}, {date}, {author}, and {email}.", "type": ["array", "string"], "default": [] }, @@ -152,7 +152,7 @@ "default": "you@domain.com" }, "doxdocgen.generic.authorTag": { - "description": "Set the style of the author tag and your name.", + "description": "Set the style of the author tag and your name. Can template {author} and {email}.", "type": "string", "default": "@author {author} ({email})" }, diff --git a/src/Lang/Cpp/CppDocGen.ts b/src/Lang/Cpp/CppDocGen.ts index c88dd7d..75b67af 100644 --- a/src/Lang/Cpp/CppDocGen.ts +++ b/src/Lang/Cpp/CppDocGen.ts @@ -106,13 +106,11 @@ export class CppDocGen implements IDocGen { } protected getMultiTemplatedString(replace: string[], template: string, param: string[]): string { - // FIXME I find this argument order a bit strange. I would probably have template first // For each replace entry, attempt to replace it with the corresponding param in the template for (let i = 0; i < replace.length; i++) { if (i < param.length) { template = template.replace(replace[i], param[i]); } - // TODO: warn if mismatch string lengths? Probably should use tuple of tuples } return template; } |