Add docs

1 files changed, 4 insertions, 0 deletions

diff --git a/src/main/java/org/shedlang/compiler/patio/PatioCodeGenGc.java b/src/main/java/org/shedlang/compiler/patio/PatioCodeGenGc.java
index e67554fe..4178510f 100644
--- a/src/main/java/org/shedlang/compiler/patio/PatioCodeGenGc.java
+++ b/src/main/java/org/shedlang/compiler/patio/PatioCodeGenGc.java
@@ -23,6 +23,10 @@ public class PatioCodeGenGc {
         return Lists.concat(List.of(1), valueOffset);
     }
 
+    /**
+     * Creates a data value for GC objects that should never be garbage
+     * collected. Such a value does not need to be added to the set of GC roots.
+     */
     public static PatioDataValue gcObjectStaticDataValue(PatioDataValue value) {
         return PatioDataValues.struct(List.of(
             PatioDataValues.int_(0),