Skip to content

Document deprecation rationale for executeChangeLogCommand in AbstractChangeLogCommand #1344

Description

@anukalp2804

New feature, improvement proposal

Summary:
The method executeChangeLogCommand in AbstractChangeLogCommand is marked as
deprecated but lacks Javadoc explaining why it is deprecated or how
implementations should migrate.

Current behavior:
The method is annotated with @deprecated but does not document the
deprecation rationale or any recommended alternative.

Expected behavior:
Deprecated APIs should document the reason for deprecation and indicate
whether a replacement exists or if the method is kept for backward
compatibility.

Scope:
Documentation-only changes in
maven-scm-api/src/main/java/org/apache/maven/scm/command/changelog/AbstractChangeLogCommand.java

Notes:
No functional behavior changes are expected.

I can work on this if it sounds reasonable.

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentation

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions