Add reference documentation to public API members#179
Merged
Conversation
Copilot
AI
changed the title
[WIP] Improve JavaScript distro documentation
Add reference documentation to public API members
Jun 19, 2026
Contributor
There was a problem hiding this comment.
Pull request overview
Improves the generated TypeDoc reference documentation by adding/expanding JSDoc descriptions across the public API surface (A365 + GenAI main-agent), without changing runtime behavior.
Changes:
- Added JSDoc for GenAI “main agent” processors and their exported constants.
- Added per-member JSDoc across A365 public contracts (enums, message parts, request/channel/identity details, guardrail types).
- Added/expanded JSDoc for the Agent365 exporter surface (options, constructor, lifecycle methods) and hosting-layer structural types.
Reviewed changes
Copilot reviewed 9 out of 9 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/genai/mainAgent/processor.ts | Adds method-level JSDoc for span/log processors and lifecycle no-ops. |
| src/genai/mainAgent/constants.ts | Adds JSDoc for exported main-agent attribute-key constants. |
| src/a365/hosting/types.ts | Adds field/type documentation for hosting structural interfaces and handler type. |
| src/a365/hosting/agenticTokenCache.ts | Adds JSDoc for the AuthorizationLike.exchangeToken contract. |
| src/a365/exporter/ExporterEventNames.ts | Adds enum member descriptions for exporter event names. |
| src/a365/exporter/Agent365ExporterOptions.ts | Adds @param/@returns docs for token resolver delegate types. |
| src/a365/exporter/Agent365Exporter.ts | Adds JSDoc for constructor, export, shutdown, and forceFlush. |
| src/a365/contracts.ts | Adds per-member documentation for public A365 contracts and constants. |
| src/a365/constants.ts | Adds JSDoc on the OpenTelemetryConstants public static members and improves class header doc. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
nikhilNava
approved these changes
Jun 22, 2026
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.
The generated reference docs at learn.microsoft.com have gaps where exported properties, enum members, class methods, and function parameters lack descriptions. This adds JSDoc descriptions across the public API surface so regenerated docs are complete. Documentation-only — no behavior changes.
Changes
OpenTelemetryConstants(a365/constants.ts): description on every static attribute-key/metric/env-var property (~120).contracts.ts: per-member docs for enums (InvocationRole,MessageRole,FinishReason,Modality,InferenceOperationType,GuardrailRiskSeverity,GuardrailTargetType) and properties onRequest(A365Request),Channel,AgentDetails,UserDetails,ServiceEndpoint, message-part interfaces,*Details/*Responsetypes,ParentSpanRef, andSpanDetails.Agent365Exporter: constructor,export,shutdown,forceFlush.TokenResolver/ContextualTokenResolver:@paramdescriptions.ActivityLike,TurnContextLike,AuthorizationLike,MiddlewareLike,HostingAdapterLike,SendActivitiesHandler),ExporterEventNames.Notes
completed-docs) to enforce coverage — repo uses ESLint, not TSLint, and that would exceed the issue's scope. Available as a follow-up if enforcement is desired.{@link}for external symbols (ExportResultCode.*) to avoid unresolved-link warnings in typedoc output.Example —
InvocationRolemembers now render with descriptions: