Skip to content

Conversation

gnodet
Copy link
Member

@gnodet gnodet commented May 4, 2025

This PR improves the Javadoc documentation in the console module:

  • Add comprehensive class and method documentation
  • Add package-level documentation for org.jline.console and org.jline.widget packages
  • Remove @author tags
  • Update copyright years to 2025
  • Add cross-references between related methods using @link tags
  • Improve formatting with HTML tags like <p>, <ul>, and <li>
  • Add detailed documentation for inner classes and enums

These improvements make the JLine console package more accessible to developers, making it easier to understand and use the various components of the package.

- Add comprehensive class and method documentation
- Add package-level documentation
- Remove @author tags
- Update copyright years to 2025
- Add cross-references between related methods
- Improve formatting with HTML tags
@gnodet gnodet merged commit 9e22ecb into master May 4, 2025
9 checks passed
@gnodet gnodet deleted the docs/improve-console-javadoc branch May 9, 2025 18:53
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.

1 participant