From ea1ec7779b19cc6f6869aaebdbe5d5c63f59ff6d Mon Sep 17 00:00:00 2001
From: nik <Nikolay.Chashnikov@jetbrains.com>
Date: Tue, 13 Nov 2018 10:55:27 +0300
Subject: [PATCH] jps build: javadocs added

---
 .../src/org/jetbrains/jps/builders/BuildRootDescriptor.java  | 3 +++
 .../jetbrains/jps/model/java/JavaSourceRootProperties.java   | 5 +++++
 2 files changed, 8 insertions(+)

diff --git a/jps/jps-builders/src/org/jetbrains/jps/builders/BuildRootDescriptor.java b/jps/jps-builders/src/org/jetbrains/jps/builders/BuildRootDescriptor.java
index 353c3058aa9a..1e1094307d15 100644
--- a/jps/jps-builders/src/org/jetbrains/jps/builders/BuildRootDescriptor.java
+++ b/jps/jps-builders/src/org/jetbrains/jps/builders/BuildRootDescriptor.java
@@ -69,6 +69,9 @@ public abstract class BuildRootDescriptor {
     return Collections.emptySet();
   }
 
+  /**
+   * Returns {@code true} if the whole content of this source root was automatically generated by the JPS build process.
+   */
   public boolean isGenerated() {
     return false;
   }
diff --git a/jps/model-api/src/org/jetbrains/jps/model/java/JavaSourceRootProperties.java b/jps/model-api/src/org/jetbrains/jps/model/java/JavaSourceRootProperties.java
index dae3c79d7489..c5b5c705a443 100644
--- a/jps/model-api/src/org/jetbrains/jps/model/java/JavaSourceRootProperties.java
+++ b/jps/model-api/src/org/jetbrains/jps/model/java/JavaSourceRootProperties.java
@@ -62,6 +62,11 @@ public class JavaSourceRootProperties extends JpsElementBase<JavaSourceRootPrope
     return new JavaSourceRootProperties(myPackagePrefix, myForGeneratedSources);
   }
 
+  /**
+   * Returns {@code true} if the source root contain only sources which were automatically generated by some program. Classes from such
+   * sources roots can be used in the IDE, they will be compiled with the other sources, etc, however IDE will warn users if they try
+   * editing them manually.
+   */
   public boolean isForGeneratedSources() {
     return myForGeneratedSources;
   }