Skip to content

Add Removal Timeline to Deprecated Methods #24

Description

@sfloess

Problem

@Deprecated methods lack @deprecated javadoc or removal timeline, causing API cleanup confusion.

Location

  • File: src/main/java/org/flossware/jcurses/api/JTable.java
  • Lines: 342-359 (and potentially others)

Current Code

@Deprecated
public void oldMethod() {
    // ...
}

Impact

Low - Users don't know when deprecated methods will be removed

Recommended Fix

Add comprehensive deprecation documentation:

/**
 * Old method description.
 * 
 * @deprecated Since 1.18. Use {@link #newMethod()} instead.
 *             This method will be removed in version 2.0.
 */
@Deprecated(since = "1.18", forRemoval = true)
public void oldMethod() {
    // ...
}

Best Practices

  1. Document the version when deprecated
  2. Explain what to use instead
  3. Set target removal version
  4. Use @Deprecated(forRemoval = true) if planning to remove

Priority

Low

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationenhancementNew feature or request

    Type

    No type
    No fields configured for issues without a type.

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions