Skip to content

Allow substitution of "{date}" in @author tag. #307

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
wants to merge 2 commits into
base: master
Choose a base branch
from
Draft

Allow substitution of "{date}" in @author tag. #307

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
618fabc
Allow "{date}" substitution in @author tag.
helixquar Dec 22, 2022
5d9849c
Update comment to new behavior
helixquar Dec 22, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 6 additions & 1 deletion src/Lang/Cpp/CppDocGen.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -222,15 +222,20 @@ export class CppDocGen implements IDocGen {
}

protected generateAuthorTag(lines: string[]) {
let dateFormat: string = "YYYY-MM-DD"; // Default to ISO standard if not defined
if ( this.cfg.Generic.dateFormat.trim().length !== 0) {
dateFormat = this.cfg.Generic.dateFormat; // Overwrite with user format
Copy link

@AJIOB AJIOB Jun 6, 2023

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
dateFormat = this.cfg.Generic.dateFormat; // Overwrite with user format
dateFormat = this.cfg.Generic.dateFormat.trim(); // Overwrite with user format

}
if (this.cfg.Generic.authorTag.trim().length !== 0) {
const authorInfo = this.getAuthorInfo();
// Allow substitution of {author} and {email} only
// Allow substitution of {author}, {email}, and {date} only
lines.push(
...templates.getMultiTemplatedString(
this.cfg.Generic.authorTag,
[
{ toReplace: this.cfg.authorTemplateReplace, with: authorInfo.authorName },
{ toReplace: this.cfg.emailTemplateReplace, with: authorInfo.authorEmail },
{ toReplace: this.cfg.dateTemplateReplace, with: moment().format(dateFormat) },
],
).split("\n"),
);
Expand Down