Lambda Annotations can raise CS1591 warning

[chrischappell-rgare]

Describe the bug

A CS1591 warning is raised if a Lamba project using Lambda Annotations has documentation file generation enabled. The project will not build at all if it has TreatWarningsAsError enabled.

Expected Behavior

The generated code can use #pragma warning disable CS1591 to prevent the warning from being raised.

Current Behavior

Each public member has warning CS1591: Missing XML comment for publicly visible type or member 'Type_or_Member'.

Reproduction Steps

Add <GenerateDocumentationFile>true</GenerateDocumentationFile> to a project using Amazon.Lambda.Annotations.

Possible Solution

Enclose the generated code in #pragma warning disable CS1591.

Additional Information/Context

No response

AWS .NET SDK and/or Package version used

Amazon.Lambda.Annotations 1.3.0

Targeted .NET Platform

.Net 8

Operating System and version

AmazonLinux

[ashishdhingra]

Needs review with the team. Probably low hanging fruit.

[ashishdhingra]

Low hanging fruit P1. Possible related discussion #1733.

[ashishdhingra]

This should have been addressed via PR #1748 and available in Amazon.Lambda.Annotations v1.4.0 package.

[github-actions]

Comments on closed issues are hard for our team to see.
If you need more assistance, please either tag a team member or open a new issue that references this one.
If you wish to keep having a conversation with other community members under this issue feel free to do so.