Merge pull request #62 from karczex/documentation

Documentation

README.md

@@ -81,7 +81,8 @@ PMEM_IS_PMEM_FORCE=1 java -ea -Xms1G -cp .:`find ../src/main/target -name *.jar`
 
 ## Documentation
 
-After installation, docs can be generated using ... by executing commands:
+Docs can be generated using mvn by executing commands:
+
 ```sh
-...
+mvn javadoc:javadoc
 ```

src/main/java/io/pmem/pmemkv/BuilderException.java

@@ -4,6 +4,10 @@
 package io.pmem.pmemkv;
 
 @SuppressWarnings("serial")
+
+/**
+ * Pmemkv database configuration failed
+ */
 public class BuilderException extends DatabaseException {
 
 	public BuilderException(String message) {

src/main/java/io/pmem/pmemkv/ByteBufferConverter.java

@@ -5,6 +5,9 @@
 
 import java.nio.ByteBuffer;
 
+/**
+ * Impementation of Converter interface for ByteBuffer type
+ */
 public class ByteBufferConverter implements Converter<ByteBuffer> {
 	public ByteBuffer toByteBuffer(ByteBuffer entry) {
 		return entry;

src/main/java/io/pmem/pmemkv/Converter.java

@@ -5,8 +5,32 @@
 
 import java.nio.ByteBuffer;
 
+/**
+ * Helper interface, which provides functionality of storing objects of any type
+ * as ByteBuffer inside pmemkv datastore
+ *
+ * @param <T>
+ *            the type of an object, which will be converted to ByteBuffer and
+ *            stored in pmemkv
+ */
 public interface Converter<T> {
+	/**
+	 * Defines how object of type T will be converted to ByteBuffer and stored in
+	 * pmemkv
+	 *
+	 * @param entry
+	 *            Object of type T, which will be stored in pmemkv
+	 * @return ByteBuffer representation of passed objects
+	 */
 	public ByteBuffer toByteBuffer(T entry);
 
+	/**
+	 * Defines how object stored in pmemkv will be converted from ByteBuffer back to
+	 * type T to be passed to the callback functions
+	 *
+	 * @param entry
+	 *            ByteBuffer stored in pmemkv
+	 * @return Object of type T, which will be passed to the callback functions
+	 */
 	public T fromByteBuffer(ByteBuffer entry);
 }