From 709bdb7d6afd9c26b739ed2b0d769559e7467363 Mon Sep 17 00:00:00 2001
From: Bogdan Kobylynskyi <92bogdan@gmail.com>
Date: Thu, 30 Jan 2020 15:26:48 -0600
Subject: [PATCH] Fix javadoc

---
 .../FieldDefinitionToParameterMapper.java      |  2 +-
 .../mapper/GraphqlTypeToJavaTypeMapper.java    | 18 ++++++++++++++++++
 .../InputValueDefinitionToParameterMapper.java |  8 ++++++++
 3 files changed, 27 insertions(+), 1 deletion(-)

diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/mapper/FieldDefinitionToParameterMapper.java b/src/main/java/com/kobylynskyi/graphql/codegen/mapper/FieldDefinitionToParameterMapper.java
index 09283ed8..5de363df 100644
--- a/src/main/java/com/kobylynskyi/graphql/codegen/mapper/FieldDefinitionToParameterMapper.java
+++ b/src/main/java/com/kobylynskyi/graphql/codegen/mapper/FieldDefinitionToParameterMapper.java
@@ -21,7 +21,7 @@ public class FieldDefinitionToParameterMapper {
      * @param mappingConfig    Global mapping configuration
      * @param fieldDefinitions List of GraphQL field definitions
      * @param parentTypeName   Name of the parent GraphQL type
-     * @return Freemarker data model of the GraphQL interface
+     * @return Freemarker data model of the GraphQL field definition
      */
     public static List<ParameterDefinition> map(MappingConfig mappingConfig,
                                                 List<FieldDefinition> fieldDefinitions,
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/mapper/GraphqlTypeToJavaTypeMapper.java b/src/main/java/com/kobylynskyi/graphql/codegen/mapper/GraphqlTypeToJavaTypeMapper.java
index 137a17ec..924f9de3 100644
--- a/src/main/java/com/kobylynskyi/graphql/codegen/mapper/GraphqlTypeToJavaTypeMapper.java
+++ b/src/main/java/com/kobylynskyi/graphql/codegen/mapper/GraphqlTypeToJavaTypeMapper.java
@@ -155,10 +155,28 @@ class GraphqlTypeToJavaTypeMapper {
         return annotations;
     }
 
+    /**
+     * Wrap java type into collection. E.g.: "String" becomes "Collection<String"
+     *
+     * @param type Anything that will be wrapped into Collection<>
+     * @return String wrapped into Collection<>
+     */
     private static String wrapIntoJavaCollection(String type) {
         return String.format("Collection<%s>", type);
     }
 
+    /**
+     * Wraps type into subscriptionReturnType (defined in the mapping configuration.
+     * Example:
+     * Given GraphQL schema:                           type Subscription { eventsCreated: [Event!]! }
+     * Given subscriptionReturnType in mapping config: org.reactivestreams.Publisher
+     * Return: org.reactivestreams.Publisher<Event>
+     *
+     * @param mappingConfig  Global mapping configuration
+     * @param javaTypeName   The type that will be wrapped into
+     * @param parentTypeName Name of the parent type
+     * @return Java type wrapped into the subscriptionReturnType
+     */
     static String wrapIntoSubscriptionIfRequired(MappingConfig mappingConfig, String javaTypeName, String parentTypeName) {
         if (parentTypeName.equalsIgnoreCase(Operation.SUBSCRIPTION.name())
                 && !Utils.isBlank(mappingConfig.getSubscriptionReturnType())) {
diff --git a/src/main/java/com/kobylynskyi/graphql/codegen/mapper/InputValueDefinitionToParameterMapper.java b/src/main/java/com/kobylynskyi/graphql/codegen/mapper/InputValueDefinitionToParameterMapper.java
index b0ed48b1..a61cf388 100644
--- a/src/main/java/com/kobylynskyi/graphql/codegen/mapper/InputValueDefinitionToParameterMapper.java
+++ b/src/main/java/com/kobylynskyi/graphql/codegen/mapper/InputValueDefinitionToParameterMapper.java
@@ -15,6 +15,14 @@ import java.util.stream.Collectors;
  */
 public class InputValueDefinitionToParameterMapper {
 
+    /**
+     * Map input value definition to a Freemarker-understandable data model type
+     *
+     * @param mappingConfig    Global mapping configuration
+     * @param valueDefinitions List of GraphQL value definitions
+     * @param parentTypeName   Name of the parent GraphQL type
+     * @return Freemarker data model of the GraphQL input value definition
+     */
     public static List<ParameterDefinition> map(MappingConfig mappingConfig, List<InputValueDefinition> valueDefinitions, String parentTypeName) {
         if (valueDefinitions == null) {
             return Collections.emptyList();
-- 
GitLab