Document PatioCodeGen::generateMain()

1 files changed, 5 insertions, 1 deletions

diff --git a/src/main/java/org/shedlang/compiler/patio/PatioCodeGen.java b/src/main/java/org/shedlang/compiler/patio/PatioCodeGen.java
index 262fc2c5..d0a04c97 100644
--- a/src/main/java/org/shedlang/compiler/patio/PatioCodeGen.java
+++ b/src/main/java/org/shedlang/compiler/patio/PatioCodeGen.java
@@ -19,6 +19,11 @@ import java.util.function.Function;
 public class PatioCodeGen {
     private PatioCodeGen() {}
 
+    /**
+     * Generate a main function by importing the given namespace and calling the
+     * {@code main} field with no arguments. Callers are responsible for
+     * ensuring that such a field exists.
+     */
     public static PatioCodeGenResult<String> generateMain(
         NamespaceName main,
         Source source,
@@ -61,7 +66,6 @@ public class PatioCodeGen {
                     mainField,
                     namespaceValue,
                     main,
-                    // TODO: check there is a main function
                     "main",
                     source,
                     mainContext