Skip to content

Fix: Missing javadocs for types in For comprehensions #3089

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Nov 11, 2025
+331 −0
Merged

Fix: Missing javadocs for types in For comprehensions #3089

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
17cd615
Fix: Missing javadocs for types in For comprehensions
adamkopec Nov 7, 2025
d93c059
Merge branch 'main' into fix/for-generated-javadocs
adamkopec Nov 8, 2025
5110282
Merge branch 'main' into fix/for-generated-javadocs
pivovarit Nov 11, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions vavr/generator/Generator.scala
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -948,10 +948,17 @@ def generateMainClasses(): Unit = {
case 2 => BiFunctionType
case _ => s"Function$i"
}

val parameterDoc = (if (monadicTypesThatNeedParameter.contains(mtype)) {
s"\n* @param <L> The left-hand type of all {@link $mtype}s"
} else { "" })
val typeDocs = (1 to i).gen(j => s"* @param <T$j> component type of {@link $mtype} number $j\n")
val args = (1 to i).gen(j => s"? super T$j")(", ")
xs"""
/$javadoc
* For-comprehension with ${i.numerus(mtype)}.
$parameterDoc
$typeDocs
*/
public static class $forClassName<$generics> {

Expand Down
Loading