[#1596] DOC: add package-info.java to all modules

picocli-codegen/src/main/java/picocli/codegen/annotation/processing/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Provides classes and interfaces that form a framework for creating picocli annotation processors.
+ */
+package picocli.codegen.annotation.processing;

picocli-codegen/src/main/java/picocli/codegen/aot/graalvm/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Provides tools for generating GraalVM configuration files from a picocli CommandSpec model.
+ */
+package picocli.codegen.aot.graalvm;

picocli-codegen/src/main/java/picocli/codegen/aot/graalvm/processor/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Provides an annotation processor that generates GraalVM configuration files based on a picocli CommandSpec model.
+ */
+package picocli.codegen.aot.graalvm.processor;

picocli-codegen/src/main/java/picocli/codegen/docgen/manpage/package-info.java

@@ -0,0 +1,5 @@
+/**
+ * Provides tools for generating man-page documentation in AsciiDoc format from a picocli CommandSpec model.
+ * These AsciiDoc files are in a special format that can be converted to HTML, PDF and Unix Man pages.
+ */
+package picocli.codegen.docgen.manpage;

picocli-codegen/src/main/java/picocli/codegen/util/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Provides utility classes for internal use in the picocli-codegen module.
+ */
+package picocli.codegen.util;

picocli-groovy/src/main/java/picocli/groovy/package-info.java

@@ -1,4 +1,4 @@
 /**
- * Provides classes and annotations to give Groovy scripts convenient access to picocli functionality.
+ * Provides classes and interfaces for integrating picocli with Groovy.
  */
 package picocli.groovy;

picocli-shell-jline2/src/main/java/picocli/shell/jline2/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Provides classes and interfaces for integrating picocli with JLine 2.
+ */
+package picocli.shell.jline2;

picocli-shell-jline3/src/main/java/picocli/shell/jline3/package-info.java

@@ -0,0 +1,4 @@
+/**
+ * Provides classes and interfaces for integrating picocli with JLine 3.
+ */
+package picocli.shell.jline3;

picocli-spring-boot-starter/src/main/java/picocli/spring/boot/autoconfigure/package-info.java

@@ -0,0 +1,42 @@
+/**
+ * Provides classes and interfaces for picocli Spring Boot Auto-configuration.
+ * <p>
+ * The existence of this class allows Spring to auto-configure any fields of
+ * type {@code picocli.CommandLine.IFactory} in a {@code @org.springframework.stereotype.Component}-annotated class.
+ * See the example below.
+ * </p>
+ * <pre>
+ * import picocli.CommandLine;
+ * import picocli.CommandLine.IFactory;
+ *
+ * import org.springframework.boot.CommandLineRunner;
+ * import org.springframework.boot.ExitCodeGenerator;
+ * import org.springframework.stereotype.Component;
+ *
+ * &#64;Component
+ * public class MyApplicationRunner implements CommandLineRunner, ExitCodeGenerator {
+ *
+ * 	private final MyCommand myCommand;
+ *
+ * 	private final IFactory factory; // auto-configured to inject PicocliSpringFactory
+ *
+ * 	private int exitCode;
+ *
+ * 	  public MyApplicationRunner(MyCommand myCommand, IFactory factory) {
+ * 		this.myCommand = myCommand;
+ * 		this.factory = factory;
+ *    }
+ *
+ *    &#64;Override
+ *    public void run(String... args) throws Exception {
+ * 		exitCode = new CommandLine(myCommand, factory).execute(args);
+ *    }
+ *
+ *    &#64;Override
+ *    public int getExitCode() {
+ * 		return exitCode;
+ *    }
+ * }
+ * </pre>
+ */
+package picocli.spring.boot.autoconfigure;

picocli-spring-boot-starter/src/main/java/picocli/spring/package-info.java

@@ -0,0 +1,14 @@
+/**
+ * Provides classes and interfaces for integrating picocli with Spring Boot.
+ * <p>
+ * Picocli instantiates objects at initialization time, using a {@link picocli.CommandLine.IFactory}.
+ * This package provides a factory implementation that looks up objects in Spring's ApplicationContext.
+ * When picocli uses this factory to instantiate subcommands, type converters, and other
+ * picocli components, this factory will use Spring's ApplicationContext
+ * to instantiate classes that are annotated with
+ * {@code @org.springframework.stereotype.Component}.
+ * This ensures that {@code @javax.inject.Inject} or {@code @Autowired}-annotated
+ * beans in those picocli components are injected by Spring.
+ * </p>
+ */
+package picocli.spring;