Skip to content
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

Jump to bottom

[CS1658,CS1584] Wrong XML comments #372

Open
viceice opened this issue Nov 11, 2021 · 4 comments
Open

[CS1658,CS1584] Wrong XML comments #372

viceice opened this issue Nov 11, 2021 · 4 comments

Comments

@viceice
Copy link

viceice commented Nov 11, 2021

Hi, I'm seeing wrongly generated XML comments:

generated:

/// <summary>
/// Exit a parse tree produced by <see cref="EvalScriptParser.break"/>.
/// </summary>
/// <param name="context">The parse tree.</param>
void ExitBreak([NotNull] EvalScriptParser.BreakContext context);

expected:

/// <summary>
/// Exit a parse tree produced by <see cref="EvalScriptParser.@break"/>.
/// </summary>
/// <param name="context">The parse tree.</param>
void ExitBreak([NotNull] EvalScriptParser.BreakContext context);

So the special words need to be escaped by @
@viceice
Copy link
Author

viceice commented Nov 11, 2021 •
edited
Loading

antlr4cs/tool/resources/org/antlr/v4/tool/templates/codegen/CSharp/CSharp.stg

Line 56 in bc7fb74

/// labeled alternative in \<see cref="<file.parserName>.<file.listenerLabelRuleNames.(lname)>"/>.

It seems lname must be passed to csIdentifier helper function?

like here:

antlr4cs/tool/resources/org/antlr/v4/tool/templates/codegen/CSharp/CSharp.stg

Line 37 in bc7fb74

/// \<see cref="<csIdentifier.(file.parserName)>"/>.

@viceice
Copy link
Author

viceice commented Nov 11, 2021

Those warnings can't easily suppressed 😕

@lextm
Copy link

lextm commented Sep 9, 2023

Since this is an upstream issue, you should report to https://github.com/antlr/antlr4/issues

Read #381 and see why you might migrate away to newer NuGet packages.

@viceice
Copy link
Author

viceice commented Sep 10, 2023

I already migrated. 😉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@lextm @viceice