Improving the Jakarta NoSQL JavaDoc - Githubissues

jakartaee / nosql

The specification in Jakarta EE to help Jakarta EE developers create enterprise-grade applications using Java® and NoSQL technologies.

https://projects.eclipse.org/projects/ee4j.nosql

Eclipse Public License 2.0

92 stars 28 forks source link

Improving the Jakarta NoSQL JavaDoc #167

Closed dearrudam closed 1 year ago

dearrudam commented 1 year ago

As I've mentioned at https://github.com/jakartaee/nosql/pull/166#issuecomment-1585689112, I've reviewed the API's JavaDoc.

Changes:

Enhance the @jakarta.nosql.Entity javadoc;
Enhance the @jakarta.nosql.Column javadoc;
Enhance the @jakarta.nosql.Id javadoc;
Enhance the jakarta.nosql.Template javadoc;
Enhance the jakarta.nosql.QueryMapper javadoc;
Enhance the jakarta.nosql.PreparedStatement javadoc;
Enhance the jakarta.nosql.column package javadoc;
Enhance the jakarta.nosql.column.ColumnTemplate javadoc;
Enhance the jakarta.nosql.keyvalue package javadoc;
Enhance the jakarta.nosql.keyvalue.KeyValueTemplate javadoc;
Enhance the jakarta.nosql.document package javadoc;
Enhance the jakarta.nosql.document.DocumentTemplate javadoc;

dearrudam commented 1 year ago

@otaviojava, please, could you review this PR!?

eclipse-nosql-bot commented 1 year ago

Can one of the admins verify this patch?