Better Javadocs
An official Javadocs for the API would really be great. Some of the variables are quite difficult to get at first glance. A great example is the variable uuid in Entry--uuid of what? I know that Lombok was used for that variable and it's kind of difficult to generate Javadocs for code that is generated by the compiler. However, it's not impossible. ```java /** * Get some uuid of something. * @return uuid of something */ @Getter private String uuid; ``` And use delombok to generate Javadocs. Here's a sample in Gradle (Sadly don't know how to do it in maven, but there's Google... lol) ```groovy // Delombok Task task delombok(type: DelombokTask, dependsOn: compileJava) { ext.outputDir = file("$buildDir/delombok") outputs.dir(outputDir) sourceSets.main.java.srcDirs.each { inputs.dir(it) args(it, "-d", outputDir) } } // Javadoc Task javadoc { dependsOn delombok source = delombok.outputDir failOnError = false } ``` Maybe adding this plugin to your pom.xml will help: http://awhitford.github.io/lombok.maven/lombok-maven-plugin/usage.html Ultimately, you guys can ommit the usage of Lombok for the API, or some parts of it that needs an elaborate documentation. Cheers! And Goodluck to you all!
issue