Skip to content

Commit 899f540

Browse files
committed
Add missing documentation
1 parent 68be586 commit 899f540

File tree

1 file changed

+13
-3
lines changed

1 file changed

+13
-3
lines changed

library/src/scala/annotation/MainAnnotation.scala

Lines changed: 13 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,9 +86,19 @@ object MainAnnotation:
8686
def run(program: () => Result): Unit
8787
end Command
8888

89-
final class CommandInfo(val name: String, val documentation: String, val parameters: Seq[ParameterInfo])
89+
/** Information about the main method
90+
*
91+
* @param name The name of the main method
92+
* @param documentation The documentation of the main method without the `@param` documentation (see ParameterInfo.documentaion)
93+
* @param parameters Information about the parameters of the main method
94+
*/
95+
final class CommandInfo(
96+
val name: String,
97+
val documentation: String,
98+
val parameters: Seq[ParameterInfo],
99+
)
90100

91-
/** ParameterInfo with a name, the type of the parameter and if it has a default
101+
/** Information about a parameter of a main method
92102
*
93103
* @param name The name of the parameter
94104
* @param typeName The name of the parameter's type
@@ -103,7 +113,7 @@ object MainAnnotation:
103113
val hasDefault: Boolean,
104114
val isVarargs: Boolean,
105115
val documentation: String,
106-
val annotations: Seq[ParameterAnnotation]
116+
val annotations: Seq[ParameterAnnotation],
107117
)
108118

109119
/** Marker trait for annotations that will be included in the ParameterInfo annotations. */

0 commit comments

Comments
 (0)