Skip to content

Location parent Javadoc#14

Closed
sbesson wants to merge 3 commits intoome:masterfrom
sbesson:javadoc_location
Closed

Location parent Javadoc#14
sbesson wants to merge 3 commits intoome:masterfrom
sbesson:javadoc_location

Conversation

@sbesson
Copy link
Copy Markdown
Member

@sbesson sbesson commented Aug 10, 2017

Following #12, reviews the Javadoc of the modified methods to improve the link with the upstream java.io.File.

  • uses Java 8 rather than Java 7 for external linking so that the Javadoc links go to the anchor
  • document the contracts of Javadoc for getParent and getParentFile by copying the Javadoc of java.io.File as the description still applies generically to Location methods

To test this PR, run mvn javadoc:javadoc and check the description of the two methods above are correct and the see also blocks appear and link to the correct place (can be compared with the current Javadoc at http://javadoc.io/doc/org.openmicroscopy/ome-common/5.3.2).

@sbesson sbesson requested a review from dgault August 10, 2017 11:35
@sbesson sbesson modified the milestones: 5.4.0, 5.3.3 Sep 21, 2017
@sbesson
Copy link
Copy Markdown
Member Author

sbesson commented Sep 25, 2017

Closing as per #17. This can be combined together with the Location fix when reopened.

@sbesson sbesson closed this Sep 25, 2017
@sbesson sbesson mentioned this pull request Jan 14, 2019
@sbesson sbesson deleted the javadoc_location branch February 6, 2019 14:49
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