Skip to content

Replace package.html with package-info.java#206

Merged
garydgregory merged 3 commits intoapache:masterfrom
SethFalco:package-info
Jul 25, 2021
Merged

Replace package.html with package-info.java#206
garydgregory merged 3 commits intoapache:masterfrom
SethFalco:package-info

Conversation

@SethFalco
Copy link
Copy Markdown
Contributor

@SethFalco SethFalco commented Jul 22, 2021

This converts the package.html (+ a readme.html) to package-info.java.

I noticed the package.html files but wasn't familiar with them. Learned they're basically old package-info.java files.
I was hoping to modernize that a bit, so it's more familiar, plus improves how docs are consumed in editors.

  • More familiar to new developers. (I never knew package.html was a thing.)
  • Preferred over package.html.

As JDK 5 arrived on the scene, package.html gave way to a new option, package-info.java, which is now preferred over package.html.
- https://www.baeldung.com/java-package-info

  • package-info.java can use tags like {@link}, rather than arbitrarily naming qualified class names.
/**
 * The Default File Provider, which wraps {@link java.net.URL}.
 */
package org.apache.commons.vfs2.provider.url;

Also fixes one typo in commons-vfs2-examples/src/main/java/org/apache/commons/vfs2/libcheck/package-info.java.

  • servicde -> service

If this is too much for one PR, feel free to close it!
I can split this up if preferred.

@garydgregory garydgregory changed the title chore: replace package.html with package-info.java Replace package.html with package-info.java Jul 25, 2021
@garydgregory garydgregory merged commit b60be40 into apache:master Jul 25, 2021
asfgit pushed a commit that referenced this pull request Jul 25, 2021
@SethFalco SethFalco deleted the package-info branch April 3, 2025 13:30
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