Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

JDK-8256208: Javadoc's generated overview does not show classes of unnamed package #5911

Closed
wants to merge 2 commits into from
Closed

JDK-8256208: Javadoc's generated overview does not show classes of unnamed package #5911

wants to merge 2 commits into from

Conversation

hns
Copy link
Member

@hns hns commented Oct 12, 2021 •
edited by openjdk bot

This is a simple fix to include the unnamed package when javadoc generates documentation for both unnamed and named packages. As elsewhere in javadoc, the package is listed as "Unnamed Package" (subject to localization).

Also, when documenting only code in the unnamed package, the index.html page redirects to the overview page of the unnamed package instead of the first documented class, which is generally more adequate for an overview page.

Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

  • JDK-8256208: Javadoc's generated overview does not show classes of unnamed package

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/5911/head:pull/5911
$ git checkout pull/5911

Update a local copy of the PR:
$ git checkout pull/5911
$ git pull https://git.openjdk.java.net/jdk pull/5911/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 5911

View PR using the GUI difftool:
$ git pr show -t 5911

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/5911.diff

@bridgekeeper
Copy link

bridgekeeper bot commented Oct 12, 2021

👋 Welcome back hannesw! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk openjdk bot added the rfr Pull request is ready for review label Oct 12, 2021
@openjdk
Copy link

openjdk bot commented Oct 12, 2021

@hns The following label will be automatically applied to this pull request:

  • javadoc

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added the javadoc javadoc-dev@openjdk.org label Oct 12, 2021
@mlbridge
Copy link

mlbridge bot commented Oct 12, 2021 •
edited

Webrevs

jonathan-gibbons
jonathan-gibbons approved these changes Nov 8, 2021
View reviewed changes
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One new file needs a final newline.

test/langtools/jdk/javadoc/doclet/testUnnamedPackage/src1/pkg/D.java Outdated
/**
* This is class D in the package pkg.
*/
public class D {}
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add newline

test/langtools/jdk/javadoc/doclet/testUnnamedPackage/src1/pkg/package.html
Comment on lines +1 to +5
<html>
<body>
This is a package comment for package pkg.
</body>
</html>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Old-style? How quaint!

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One adapts to the environment... Also, not much missing for valid html5 except <!doctype html>

@openjdk
Copy link

openjdk bot commented Nov 8, 2021 •
edited

@hns This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8256208: Javadoc's generated overview does not show classes of unnamed package

Reviewed-by: jjg

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 369 new commits pushed to the master branch:

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Nov 8, 2021
@hns
Copy link
Member Author

hns commented Nov 9, 2021

/integrate

@openjdk
Copy link

openjdk bot commented Nov 9, 2021

Going to push as commit e35abe3.
Since your change was applied there have been 370 commits pushed to the master branch:

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot closed this Nov 9, 2021
@openjdk openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Nov 9, 2021
@openjdk
Copy link

openjdk bot commented Nov 9, 2021

@hns Pushed as commit e35abe3.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

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

@jonathan-gibbons jonathan-gibbons jonathan-gibbons approved these changes

Assignees
No one assigned
Labels
integrated Pull request has been integrated javadoc javadoc-dev@openjdk.org
Milestone
No milestone
2 participants
@hns @jonathan-gibbons