Simplify ParamInfo.documentation

Author: nicolasstucki

compiler/src/dotty/tools/dotc/ast/MainProxies.scala

@@ -243,23 +243,14 @@ object MainProxies {
         val paramTypeStr = formal.dealias.typeSymbol.owner.showFullName + "." + paramType.show
         val hasDefault = defaultValueSymbols.contains(idx)
         val isRepeated = formal.isRepeatedParam
+        val paramDoc = documentation.argDocs.getOrElse(param, "")
 
-        val constructorArgs = List(paramName.toString, paramTypeStr, hasDefault, isRepeated)
+        val constructorArgs = List(param, paramTypeStr, hasDefault, isRepeated, paramDoc)
           .map(value => Literal(Constant(value)))
 
         var paramInfos =
           New(TypeTree(defn.MainAnnotationParameterInfo.typeRef), List(constructorArgs))
 
-        /*
-          * Assignations to be made after the creation of the ParameterInfo.
-          * For example:
-          *   args0paramInfos.withDocumentation("my param x")
-          * is represented by the pair
-          *   defn.MainAnnotationParameterInfo_withDocumentation -> List(Literal("my param x")))
-          */
-        for doc <- documentation.argDocs.get(param) do
-          paramInfos = paramInfos.withProperty(defn.MainAnnotationParameterInfo_withDocumentation, List(Literal(Constant(doc))))
-
         val paramAnnots = paramAnnotations(idx)
         if paramAnnots.nonEmpty then
           paramInfos = paramInfos.withProperty(defn.MainAnnotationParameterInfo_withAnnotations, paramAnnots.map(instantiateAnnotation).toList)

library/src/scala/annotation/MainAnnotation.scala

@@ -32,14 +32,14 @@ object MainAnnotation:
   final class ParameterInfo private (
     paramName: String,
     paramTypeName: String,
-    paramDocumentation: Option[String],
-    paramAnnotations: Seq[ParameterAnnotation],
     paramHasDefault: Boolean,
     paramIsVarargs: Boolean,
+    paramDocumentation: String,
+    paramAnnotations: Seq[ParameterAnnotation],
   ) {
     /** ParameterInfo with a name, the type of the parameter and if it has a default */
-    def this(name: String, typeName: String, hasDefault: Boolean, isVarargs: Boolean) =
-      this(name, typeName, None, Seq.empty, hasDefault, isVarargs)
+    def this(name: String, typeName: String, hasDefault: Boolean, isVarargs: Boolean, documentation: String) =
+      this(name, typeName, hasDefault, isVarargs, documentation, Seq.empty)
 
     /** The name of the parameter */
     def name: String = paramName
@@ -53,19 +53,15 @@ object MainAnnotation:
     /** If this is a varargs parameter. Can only be true if it is the last parameter. */
     def isVarargs: Boolean = paramIsVarargs
 
-    /** The docstring of the parameter. Defaults to None. */
-    def documentation: Option[String] = paramDocumentation
+    /** The docstring of the parameter. */
+    def documentation: String = paramDocumentation
 
     /** The ParameterAnnotations associated with the parameter. Defaults to Seq.empty. */
     def annotations: Seq[ParameterAnnotation] = paramAnnotations
 
-    /** Copy this ParameterInfo and sets the documentation */
-    def withDocumentation(doc: String): ParameterInfo =
-      new ParameterInfo(paramName, typeName, Some(doc), annotations, paramHasDefault, paramIsVarargs)
-
     /** Copy this ParameterInfo and sets the annotations */
     def withAnnotations(annotations: ParameterAnnotation*): ParameterInfo =
-      new ParameterInfo(paramName, typeName, documentation, annotations, paramHasDefault, paramIsVarargs)
+      new ParameterInfo(paramName, typeName, paramHasDefault, paramIsVarargs, documentation, annotations)
 
     override def toString: String = s"$name: $typeName"
   }

tests/run/main-annotation-homemade-annot-6.check

@@ -3,8 +3,8 @@ command(
   foo,
   "Foo docs",
   Seq(
-    ParameterInfo(name="i", typeName="scala.Int", hasDefault=false, isVarargs=false, documentation=None, annotations=List()),
-    ParameterInfo(name="j", typeName="java.lang.String", hasDefault=true, isVarargs=false, documentation=None, annotations=List())
+    ParameterInfo(name="i", typeName="scala.Int", hasDefault=false, isVarargs=false, documentation="", annotations=List()),
+    ParameterInfo(name="j", typeName="java.lang.String", hasDefault=true, isVarargs=false, documentation="", annotations=List())
   )*
 )
 argGetter(0, None)
@@ -17,8 +17,8 @@ command(
   bar,
   "Bar docs",
   Seq(
-    ParameterInfo(name="i", typeName="scala.collection.immutable.List[Int]", hasDefault=false, isVarargs=false, documentation=Some("the first parameter"), annotations=ArraySeq(MyParamAnnot(3))),
-    ParameterInfo(name="rest", typeName="scala.Int", hasDefault=false, isVarargs=true, documentation=None, annotations=List())
+    ParameterInfo(name="i", typeName="scala.collection.immutable.List[Int]", hasDefault=false, isVarargs=false, documentation="the first parameter", annotations=ArraySeq(MyParamAnnot(3))),
+    ParameterInfo(name="rest", typeName="scala.Int", hasDefault=false, isVarargs=true, documentation="", annotations=List())
   )*
 )
 argGetter(0, None)

tests/run/main-annotation-homemade-annot-6.scala

@@ -26,7 +26,7 @@ class myMain extends MainAnnotation:
   override def command(args: Array[String], commandName: String, docs: String, parameterInfos: ParameterInfo*) =
     def paramInfoString(paramInfo: ParameterInfo) =
       import paramInfo.*
-      s"    ParameterInfo(name=\"$name\", typeName=\"$typeName\", hasDefault=$hasDefault, isVarargs=$isVarargs, documentation=${documentation.map("\"" + _ + "\"")}, annotations=$annotations)"
+      s"    ParameterInfo(name=\"$name\", typeName=\"$typeName\", hasDefault=$hasDefault, isVarargs=$isVarargs, documentation=\"$documentation\", annotations=$annotations)"
     println(
       s"""command(
          |  ${args.mkString("Array(", ", ", ")")},