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
- Document the version when deprecated
- Explain what to use instead
- Set target removal version
- Use
@Deprecated(forRemoval = true) if planning to remove
Priority
Low
Problem
@Deprecatedmethods lack@deprecatedjavadoc or removal timeline, causing API cleanup confusion.Location
src/main/java/org/flossware/jcurses/api/JTable.javaCurrent Code
Impact
Low - Users don't know when deprecated methods will be removed
Recommended Fix
Add comprehensive deprecation documentation:
Best Practices
@Deprecated(forRemoval = true)if planning to removePriority
Low