guidebook and scripts update

virtdata-api/src/main/java/io/nosqlbench/virtdata/api/VirtDataFunctionLibrary.java

@@ -37,6 +37,7 @@ public interface VirtDataFunctionLibrary extends Named {
      * @param inputType      The class which the unary apply method should take as an
      *                       argument, or null if unspecified
      * @param functionName   The name of the implementation to match
+     * @param customConfigs  Optional initializer configuration
      * @param parameters A list of arguments which will be used to instantiate
      *                       any matching implementations
      * @return A list, possibly empty, of matching functions

virtdata-api/src/main/java/io/nosqlbench/virtdata/api/murmur/Murmur3F.java

@@ -132,6 +132,7 @@ public class Murmur3F implements Checksum128 {
     /**
      * Special update method to hash long values very efficiently using Java's native little endian (LE) byte order.
      * Note, that you cannot mix this with other (previous) hash updates, because it only supports 8-bytes alignment.
+     * @param value The long value to update
      */
     public void updateLongLE(long value) {
         finished = false;
@@ -156,6 +157,7 @@ public class Murmur3F implements Checksum128 {
 
     /**
      * Consider {@link #updateLongLE(long)} for better performance if you do not rely on big endian (BE) byte order.
+     * @param value value to update
      */
     public void updateLongBE(long value) {
         updateLongLE(Long.reverseBytes(value));

virtdata-api/src/main/java/io/nosqlbench/virtdata/api/templates/ParsedTemplate.java

@@ -111,7 +111,7 @@ public class ParsedTemplate {
      * Parse the given raw template, check the bind points against the provide bindings, and
      * provide detailed template checks for validity.
      *
-     * <H2>Overriding Patterns</H2>
+     * <H4>Overriding Patterns</H4>
      * <P>
      * If patterns are not provided then {@link ParsedTemplate#DEFAULT_PATTERNS} are used, which includes
      * the ability to match {var1} and ?var1 style anchors. If patterns are
@@ -342,7 +342,7 @@ public class ParsedTemplate {
     /**
      * Return the parsed template in (<em>literal, variable, ..., ..., literal</em>) form.
      *
-     * @return
+     * @return the sections of spans within the template
      */
     public String[] getSpans() {
         return spans;