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

Javadoc needs a sweep #10

Open
badgerwithagun opened this issue Jun 10, 2017 · 2 comments
Open

Javadoc needs a sweep #10

badgerwithagun opened this issue Jun 10, 2017 · 2 comments

Comments

@badgerwithagun
Copy link
Member

Prior to 1.0.0, the Javadoc needs a thorough sweep for detail, accuracy and consistency.

@badgerwithagun badgerwithagun added this to the 1.0.0 milestone Jun 10, 2017
@badgerwithagun
Copy link
Member Author

Improved a little by #33 but that was purely about fixing errors. Still needs improving.

@venushka
Copy link
Member

Also the following warning should be fixed as well.

[WARNING] /home/travis/build/alfasoftware/morf/morf-nuodb/src/main/java/org/alfasoftware/morf/jdbc/nuodb/NuoDBHelper.java:22: warning: no @param for stringOfDouble
[WARNING] public static Double nuoDBConvertStringToDouble(String stringOfDouble) {
[WARNING] ^
[WARNING] /home/travis/build/alfasoftware/morf/morf-nuodb/src/main/java/org/alfasoftware/morf/jdbc/nuodb/NuoDBHelper.java:22: warning: no @return
[WARNING] public static Double nuoDBConvertStringToDouble(String stringOfDouble) {
[WARNING] ^
[WARNING] /home/travis/build/alfasoftware/morf/morf-nuodb/src/main/java/org/alfasoftware/morf/jdbc/nuodb/NuoDBHelper.java:33: warning: no @param for referenceToCast
[WARNING] public static Cast nuoDBCastToString(AliasedField referenceToCast, int length) {
[WARNING] ^
[WARNING] /home/travis/build/alfasoftware/morf/morf-nuodb/src/main/java/org/alfasoftware/morf/jdbc/nuodb/NuoDBHelper.java:33: warning: no @param for length
[WARNING] public static Cast nuoDBCastToString(AliasedField referenceToCast, int length) {
[WARNING] ^
[WARNING] /home/travis/build/alfasoftware/morf/morf-nuodb/src/main/java/org/alfasoftware/morf/jdbc/nuodb/NuoDBHelper.java:33: warning: no @return
[WARNING] public static Cast nuoDBCastToString(AliasedField referenceToCast, int length) {
[WARNING] ^
[WARNING] /home/travis/build/alfasoftware/morf/morf-nuodb/src/main/java/org/alfasoftware/morf/jdbc/nuodb/NuoDBHelper.java:43: warning: no @param for bigDecimal
[WARNING] public static String nuoDBConvertBigDecimalToPlainString(BigDecimal bigDecimal) {
[WARNING] ^
[WARNING] /home/travis/build/alfasoftware/morf/morf-nuodb/src/main/java/org/alfasoftware/morf/jdbc/nuodb/NuoDBHelper.java:43: warning: no @return
[WARNING] public static String nuoDBConvertBigDecimalToPlainString(BigDecimal bigDecimal) {
[WARNING] ^

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants