Modify and add class comments

embrace-io · Oct 30, 2023 · 0ca956f · 0ca956f
1 parent 7667ac6
commit 0ca956f
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 2 deletions.
diff --git a/...in/java/io/embrace/android/embracesdk/internal/network/http/EmbraceHttpUrlConnection.java b/...in/java/io/embrace/android/embracesdk/internal/network/http/EmbraceHttpUrlConnection.java
@@ -17,6 +17,12 @@
 
 import javax.net.ssl.SSLPeerUnverifiedException;
 
+/**
+ * An interface that duplicates the functionality of HttpURLConnection whose implementation can then wrap an actual HttpURLConnection's
+ * implementation so calls can be forwarded from this interface's implementation to the wrapped HttpURLConnection implementation.
+ * Having this separate interface allows the actual wrappers ({@link EmbraceHttpUrlConnectionImpl}/{@link EmbraceHttpsUrlConnectionImpl})
+ * to share an implementation whilst exposing separate interfaces for what they're wrapping.
+ */
 interface EmbraceHttpUrlConnection {
 
  void addRequestProperty(@NonNull String key, @Nullable String value);

diff --git a/...ava/io/embrace/android/embracesdk/internal/network/http/EmbraceHttpUrlConnectionImpl.java b/...ava/io/embrace/android/embracesdk/internal/network/http/EmbraceHttpUrlConnectionImpl.java
@@ -12,6 +12,9 @@
 import java.util.List;
 import java.util.Map;
 
+/**
+ * An implementation of HttpURLConnection that forwards calls to an {@link EmbraceUrlConnectionDelegate}
+ */
 class EmbraceHttpUrlConnectionImpl<T extends HttpURLConnection> extends HttpURLConnection {
 
  private final EmbraceHttpUrlConnection embraceHttpUrlConnectionDelegate;

diff --git a/...n/java/io/embrace/android/embracesdk/internal/network/http/EmbraceHttpsUrlConnection.java b/...n/java/io/embrace/android/embracesdk/internal/network/http/EmbraceHttpsUrlConnection.java
@@ -10,7 +10,7 @@
 import javax.net.ssl.SSLSocketFactory;
 
 /**
- * Additional methods for HTTPS network calls
+ * {@link EmbraceHttpUrlConnection} plus additional methods for HTTPS network calls
  */
 interface EmbraceHttpsUrlConnection extends EmbraceHttpUrlConnection {
 

diff --git a/...ava/io/embrace/android/embracesdk/internal/network/http/EmbraceUrlConnectionDelegate.java b/...ava/io/embrace/android/embracesdk/internal/network/http/EmbraceUrlConnectionDelegate.java
@@ -41,7 +41,7 @@
 import kotlin.jvm.functions.Function0;
 
 /**
- * Wraps @{link HttpUrlConnection} to log network calls to Embrace. The wrapper also wraps the
+ * Wraps {@link HttpURLConnection} to log network calls to Embrace. The wrapper also wraps the
  * InputStream to get an accurate count of bytes received if a Content-Length is not provided by
  * the server.
  * <p>