Skip to content

Repairing javadocs #77

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

Merged
merged 1 commit into from
Jun 27, 2022
Merged

Repairing javadocs #77

merged 1 commit into from
Jun 27, 2022

Conversation

Michael-A-McMahon
Copy link
Member

This branch repairs the JavaDoc of Oracle R2DBC in preparation for the 1.0.0 release.

The pom.xml updates jar artifacts to have the 1.0.0 version number. It also specifies a sourcepath attribute for generating the JavaDoc jar. Maven's JavaDoc plugin won't generate javadocs for package private classes without the sourcepath attribute. I could not find any documentation which explains why.

All JavaDoc errors are now fixed; Things like missing param and return tags, or invalid HTML.

A package-info.java file is added for the oracle.r2dbc package. The package info documents the package as intended for consumption by external code.

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