oracle / oracle-r2dbc

R2DBC Driver for Oracle Database
https://oracle.com
Other
194 stars 40 forks source link

Repairing javadocs #77

Closed Michael-A-McMahon closed 2 years ago

Michael-A-McMahon commented 2 years ago

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.