From ff929688851deed478b87251c69714f7b8427212 Mon Sep 17 00:00:00 2001
From: Fabrizio Demaria <fdema@spotify.com>
Date: Fri, 29 Sep 2023 15:05:33 +0200
Subject: [PATCH] docs: Build javadocs jar (#53)

* docs: Build javadocs jar

* docs: Exclude protobuf from javadocs

* docs: Fix warnings
---
 pom.xml                                       | 47 +++++++------------
 .../confidence/ConfidenceFeatureProvider.java | 13 +++++
 2 files changed, 31 insertions(+), 29 deletions(-)

diff --git a/pom.xml b/pom.xml
index fde9a84a..5365904b 100644
--- a/pom.xml
+++ b/pom.xml
@@ -180,6 +180,24 @@
       <resource><directory>src/main/proto</directory></resource>
     </resources>
     <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>3.6.0</version>
+        <executions>
+          <execution>
+            <id>attach-javadocs</id>
+            <goals>
+              <goal>jar</goal>
+            </goals>
+          </execution>
+        </executions>
+        <configuration>
+          <excludePackageNames>
+            com.spotify.confidence.flags.*
+          </excludePackageNames>
+        </configuration>
+      </plugin>
       <plugin>
         <groupId>org.xolstice.maven.plugins</groupId>
         <artifactId>protobuf-maven-plugin</artifactId>
@@ -333,33 +351,4 @@
       </plugin>
     </plugins>
   </build>
-  <reporting>
-    <plugins>
-      <plugin>
-        <artifactId>maven-javadoc-plugin</artifactId>
-        <version>3.4.1</version>
-        <configuration>
-          <show>protected</show>
-        </configuration>
-        <reportSets>
-          <reportSet>
-            <id>default</id>
-            <reports>
-              <report>javadoc</report>
-            </reports>
-          </reportSet>
-          <reportSet>
-            <id>aggregate</id>
-            <reports>
-              <report>aggregate</report>
-            </reports>
-          </reportSet>
-        </reportSets>
-      </plugin>
-      <plugin>
-        <artifactId>maven-project-info-reports-plugin</artifactId>
-        <version>3.4.1</version>
-      </plugin>
-    </plugins>
-  </reporting>
 </project>
diff --git a/src/main/java/com/spotify/confidence/ConfidenceFeatureProvider.java b/src/main/java/com/spotify/confidence/ConfidenceFeatureProvider.java
index 288fced3..3396227f 100644
--- a/src/main/java/com/spotify/confidence/ConfidenceFeatureProvider.java
+++ b/src/main/java/com/spotify/confidence/ConfidenceFeatureProvider.java
@@ -30,19 +30,32 @@
 import java.util.function.Function;
 import java.util.regex.Pattern;
 
+/** OpenFeature Provider for feature flagging with the Confidence platform */
 public class ConfidenceFeatureProvider implements FeatureProvider {
 
+  // Deadline in seconds
   public static final int DEADLINE_AFTER_SECONDS = 10;
   private final FlagResolverServiceBlockingStub stub;
   private final String clientSecret;
 
   static final String TARGETING_KEY = "targeting_key";
 
+  /**
+   * ConfidenceFeatureProvider constructor
+   *
+   * @param clientSecret generated from Confidence
+   * @param stub for testing
+   */
   public ConfidenceFeatureProvider(String clientSecret, FlagResolverServiceBlockingStub stub) {
     this.clientSecret = clientSecret;
     this.stub = stub;
   }
 
+  /**
+   * ConfidenceFeatureProvider constructor
+   *
+   * @param clientSecret generated from Confidence
+   */
   public ConfidenceFeatureProvider(String clientSecret) {
     final ManagedChannel channel =
         ManagedChannelBuilder.forAddress("edge-grpc.spotify.com", 443).build();