Merge pull request #548 from iheartradio/javakky/scaladoc-apply-option

fix: Apply Scaladoc comments to Option type fields as well
iheartradio · Mar 1, 2023 · b947d9c · b947d9c
2 parents 089db76 + 0ed9a44
commit b947d9c
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 2 deletions.
diff --git a/core/src/main/scala/com/iheart/playSwagger/SwaggerParameterMapper.scala b/core/src/main/scala/com/iheart/playSwagger/SwaggerParameterMapper.scala
@@ -92,7 +92,8 @@ object SwaggerParameterMapper {
           }
         ),
         modelQualifier = modelQualifier,
-        customMappings = customMappings
+        customMappings = customMappings,
+        description = description
       )
       asRequired.update(required = false, nullable = true, default = asRequired.default)
     }

diff --git a/core/src/test/scala/com/iheart/playSwagger/SwaggerSpecGeneratorSpec.scala b/core/src/test/scala/com/iheart/playSwagger/SwaggerSpecGeneratorSpec.scala
@@ -22,7 +22,7 @@ case class Subject(name: String)
 /**
   * @param name e.g. Sunday, Monday, TuesDay...
   */
-case class DayOfWeek(name: String)
+case class DayOfWeek(name: Option[String])
 
 case class PolymorphicContainer(item: PolymorphicItem)
 trait PolymorphicItem