Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR restructures comment documentation throughout the codebase to align with docFx and type2docfx formatting expectations by properly organizing @ tags and remarks sections.
- Moves descriptive content from initial comment text to
@remarkssections - Reorganizes parameter documentation (
@param) to appear before@remarkssections - Standardizes the placement and formatting of JSDoc tags across multiple packages
Reviewed Changes
Copilot reviewed 48 out of 49 changed files in this pull request and generated 11 comments.
Show a summary per file
| File | Description |
|---|---|
| packages/agents-hosting/src/turnContext.ts | Restructures JSDoc comments for TurnContext methods to move descriptions to @remarks |
| packages/agents-hosting/src/storage/ | Updates storage-related classes with proper @remarks formatting |
| packages/agents-hosting/src/state/ | Reorganizes state management documentation structure |
| packages/agents-hosting/src/app/ | Standardizes application framework documentation formatting |
| packages/agents-hosting/src/auth/authConfiguration.ts | Moves parameter documentation before @remarks sections |
| packages/agents-hosting-dialogs/src/ | Updates dialog framework documentation structure |
| packages/agents-hosting-storage-blob/src/ | Restructures blob storage documentation |
| packages/agents-hosting-express/src/ | Updates Express integration documentation |
| packages/agents-copilotstudio-client/src/ | Reorganizes Copilot Studio client documentation |
| packages/agents-activity/src/ | Updates activity framework documentation structure |
Comments suppressed due to low confidence (1)
rido-min
approved these changes
Jul 23, 2025
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Changes based on learning of how docFx and type2docfx expects '@' tags to be used in code comments.