added javadoc to JpsPackagingElement and inheritors

2026-09-27 10:03:11 +07:00 · 2016-10-26 11:46:22 +03:00
parent 4b3dfb0e46
commit c28417f3e4
8 changed files with 30 additions and 0 deletions
@@ -18,6 +18,9 @@ package org.jetbrains.jps.model.artifact.elements;
 import java.util.List;

 /**
+ * Represents a synthetic node which is substituted by a collection of other elements when the artifact is being built. E.g. a node which
+ * represents a Java library is substituted by {@link JpsFileCopyPackagingElement} for its JAR files.
+ *
 * @author nik
 */
 public interface JpsComplexPackagingElement extends JpsPackagingElement {
@@ -20,9 +20,14 @@ import org.jetbrains.annotations.NotNull;
 import java.util.List;

 /**
+ * Represents a {@link JpsDirectoryPackagingElement directory} or an {@link JpsArchivePackagingElement archive} node in the output layout.
+ *
 * @author nik
 */
 public interface JpsCompositePackagingElement extends JpsPackagingElement {
+  /**
+   * @return list of nodes representing top-level content of this directory or archive
+   */
  @NotNull
  List<JpsPackagingElement> getChildren();

@@ -16,6 +16,9 @@
 package org.jetbrains.jps.model.artifact.elements;

 /**
+ * Represents 'Copy of directory contents' node in the output layout tree. When the artifact is being built all files from the specified directory
+ * will be copied or packed to the corresponding place under the artifact output directory.
+ *
 * @author nik
 */
 public interface JpsDirectoryCopyPackagingElement extends JpsPackagingElement {
@@ -16,6 +16,9 @@
 package org.jetbrains.jps.model.artifact.elements;

 /**
+ * Represents 'extracted directory' node in the output layout tree. When the artifact is being built all files in the specified directory inside
+ * the specified archive will be copied or packed to the corresponding place under the artifact output directory.
+ *
 * @author nik
 */
 public interface JpsExtractedDirectoryPackagingElement extends JpsPackagingElement {
@@ -16,6 +16,9 @@
 package org.jetbrains.jps.model.artifact.elements;

 /**
+ * Represents 'Copy of file' node in the output layout tree. When the artifact is being built the specified file will be copied or packed (optionally under
+ * different name) to the corresponding place under the artifact output directory.
+ *
 * @author nik
 */
 public interface JpsFileCopyPackagingElement extends JpsPackagingElement {
@@ -19,6 +19,9 @@ import org.jetbrains.annotations.NotNull;
 import org.jetbrains.jps.model.library.JpsLibraryReference;

 /**
+ * Represents 'library files' node in the output layout tree. When the artifact is being built the 'classes' roots of the specified library will be
+ * copied or packed to the corresponding place under the artifact output directory.
+ *
 * @author nik
 */
 public interface JpsLibraryFilesPackagingElement extends JpsPackagingElement {
@@ -20,6 +20,9 @@ import org.jetbrains.annotations.Nullable;
 import org.jetbrains.jps.model.module.JpsModuleReference;

 /**
+ * Represents 'module output' node in the output layout tree. When the artifact is being built the output of the specified module will be copied or
+ * packed to the corresponding place under the artifact output directory.
+ *
 * @author nik
 */
 public interface JpsModuleOutputPackagingElement extends JpsPackagingElement {
@@ -18,6 +18,13 @@ package org.jetbrains.jps.model.artifact.elements;
 import org.jetbrains.jps.model.JpsElement;

 /**
+ * Represents a node in the output layout tree of an artifact.
+ *
+ * @see JpsComplexPackagingElement
+ * @see JpsCompositePackagingElement
+ * @see JpsFileCopyPackagingElement
+ * @see JpsDirectoryCopyPackagingElement
+ *
 * @author nik
 */
 public interface JpsPackagingElement extends JpsElement {