update javadoc and instructions

Author: JavaSaBr

.github/copilot-instructions.md

@@ -75,9 +75,14 @@ Javadoc conventions
 - Omit javadoc for simple getters/setters (e.g., `getArch()`, `setArch(String)`); they are self-explanatory.
 - Omit obvious field comments that just repeat the field name (e.g., `/** The name. */ private String name;`).
 - Omit obvious constant comments (e.g., `/** The constant FOO. */ public static final String FOO = "foo";`).
-- Type parameter descriptions should be meaningful (e.g., `@param <T> the element type` not `@param <T> the type parameter`).
+- Type parameter descriptions should use consistent format: "the type of..." (e.g., `@param <T> the type of elements` not `@param <T> the element type`).
 - Do not generate javadoc for implementation classes (only interfaces and public API classes).
 - For `@see` tags, avoid duplicate references (e.g., use `@see Math#sin(double)` not `@see Math#sin(double) Math#sin(double)`).
+- For functional interfaces:
+    - Consumer descriptions must include "and returns no result" (e.g., "Represents an operation that accepts an int and an object argument, and returns no result.").
+    - Use type-specific @param descriptions (e.g., "the int argument", "the object argument") instead of generic "the first argument".
+    - Function @return should use "the function result" for consistency.
+    - Predicate @return should use "true if the arguments match the predicate".
 
 Project layout & where to change things
 - Root-level important files:

.github/skills/generate-javadoc.md

@@ -29,6 +29,14 @@ When the user asks to:
 2. **No trailing periods** - in `@param` and `@return` descriptions (e.g., `@param value the value` not `@param value the value.`)
 3. **No duplicate @see references** - use `@see Math#sin(double)` not `@see Math#sin(double) Math#sin(double)`
 4. **Lowercase @param/@return descriptions** - start with lowercase (e.g., `@param value the value` not `@param value The value`)
+5. **Consistent type parameter format** - use "the type of..." pattern (e.g., `@param <T> the type of elements` not `@param <T> the element type`)
+6. **Descriptive @param names** - for functional interfaces, use type-specific descriptions (e.g., "the int argument", "the object argument") instead of generic "the first argument"
+
+### Functional Interface Conventions
+1. **Consumer descriptions** - always include "and returns no result" (e.g., "Represents an operation that accepts an int and an object argument, and returns no result.")
+2. **Function @return** - use "the function result" for consistency
+3. **Predicate @return** - use "true if the arguments match the predicate" or "true if the arguments match the predicate, false otherwise"
+4. **Supplier @return** - describe what is supplied (e.g., "the char value" not just "a result")
 
 ### Javadoc Standards
 Each documented element must include:
@@ -91,6 +99,29 @@ public interface Array<E> extends Iterable<E> {
 }
 ```
 
+### Functional Interface Example
+
+```java
+/**
+ * Represents an operation that accepts an int and an object argument, and returns no result.
+ *
+ * @param <B> the type of the object argument
+ * @since 10.0.0
+ */
+@FunctionalInterface
+public interface IntObjConsumer<B> {
+
+  /**
+   * Performs this operation on the given arguments.
+   *
+   * @param arg1 the int argument
+   * @param arg2 the object argument
+   * @since 10.0.0
+   */
+  void accept(int arg1, B arg2);
+}
+```
+
 ### Common Fixes When Reviewing Existing Javadocs
 - Change "Return the" to "Returns the"
 - Change "Compare the" to "Compares the"

rlib-functions/src/main/java/javasabr/rlib/functions/BiObjLongConsumer.java

@@ -1,10 +1,10 @@
 package javasabr.rlib.functions;
 
 /**
- * Represents an operation that accepts two object arguments and a long argument.
+ * Represents an operation that accepts two object arguments and a long argument, and returns no result.
  *
- * @param <A> the first object argument type
- * @param <B> the second object argument type
+ * @param <A> the type of the first object argument
+ * @param <B> the type of the second object argument
  * @since 10.0.0
  */
 @FunctionalInterface
@@ -13,9 +13,9 @@ public interface BiObjLongConsumer<A, B> {
   /**
    * Performs this operation on the given arguments.
    *
-   * @param arg1 the first argument
-   * @param arg2 the second argument
-   * @param arg3 the third argument
+   * @param arg1 the first object argument
+   * @param arg2 the second object argument
+   * @param arg3 the long argument
    * @since 10.0.0
    */
   void accept(A arg1, B arg2, long arg3);

rlib-functions/src/main/java/javasabr/rlib/functions/BiObjToBoolFunction.java

@@ -3,8 +3,8 @@
 /**
  * Represents a function that accepts two object arguments and produces a boolean result.
  *
- * @param <A> the first argument type
- * @param <B> the second argument type
+ * @param <A> the type of the first argument
+ * @param <B> the type of the second argument
  * @since 10.0.0
  */
 @FunctionalInterface
@@ -15,7 +15,7 @@ public interface BiObjToBoolFunction<A, B> {
    *
    * @param arg1 the first argument
    * @param arg2 the second argument
-   * @return the function result
+   * @return true or false based on the evaluation
    * @since 10.0.0
    */
   boolean apply(A arg1, B arg2);

rlib-functions/src/main/java/javasabr/rlib/functions/ByteFunction.java

@@ -12,7 +12,7 @@ public interface ByteFunction<R> {
   /**
    * Applies this function to the given argument.
    *
-   * @param value the argument
+   * @param value the byte value
    * @return the function result
    * @since 10.0.0
    */

rlib-functions/src/main/java/javasabr/rlib/functions/CharSupplier.java

@@ -1,12 +1,18 @@
 package javasabr.rlib.functions;
 
+/**
+ * Represents a supplier of char-valued results.
+ *
+ * @since 10.0.0
+ */
 @FunctionalInterface
 public interface CharSupplier {
 
   /**
    * Gets a result.
    *
-   * @return a result
+   * @return the char value
+   * @since 10.0.0
    */
   char getAsChar();
 }

rlib-functions/src/main/java/javasabr/rlib/functions/DoubleObjConsumer.java

@@ -14,6 +14,7 @@ public interface DoubleObjConsumer<B> {
    *
    * @param arg1 the double argument
    * @param arg2 the object argument
+   * @since 10.0.0
    */
   void accept(double arg1, B arg2);
 }

rlib-functions/src/main/java/javasabr/rlib/functions/FloatBiObjConsumer.java

@@ -19,6 +19,7 @@ public interface FloatBiObjConsumer<B, C> {
    * @param arg1 the float argument
    * @param arg2 the first object argument
    * @param arg3 the second object argument
+   * @since 10.0.0
    */
   void accept(float arg1, B arg2, C arg3);
 }

rlib-functions/src/main/java/javasabr/rlib/functions/FloatConsumer.java

@@ -12,6 +12,7 @@ public interface FloatConsumer {
    * Performs this operation on the given float value.
    *
    * @param arg the float value
+   * @since 10.0.0
    */
   void consume(float arg);
 }

rlib-functions/src/main/java/javasabr/rlib/functions/FunctionInt.java

@@ -14,6 +14,7 @@ public interface FunctionInt<A> {
    *
    * @param arg the function argument
    * @return the int result
+   * @since 10.0.0
    */
   int apply(A arg);
 }