javadoc

jps/model-api/src/org/jetbrains/jps/model/JpsElementType.java

@@ -18,6 +18,11 @@ package org.jetbrains.jps.model;
 import org.jetbrains.annotations.NotNull;
 
 /**
+ * Base interface for all types of elements in JPS model
+ *
+ * <p>
+ * Use {@link org.jetbrains.jps.model.ex.JpsElementTypeBase} as a base class for all implementations of this interface
+ * </p>
  * @author nik
  */
 public interface JpsElementType<P extends JpsElement> {

jps/model-api/src/org/jetbrains/jps/model/artifact/JpsArtifactType.java

@@ -19,6 +19,11 @@ import org.jetbrains.jps.model.JpsElement;
 import org.jetbrains.jps.model.JpsElementType;
 
 /**
+ * Represents a type of artifacts in JPS model
+ *
+ * <p>
+ * Use {@link org.jetbrains.jps.model.ex.JpsElementTypeBase} as a base class for implementations of this interface
+ * </p>
  * @author nik
  */
 public interface JpsArtifactType<P extends JpsElement> extends JpsElementType<P> {

jps/model-api/src/org/jetbrains/jps/model/ex/JpsElementTypeBase.java

@@ -21,6 +21,11 @@ import org.jetbrains.jps.model.JpsElementChildRole;
 import org.jetbrains.jps.model.JpsElementType;
 
 /**
+ * A base class for all implementations of {@link org.jetbrains.jps.model.JpsElementType}.
+ *
+ * <p>
+ * If elements of your type don't have any specific properties extend {@link JpsElementTypeWithDummyProperties} instead.
+ * </p>
  * @author nik
  */
 public abstract class JpsElementTypeBase<P extends JpsElement>implements JpsElementType<P> {

jps/model-api/src/org/jetbrains/jps/model/ex/JpsElementTypeWithDummyProperties.java

@@ -21,6 +21,8 @@ import org.jetbrains.jps.model.JpsElementFactory;
 import org.jetbrains.jps.model.JpsElementTypeWithDefaultProperties;
 
 /**
+ * A base class for type elements without any specific properties
+ *
  * @author nik
  */
 public abstract class JpsElementTypeWithDummyProperties extends JpsElementTypeBase<JpsDummyElement> implements JpsElementTypeWithDefaultProperties<JpsDummyElement> {

jps/model-api/src/org/jetbrains/jps/model/library/JpsLibraryType.java

@@ -19,6 +19,10 @@ import org.jetbrains.jps.model.JpsElement;
 import org.jetbrains.jps.model.JpsElementType;
 
 /**
+ * Represents a type of libraries in JPS model.
+ * <p>
+ * Use {@link org.jetbrains.jps.model.ex.JpsElementTypeBase} as a base class for implementations of this interface
+ * </p>
  * @author nik
  */
 public interface JpsLibraryType<P extends JpsElement> extends JpsElementType<P> {

jps/model-api/src/org/jetbrains/jps/model/module/JpsModuleSourceRootType.java

@@ -20,6 +20,11 @@ import org.jetbrains.jps.model.JpsElementType;
 import org.jetbrains.jps.model.JpsElementTypeWithDefaultProperties;
 
 /**
+ * Represents a type of source roots of modules in JPS model.
+ *
+ * <p>
+ * Use {@link org.jetbrains.jps.model.ex.JpsElementTypeBase} as a base class for implementations of this interface
+ * </p>
  * @author nik
  */
 public interface JpsModuleSourceRootType<P extends JpsElement> extends JpsElementType<P>, JpsElementTypeWithDefaultProperties<P> {

jps/model-api/src/org/jetbrains/jps/model/module/JpsModuleType.java

@@ -19,6 +19,11 @@ import org.jetbrains.jps.model.JpsElement;
 import org.jetbrains.jps.model.JpsElementType;
 
 /**
+ * Represents a type of modules in JPS model
+ *
+ * <p>
+ * Use {@link org.jetbrains.jps.model.ex.JpsElementTypeBase} as a base class for implementations of this interface
+ * </p>
  * @author nik
  */
 public interface JpsModuleType<P extends JpsElement> extends JpsElementType<P> {

jps/model-api/src/org/jetbrains/jps/model/runConfiguration/JpsRunConfigurationType.java

@@ -19,6 +19,11 @@ import org.jetbrains.jps.model.JpsElement;
 import org.jetbrains.jps.model.JpsElementType;
 
 /**
+ * Represents a type of run configurations in JPS model
+ *
+ * <p>
+ * Use {@link org.jetbrains.jps.model.ex.JpsElementTypeBase} as a base class for implementations of this interface
+ * </p>
  * @author nik
  */
 public interface JpsRunConfigurationType<P extends JpsElement> extends JpsElementType<P> {