Skip to content

Standardize serialVersionUID Javadocs across codebase#3172

Closed
Copilot wants to merge 3 commits intomainfrom
copilot/align-javadocs-serialversionuids
Closed

Standardize serialVersionUID Javadocs across codebase#3172
Copilot wants to merge 3 commits intomainfrom
copilot/align-javadocs-serialversionuids

Conversation

Copy link
Contributor

Copilot AI commented Dec 20, 2025

Inconsistent Javadoc formats for serialVersionUID fields existed across the codebase, ranging from verbose HTML-linked descriptions to missing documentation entirely.

Changes

  • Standardized existing Javadocs (29 files): Updated from various formats including:

    • "The <a href="...">serial version uid</a>."
    • "Version ID for serialization."
    • "Serialization version identifier for this interface."
  • Added missing Javadocs (53 files): Documentation added to previously undocumented serialVersionUID fields

  • Scope: Main sources (vavr/src/main), generated sources (vavr/src-gen/main), and test utilities

Standard Format

/**
 * The serial version UID for serialization.
 */
private static final long serialVersionUID = 1L;

All 170+ serialVersionUID declarations now follow this format consistently.

Original prompt

Align Javadocs for all serialVersionUIDs to "The serial version UID for serialization."


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

Copilot AI and others added 2 commits December 20, 2025 09:27
Co-authored-by: pivovarit <2182533+pivovarit@users.noreply.github.com>
Co-authored-by: pivovarit <2182533+pivovarit@users.noreply.github.com>
@pivovarit
Copy link
Member

just the public ones

Copilot AI changed the title [WIP] Align Javadocs for all serialVersionUIDs Standardize serialVersionUID Javadocs across codebase Dec 20, 2025
Copilot AI requested a review from pivovarit December 20, 2025 09:36
@pivovarit
Copy link
Member

@copilot update just the existing ones, don't add new

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.

2 participants