Generate package-info.java for generated packages#1695
Merged
edburns merged 1 commit intoJun 16, 2026
Conversation
Fixes #1694 ## java/scripts/codegen/java.ts - Added `generateGeneratedPackageInfo()` to emit `package-info.java` for the `com.github.copilot.generated` package. Includes Javadoc describing session event types, key classes (`SessionEvent`, `UnknownSessionEvent`), a usage example, and cross-references to related packages. - Added `generateRpcPackageInfo()` to emit `package-info.java` for the `com.github.copilot.generated.rpc` package. Includes Javadoc describing RPC parameter/result types, key classes (`RpcCaller`, `ServerRpc`, `SessionRpc`), and cross-references. - Updated `main()` to call both new functions after existing generation steps. The files are regenerated on each run since the output directory is cleaned first. ## java/src/generated/java/com/github/copilot/generated/package-info.java - New auto-generated file. Provides package-level Javadoc for the session event types package, following the same style as the hand-written `com.github.copilot` package-info. ## java/src/generated/java/com/github/copilot/generated/rpc/package-info.java - New auto-generated file. Provides package-level Javadoc for the RPC types package, following the same style as the hand-written `com.github.copilot` package-info.
Contributor
There was a problem hiding this comment.
Pull request overview
Adds auto-generated package-info.java files for the Java generated source packages so they have package-level Javadoc (matching the style of the hand-written com.github.copilot package documentation), improving IDE discoverability and generated API navigation.
Changes:
- Extend the Java code generator to emit
package-info.javaforcom.github.copilot.generatedandcom.github.copilot.generated.rpc. - Add generated package-level Javadoc for session event types (
generated) and RPC types/wrappers (generated.rpc).
Show a summary per file
| File | Description |
|---|---|
| java/scripts/codegen/java.ts | Adds generation steps to write package-level Javadoc (package-info.java) for the generated Java packages. |
| java/src/generated/java/com/github/copilot/generated/package-info.java | New generated package documentation for session event types and forward-compat behavior. |
| java/src/generated/java/com/github/copilot/generated/rpc/package-info.java | New generated package documentation for RPC params/results and typed RPC wrapper entry points. |
Copilot's findings
- Files reviewed: 1/3 changed files
- Comments generated: 0
Contributor
Cross-SDK Consistency Review ✅This PR modifies only Java-specific files:
No changes are needed in other SDK implementations. The PR correctly improves Java's documentation infrastructure using Java idioms without introducing any cross-language inconsistencies.
|
edburns
added a commit
that referenced
this pull request
Jun 16, 2026
Fixes #1694 ## java/scripts/codegen/java.ts - Added `generateGeneratedPackageInfo()` to emit `package-info.java` for the `com.github.copilot.generated` package. Includes Javadoc describing session event types, key classes (`SessionEvent`, `UnknownSessionEvent`), a usage example, and cross-references to related packages. - Added `generateRpcPackageInfo()` to emit `package-info.java` for the `com.github.copilot.generated.rpc` package. Includes Javadoc describing RPC parameter/result types, key classes (`RpcCaller`, `ServerRpc`, `SessionRpc`), and cross-references. - Updated `main()` to call both new functions after existing generation steps. The files are regenerated on each run since the output directory is cleaned first. ## java/src/generated/java/com/github/copilot/generated/package-info.java - New auto-generated file. Provides package-level Javadoc for the session event types package, following the same style as the hand-written `com.github.copilot` package-info. ## java/src/generated/java/com/github/copilot/generated/rpc/package-info.java - New auto-generated file. Provides package-level Javadoc for the RPC types package, following the same style as the hand-written `com.github.copilot` package-info.
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.
Fixes #1694
java/scripts/codegen/java.ts
generateGeneratedPackageInfo()to emitpackage-info.javafor thecom.github.copilot.generatedpackage. Includes Javadoc describing session event types, key classes (SessionEvent,UnknownSessionEvent), a usage example, and cross-references to related packages.generateRpcPackageInfo()to emitpackage-info.javafor thecom.github.copilot.generated.rpcpackage. Includes Javadoc describing RPC parameter/result types, key classes (RpcCaller,ServerRpc,SessionRpc), and cross-references.main()to call both new functions after existing generation steps. The files are regenerated on each run since the output directory is cleaned first.java/src/generated/java/com/github/copilot/generated/package-info.java
com.github.copilotpackage-info.java/src/generated/java/com/github/copilot/generated/rpc/package-info.java
com.github.copilotpackage-info.