Javadoc

Signed-off-by: Finn Carroll <[email protected]>
finnegancarroll · Aug 23, 2024 · 1103fbb · 1103fbb
1 parent 52d7c15
commit 1103fbb
Show file tree

Hide file tree

Showing 4 changed files with 12 additions and 0 deletions.
diff --git a/server/src/main/java/org/opensearch/search/fetch/serde/FetchSearchResultsSerDe.java b/server/src/main/java/org/opensearch/search/fetch/serde/FetchSearchResultsSerDe.java
@@ -16,6 +16,9 @@
 
 import java.io.IOException;
 
+/**
+ * Serialization/Deserialization implementations for SearchHit.
+ */
 public class FetchSearchResultsSerDe implements SerDe.StreamSerializer<FetchSearchResult>, SerDe.StreamDeserializer<FetchSearchResult> {
     /**
      * TODO NOTE: FetchSearchResult inheritance structure is as follows.

diff --git a/server/src/main/java/org/opensearch/search/fetch/serde/SearchHitSerDe.java b/server/src/main/java/org/opensearch/search/fetch/serde/SearchHitSerDe.java
@@ -34,6 +34,9 @@
 import static org.opensearch.common.lucene.Lucene.writeExplanation;
 import static org.opensearch.search.SearchHit.SINGLE_MAPPING_TYPE;
 
+/**
+ * Serialization/Deserialization implementations for SearchHit.
+ */
 public class SearchHitSerDe implements SerDe.StreamSerializer<SearchHit>, SerDe.StreamDeserializer<SearchHit> {
 
     @Override

diff --git a/server/src/main/java/org/opensearch/search/fetch/serde/SearchHitsSerDe.java b/server/src/main/java/org/opensearch/search/fetch/serde/SearchHitsSerDe.java
@@ -20,6 +20,9 @@
 
 import static org.opensearch.search.SearchHits.EMPTY;
 
+/**
+ * Serialization/Deserialization implementations for SearchHits.
+ */
 public class SearchHitsSerDe implements SerDe.StreamSerializer<SearchHits>, SerDe.StreamDeserializer<SearchHits> {
     SearchHitSerDe searchHitSerDe;
 

diff --git a/server/src/main/java/org/opensearch/search/fetch/serde/SerDe.java b/server/src/main/java/org/opensearch/search/fetch/serde/SerDe.java
@@ -13,6 +13,9 @@
 import org.opensearch.core.xcontent.XContentBuilder;
 import org.opensearch.core.xcontent.XContentParser;
 
+/**
+ * Base class for supported serialization/deserialization implementations.
+ */
 public class SerDe {
 
     public static class SerializationException extends RuntimeException {