fixed javadoc

gradle.properties

@@ -2,6 +2,9 @@ org.gradle.daemon=true
 org.gradle.configureondemand=true
 ide.recursive=true
 org.gradle.parallel=false
+#release=true
+signing.gnupg.executable=gpg
+signing.gnupg.useLegacyGpg=true
 
 VERSION_NAME=2.0.0
 GROUP=net.soundvibe.paldb

paldb/build.gradle

@@ -68,6 +68,7 @@ jacocoTestReport {
 if (project.hasProperty('release')) {
 
   signing {
+    useGpgCmd()
     sign configurations.archives
   }
 

paldb/overview.html

@@ -2,7 +2,7 @@
 <p>
 PalDB is an embeddable persistent write-once key-value store.
 </p>
-<h2>Code samples</h2>
+<h1>Code samples</h1>
 
 How to write a store:
 <pre>
@@ -23,20 +23,17 @@ <h2>Code samples</h2>
 How to iterate on a store:
 <pre>
 StoreReader reader = PalDB.createReader(new File("store.paldb"));
-Iterable<Map.Entry<String, String>> iterable = reader.iterable();
-for (Map.Entry<String, String> entry : iterable) {
+Iterable&lt;Map.Entry&lt;String, String&gt;&gt; iterable = reader.iterable();
+for (Map.Entry&lt;String, String&gt; entry : iterable) {
   String key = entry.getKey();
   String value = entry.getValue();
 }
 reader.close();
 </pre>
 
-<hr/>
 <h2>API Changes</h2>
-<p>
 <ul>
   <li>(April 2015) Initial API</li>
 </ul>
-</p>
 </body>
 

paldb/src/main/java/com/linkedin/paldb/api/Configuration.java

@@ -382,6 +382,7 @@ public <T> Class<T> getClass(String key)
    * The class for with the serializer is being registered is directly extracted from the class definition.
    *
    * @param serializer serializer to register
+   * @param <T> serializer type
    */
   public <T> void registerSerializer(Serializer<T> serializer) {
     serializers.registerSerializer(serializer);

paldb/src/main/java/com/linkedin/paldb/api/PalDB.java

@@ -34,6 +34,8 @@ public interface PalDB {
    * The file must exists.
    *
    * @param file a PalDB store file
+   * @param <K> key type
+   * @param <V> value type
    * @return a store reader
    */
   static <K,V> StoreReader<K,V> createReader(File file) {
@@ -47,6 +49,8 @@ static <K,V> StoreReader<K,V> createReader(File file) {
    *
    * @param file a PalDB store file
    * @param config configuration
+   * @param <K> key type
+   * @param <V> value type
    * @return a store reader
    */
   static <K,V> StoreReader<K,V> createReader(File file, Configuration config) {
@@ -61,6 +65,8 @@ static <K,V> StoreReader<K,V> createReader(File file, Configuration config) {
    *
    * @param stream an input stream on a PalDB store file
    * @param config configuration
+   * @param <K> key type
+   * @param <V> value type
    * @return a store reader
    */
   static <K,V> StoreReader<K,V> createReader(InputStream stream, Configuration config) {
@@ -73,6 +79,8 @@ static <K,V> StoreReader<K,V> createReader(InputStream stream, Configuration con
    * The parent folder is created if missing.
    *
    * @param file location of the output file
+   * @param <K> key type
+   * @param <V> value type
    * @return a store writer
    */
   static <K,V> StoreWriter<K,V> createWriter(File file) {
@@ -86,6 +94,8 @@ static <K,V> StoreWriter<K,V> createWriter(File file) {
    *
    * @param file location of the output file
    * @param config configuration
+   * @param <K> key type
+   * @param <V> value type
    * @return a store writer
    */
   static <K,V> StoreWriter<K,V> createWriter(File file, Configuration config) {
@@ -100,6 +110,8 @@ static <K,V> StoreWriter<K,V> createWriter(File file, Configuration config) {
    *
    * @param stream output stream
    * @param config configuration
+   * @param <K> key type
+   * @param <V> value type
    * @return a store writer
    */
   static <K,V> StoreWriter<K,V> createWriter(OutputStream stream, Configuration config) {

paldb/src/main/java/com/linkedin/paldb/impl/Serializers.java

@@ -40,6 +40,7 @@ public Serializers() {
    * Registers the serializer.
    *
    * @param serializer serializer
+   * @param <T> serialized class type
    */
   public synchronized <T> void registerSerializer(Serializer<T> serializer) {
     var className = serializer.serializedClass().getName();

paldb/src/main/java/com/linkedin/paldb/impl/StorageSerialization.java

@@ -52,6 +52,7 @@ public StorageSerialization(Configuration config) {
    * Serializes the key object and returns it as a byte array.
    *
    * @param key key to serialize
+   * @param <K> key type
    * @return key as byte array
    * @throws IOException if an io error occurs
    */