Skip to content

Commit

Permalink
Merge pull request #2134 from dnutiu/master
Browse files Browse the repository at this point in the history
Improve readme 'Include Descriptions from XML Comments' section
  • Loading branch information
domaindrivendev authored Aug 30, 2021
2 parents 754d765 + 477a290 commit 9fc404d
Showing 1 changed file with 1 addition and 1 deletion.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -474,7 +474,7 @@ To enhance the generated docs with human-friendly descriptions, you can annotate

1. Open the Properties dialog for your project, click the "Build" tab and ensure that "XML documentation file" is checked, or add `<GenerateDocumentationFile>true</GenerateDocumentationFile>` element to the `<PropertyGroup>` section of your .csproj project file. This will produce a file containing all XML comments at build-time.

_At this point, any classes or methods that are NOT annotated with XML comments will trigger a build warning. To suppress this, enter the warning code "1591" into the "Suppress warnings" field in the properties dialog._
_At this point, any classes or methods that are NOT annotated with XML comments will trigger a build warning. To suppress this, enter the warning code "1591" into the "Suppress warnings" field in the properties dialog or add `<NoWarn>1591</NoWarn>` to the `<PropertyGroup>` section of your .csproj project file._

2. Configure Swashbuckle to incorporate the XML comments on file into the generated Swagger JSON:

Expand Down

0 comments on commit 9fc404d

Please sign in to comment.