docs: add @implNote to DeezerRequest (#212)

Author: yvasyliev

build.gradle

@@ -118,6 +118,12 @@ tasks.withType(JavaCompile).configureEach {
     }
 }
 
+javadoc {
+    options {
+        tags 'implNote:a:Implementation Note:'
+    }
+}
+
 jacocoTestReport {
     dependsOn test, integrationTest
 

config/checkstyle/checkstyle.xml

@@ -7,6 +7,10 @@
         <property name="file" value="${config_loc}/checkstyle-suppressions.xml"/>
     </module>
 
+    <module name="SuppressionSingleFilter">
+        <property name="message" value="Unknown tag '(implNote|implSpec|apiNote)'"/>
+    </module>
+
     <module name="FileLength"/>
     <module name="FileTabCharacter"/>
     <module name="JavadocPackage"/>
@@ -40,6 +44,9 @@
                             @throws,
                             @author,
                             @version,
+                            @implNote,
+                            @implSpec,
+                            @apiNote,
                             @since"/>
         </module>
         <module name="AvoidNestedBlocks">

src/main/java/io/github/yvasyliev/dz4j/request/DeezerRequest.java

@@ -7,11 +7,10 @@
 /**
  * Represents a request to the Deezer API that can be executed synchronously or asynchronously.
  *
- * <p>
- * It's recommended to extend {@link AbstractDeezerRequest} instead of implementing this interface directly for the
- * streamlined handling of exceptions and asynchronous execution.
- *
  * @param <T> the type of the response expected from the Deezer API
+ * @implNote Implementers are encouraged to extend {@link AbstractDeezerRequest} rather than {@code implement}
+ *         this interface directly; the abstract base class provides default exception handling and a standard
+ *         asynchronous implementation.
  */
 public interface DeezerRequest<T> {
     /**