Merged
Conversation
Contributor
There was a problem hiding this comment.
Pull Request Overview
This PR improves the documentation comments across the agents hosting packages by standardizing the JSDoc format and structure. The changes focus on converting documentation to use more specific JSDoc tags and reorganizing content for better clarity and consistency.
- Standardized
@templatetags to@typeParamfor better type parameter documentation - Converted inline documentation to structured JSDoc format with
@summaryand@remarkstags - Reorganized documentation sections to improve readability and follow JSDoc conventions
Reviewed Changes
Copilot reviewed 29 out of 29 changed files in this pull request and generated 2 comments.
Show a summary per file
| File | Description |
|---|---|
| transcriptLogger.ts | Updated generic type parameter documentation from @template to @typeParam |
| fileStorage.ts | Converted class documentation to structured JSDoc format with summary and reorganized warning section |
| agentStatePropertyAccesor.ts | Restructured extensive class and method documentation with proper JSDoc tags and heading hierarchy |
| agentState.ts | Converted class documentation to structured JSDoc format |
| turnStateProperty.ts | Updated type parameter documentation tags |
| turnState.ts | Updated class and method documentation with proper JSDoc tags |
| extensions.ts | Updated type parameter documentation |
| appRoute.ts | Updated type parameter documentation |
| appMemory.ts | Updated type parameter documentation |
| agentApplicationOptions.ts | Updated type parameter documentation |
| agentApplicationBuilder.ts | Updated type parameter documentation |
| agentApplication.ts | Restructured class and method documentation with proper JSDoc format |
| adaptiveCardsActions.ts | Updated interface and method documentation with structured JSDoc format |
| cosmosDbPartitionedStorage.ts | Updated type parameter documentation |
| blobsTranscriptStore.ts | Restructured function documentation with proper JSDoc format and parameter organization |
| startServer.ts | Reorganized function documentation with structured JSDoc format |
| serviceCollection.ts | Updated type parameter documentation |
| recognizerResult.ts | Restructured function documentation with proper JSDoc format |
| prompt.ts | Reorganized function signature documentation |
| confirmPrompt.ts | Updated interface documentation |
| dialogStateManager.ts | Updated type parameter documentation |
| dialogTurnResult.ts | Updated type parameter documentation |
| dialogSet.ts | Updated interface and method documentation with structured JSDoc format |
| dialogInstance.ts | Updated type parameter documentation |
| modelResult.ts | Updated type parameter documentation |
| findValues.ts | Extensively restructured interface and function documentation with proper JSDoc format |
| copilotStudioWebChat.ts | Updated interface and function documentation with structured JSDoc format |
| AIEntity.ts | Updated interface and function documentation with structured JSDoc format |
rido-min
reviewed
Jul 19, 2025
rido-min
approved these changes
Jul 19, 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.
No description provided.