Document the checkNullness task (#6236)

typetools · Oct 13, 2023 · 0b8da55 · 0b8da55
1 parent 55aa483
commit 0b8da55
Showing 1 changed file with 3 additions and 0 deletions.
diff --git a/build.gradle b/build.gradle
@@ -799,6 +799,9 @@ subprojects {
     createCheckTypeTask(project.name, 'Signature',
         'org.checkerframework.checker.signature.SignatureChecker')
 
+    // The checkNullness task runs on all code, but it only *checks* the following code:
+    //  * All files outside the 'framework' and 'checker' subprojects.
+    //  * In the 'framework' and 'checker' subprojects, files with `@AnnotatedFor("nullness")`.
     if (project.name.is('framework') || project.name.is('checker')) {
       createCheckTypeTask(project.name, 'Nullness',
           'org.checkerframework.checker.nullness.NullnessChecker',