added javadoc to function

Author: Sabrina Lawrey

src/main/java/net/openhft/chronicle/testframework/exception/package-info.java

@@ -0,0 +1,9 @@
+/**
+ * Provides classes and interfaces for tracking and asserting exceptions during testing.
+ * This package includes utility interfaces and implementations that enable users to define
+ * expected and ignored exceptions within testing scenarios, thereby facilitating the systematic
+ * verification of correct exception handling behavior.
+ *
+ * @see net.openhft.chronicle.testframework.exception.ExceptionTracker
+ */
+package net.openhft.chronicle.testframework.exception;

src/main/java/net/openhft/chronicle/testframework/function/package-info.java

@@ -0,0 +1,17 @@
+/**
+ * This package provides a set of functional interfaces and related utility classes to enhance
+ * and extend the standard Java functional programming model.
+ *
+ * <p>The main components include:
+ * <ul>
+ *     <li>{@link net.openhft.chronicle.testframework.function.TriConsumer} - A three-arity specialization of {@link java.util.function.Consumer}.</li>
+ *     <li>{@link net.openhft.chronicle.testframework.function.ThrowingConsumer} - A version of {@link java.util.function.Consumer} that allows checked exceptions.</li>
+ *     <li>{@link net.openhft.chronicle.testframework.function.ThrowingConsumerException} - An exception used to wrap checked exceptions in {@code ThrowingConsumer}.</li>
+ *     <li>{@link net.openhft.chronicle.testframework.function.NamedConsumer} - An interface extending {@link java.util.function.Consumer} that has a name.</li>
+ * </ul>
+ *
+ * <p>This package aims to provide more flexible and expressive ways to perform operations
+ * on data, especially in scenarios where more complex error handling or multi-argument
+ * processing is needed.
+ */
+package net.openhft.chronicle.testframework.function;

src/main/java/net/openhft/chronicle/testframework/mappedfiles/package-info.java

@@ -0,0 +1,12 @@
+/**
+ * Provides utility classes for working with mapped files, specifically targeting
+ * Linux systems where the "/proc/self/maps" file provides information about
+ * virtual memory mappings.
+ * <p>
+ * This package contains utilities to parse the "/proc/self/maps" file, allowing
+ * interaction with mapped files at a low level.
+ * <p>
+ * NOTE: The functionality provided in this package is likely to work only on
+ * Linux or Linux-like environments where the "/proc/self/maps" file is available.
+ */
+package net.openhft.chronicle.testframework.mappedfiles;

src/main/java/net/openhft/chronicle/testframework/package-info.java

@@ -1,4 +1,23 @@
 /**
- * This package contains the public API for the chronicle-test-framework library.
+ * The {@code net.openhft.chronicle.testframework} package provides a collection of utility classes and enums
+ * for various common programming tasks, such as handling closeable resources, generating combinations and permutations,
+ * building delegator instances, managing executor services, handling flaky tests, interacting with garbage collection,
+ * providing network-related functionalities, generating series of numbers, and thread-related functionalities.
+ * <p>
+ * This package includes:
+ * <ul>
+ *     <li>{@link net.openhft.chronicle.testframework.CloseableUtil} for handling closeable resources.</li>
+ *     <li>{@link net.openhft.chronicle.testframework.Combination} for generating all possible combinations of elements.</li>
+ *     <li>{@link net.openhft.chronicle.testframework.Delegation} for building delegator instances.</li>
+ *     <li>{@link net.openhft.chronicle.testframework.ExecutorServiceUtil} for managing executor services.</li>
+ *     <li>{@link net.openhft.chronicle.testframework.FlakyTestRunner} for handling flaky tests.</li>
+ *     <li>{@link net.openhft.chronicle.testframework.GcControls} for interacting with garbage collection.</li>
+ *     <li>{@link net.openhft.chronicle.testframework.NetworkUtil} for providing network-related functionalities.</li>
+ *     <li>{@link net.openhft.chronicle.testframework.Permutation} for general permutation support.</li>
+ *     <li>{@link net.openhft.chronicle.testframework.Product} for representing a product of elements.</li>
+ *     <li>{@link net.openhft.chronicle.testframework.Series} for generating series of numbers.</li>
+ *     <li>{@link net.openhft.chronicle.testframework.ThreadUtil} for thread-related functionalities.</li>
+ *     <li>{@link net.openhft.chronicle.testframework.Waiters} for waiting for specific conditions to be met.</li>
+ * </ul>
  */
-package net.openhft.chronicle.testframework;
+package net.openhft.chronicle.testframework;

src/main/java/net/openhft/chronicle/testframework/process/package-info.java

@@ -0,0 +1,13 @@
+/**
+ * The {@code net.openhft.chronicle.testframework.internal.process} package provides internal implementations
+ * for configuring and launching Java processes within the Chronicle testing framework.
+ * <p>
+ * This package includes classes that allow customization of JVM arguments, program arguments, classpath
+ * entries, and IO behavior for spawned Java processes. It includes implementations of the
+ * {@link net.openhft.chronicle.testframework.process.JavaProcessBuilder} interface, providing control
+ * over process creation.
+ * <p>
+ * Usage of classes in this package may be primarily intended for internal use within the framework,
+ * rather than direct usage by client code.
+ */
+package net.openhft.chronicle.testframework.internal.process;