Skip to content

Improved documentation comments#472

Merged
JimDaly merged 24 commits intomainfrom
u/jdaly/improve-descriptions
Jul 21, 2025
Merged

Improved documentation comments#472
JimDaly merged 24 commits intomainfrom
u/jdaly/improve-descriptions

Conversation

@JimDaly
Copy link
Copy Markdown
Member

@JimDaly JimDaly commented Jul 18, 2025

No description provided.

@JimDaly JimDaly requested review from Copilot and rido-min July 18, 2025 23:38
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

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 @template tags to @typeParam for better type parameter documentation
  • Converted inline documentation to structured JSDoc format with @summary and @remarks tags
  • 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

Comment thread packages/agents-activity/src/entity/AIEntity.ts
Comment thread packages/agents-activity/src/entity/AIEntity.ts
@JimDaly JimDaly enabled auto-merge (squash) July 18, 2025 23:43
Comment thread packages/agents-hosting/src/storage/fileStorage.ts
@JimDaly JimDaly merged commit 82818fe into main Jul 21, 2025
7 checks passed
@JimDaly JimDaly deleted the u/jdaly/improve-descriptions branch July 21, 2025 15:55
@JimDaly JimDaly self-assigned this Aug 11, 2025
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.

3 participants