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

Generator does not suppress or propagate doc comments #82

Closed
kylemc opened this issue Sep 4, 2015 · 2 comments
Closed

Generator does not suppress or propagate doc comments #82

kylemc opened this issue Sep 4, 2015 · 2 comments
Labels
enhancement

Comments

@kylemc
Copy link

kylemc commented Sep 4, 2015

When I use IDL codegen in a project that's building XML docs, I get the following error.

My_types.cs(201,16,201,26): error CS1591: Warning as Error: Missing XML comment for publicly visible type or member 'My()'

I'd prefer one of the following options

  1. Comments in the IDL get propagated to the generated output
  2. "#pragma warning disable 1591" gets added to the generated files

I'd prefer not to resort to the "project-global" suppression. If there's another option I don't know about, I'm happy to use that instead.
@chwarr chwarr mentioned this issue Jan 20, 2016
Closed
@chwarr
Copy link
Member

chwarr commented Jan 20, 2016

I have a working fix that adds the #pragma, but we're having some problems with the CI builds due to Haskell packages that are blocking me from pushing. @sapek is helping to fix the CI breaks.

@chwarr chwarr closed this as completed in 90105ea Jan 20, 2016
robrodi pushed a commit to robrodi/bond that referenced this issue Jan 20, 2016
@chwarr
Suppress C# warning CS1591 in generated code
c97d659 
CS1591 is "Missing XML comment for publicly visible type or member".

Emit a 'pragma warning disable' line in generated C# code so that
projects that build will all warnings enabled don't have to add XML
documentation comments to their Bond-generated files.

Update the codegen golden master test files.

Add the test/codegen/no-warnings target that has all warnings enabled
and warnings as errors so that a new warning will fail to build.

Closes microsoft#82.
@chwarr chwarr mentioned this issue Jun 2, 2016
Closed
@chwarr
Copy link
Member

chwarr commented Jun 2, 2016

Opened #170 for the overall feature request.

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

No branches or pull requests
2 participants
@kylemc @chwarr