Skip to content

Conversation

denscollo
Copy link
Contributor

@denscollo denscollo commented Sep 11, 2020

Address #4321

This PR needs to be merged after #4634, #4635, #4636

Description

This PR adds the missing XML documentation to all visible classes, methods, properties, and parameters in the Bot.Builder.Dialogs.Adaptive root folder, removing 46 errors.

Also, the NoWarn-CS1591 property is removed from the .csproj file, note that this change will make the build throw errors if the previous PRs with adding the library's documentation has not been merged.

The following PRs should be merged before this one:

  • Add missing XML documentation to Bot.Builder.Dialogs.Adaptive Functions, Generators, Input, Memory, Selectors and Templates folders.
  • Add missing XML documentation to Bot.Builder.Dialogs.Adaptive/Recognizers.
  • Add missing XML documentation to Bot.Builder.Dialogs.Adaptive/TriggerConditions.
  • Add missing XML documentation to Bot.Builder.Dialogs.Adaptive/Actions.

Specific Changes

Testing

Below you can see the number of errors shown before and after the changes when de NoWarn-CS1591 property is removed.
image

@denscollo denscollo requested a review from a team as a code owner September 11, 2020 19:48
@denscollo denscollo requested a review from Stevenic September 11, 2020 19:48
Copy link
Contributor

@tomlm tomlm left a comment

Choose a reason for hiding this comment

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

:shipit:

@mrivera-ms
Copy link
Contributor

@denscollo , please resolve the build errors. Need to add the missing comments, for public members probably added after you submitted this PR. Thank you.
image

@denscollo
Copy link
Contributor Author

Hi @mrivera-ms, we just solved the issues and added the missing comments. Thanks!

@mrivera-ms mrivera-ms merged commit f55bbc3 into microsoft:main Sep 22, 2020
@sw-joelmut sw-joelmut deleted the southworks/add/documentation/bot-builder-dialogs-adaptive/Root branch September 21, 2021 12:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants