Add documentation about container related build items

Author: mcruzdev

core/deployment/src/main/java/io/quarkus/deployment/builditem/ContainerRuntimeStatusBuildItem.java

@@ -3,14 +3,45 @@
 import io.quarkus.builder.item.SimpleBuildItem;
 import io.quarkus.deployment.IsContainerRuntimeWorking;
 
+/**
+ * A build item that represents the status of a container runtime.
+ * <p>
+ * This abstract class provides a mechanism to check if a container runtime
+ * is available and caches the result for subsequent calls.
+ * </p>
+ */
 public abstract class ContainerRuntimeStatusBuildItem extends SimpleBuildItem {
+
+    /**
+     * A functional interface ({@link java.util.function.BooleanSupplier}) used to determine if the container runtime is
+     * working.
+     */
     private final IsContainerRuntimeWorking isContainerRuntimeWorking;
+
+    /**
+     * A cached status indicating whether the container runtime is available.
+     * This value is computed lazily and stored for future use.
+     */
     private volatile Boolean cachedStatus;
 
+    /**
+     * Constructs a new {@link ContainerRuntimeStatusBuildItem}.
+     *
+     * @param isContainerRuntimeWorking a functional interface to check the container runtime status
+     */
     protected ContainerRuntimeStatusBuildItem(IsContainerRuntimeWorking isContainerRuntimeWorking) {
         this.isContainerRuntimeWorking = isContainerRuntimeWorking;
     }
 
+    /**
+     * Checks if the container runtime is available.
+     * <p>
+     * This method uses the {@link IsContainerRuntimeWorking} interface to determine
+     * the runtime status and caches the result for subsequent calls.
+     * </p>
+     *
+     * @return {@code true} if the container runtime is available, {@code false} otherwise
+     */
     public boolean isContainerRuntimeAvailable() {
         if (cachedStatus == null) {
             synchronized (this) {
@@ -19,7 +50,6 @@ public boolean isContainerRuntimeAvailable() {
                 }
             }
         }
-
         return cachedStatus;
     }
-}
+}

core/deployment/src/main/java/io/quarkus/deployment/builditem/DockerStatusBuildItem.java

@@ -2,16 +2,36 @@
 
 import io.quarkus.deployment.IsDockerWorking;
 
+/**
+ * A build item that represents the status of the Docker container runtime.
+ * <p>
+ * This class extends {@link ContainerRuntimeStatusBuildItem} and provides
+ * a specific implementation for checking the availability of the Docker runtime.
+ * </p>
+ */
 public final class DockerStatusBuildItem extends ContainerRuntimeStatusBuildItem {
+
+    /**
+     * Constructs a new {@link DockerStatusBuildItem}.
+     *
+     * @param isDockerWorking a functional interface to check if the Docker runtime is working
+     */
     public DockerStatusBuildItem(IsDockerWorking isDockerWorking) {
         super(isDockerWorking);
     }
 
     /**
+     * Checks if the Docker runtime is available.
+     * <p>
+     * This method is deprecated and will be removed in a future release.
+     * Use {@link #isContainerRuntimeAvailable()} instead.
+     * </p>
+     *
+     * @return {@code true} if the Docker runtime is available, {@code false} otherwise
      * @deprecated Use {@link #isContainerRuntimeAvailable()} instead
      */
     @Deprecated(forRemoval = true)
     public boolean isDockerAvailable() {
         return isContainerRuntimeAvailable();
     }
-}
+}

core/deployment/src/main/java/io/quarkus/deployment/builditem/PodmanStatusBuildItem.java

@@ -2,8 +2,21 @@
 
 import io.quarkus.deployment.IsPodmanWorking;
 
+/**
+ * A build item that represents the status of the Podman container runtime.
+ * <p>
+ * This class extends {@link ContainerRuntimeStatusBuildItem} and provides
+ * a specific implementation for checking the availability of the Podman runtime.
+ * </p>
+ */
 public final class PodmanStatusBuildItem extends ContainerRuntimeStatusBuildItem {
+
+    /**
+     * Constructs a new {@link PodmanStatusBuildItem}.
+     *
+     * @param isPodmanWorking a functional interface to check if the Podman runtime is working
+     */
     public PodmanStatusBuildItem(IsPodmanWorking isPodmanWorking) {
         super(isPodmanWorking);
     }
-}
+}

core/deployment/src/main/java/io/quarkus/deployment/pkg/builditem/DeploymentResultBuildItem.java

@@ -5,22 +5,64 @@
 
 import io.quarkus.builder.item.SimpleBuildItem;
 
+/**
+ * A build item representing the result of a Kubernetes or OpenShift deployment process.
+ * <p>
+ * This build item encapsulates the name and labels of the main resource created or updated
+ * during deployment. It is typically produced by deployment steps and can be consumed by
+ * other build steps that need information about the deployed resource.
+ * </p>
+ *
+ * <p>
+ * The {@code name} usually refers to the primary resource (such as a Deployment, StatefulSet,
+ * or DeploymentConfig) that was applied to the cluster. The {@code labels} map contains
+ * metadata labels associated with this resource, which can be used for identification,
+ * filtering, or further processing.
+ * </p>
+ */
 public final class DeploymentResultBuildItem extends SimpleBuildItem {
 
+    /**
+     * The name of the main deployed resource (e.g., Deployment, StatefulSet, or DeploymentConfig).
+     */
     private final String name;
+
+    /**
+     * The labels associated with the deployed resource.
+     * <p>
+     * These labels provide metadata that can be used for resource selection, grouping,
+     * or integration with other tools and processes.
+     * </p>
+     */
     private final Map<String, String> labels;
 
+    /**
+     * Constructs a new {@link DeploymentResultBuildItem}.
+     *
+     * @param name the name of the main deployed resource
+     * @param labels a map of labels associated with the deployed resource
+     */
     public DeploymentResultBuildItem(String name, Map<String, String> labels) {
         this.name = name;
         this.labels = labels;
     }
 
+    /**
+     * Returns the name of the main deployed resource.
+     *
+     * @return the resource name
+     */
     public String getName() {
         return this.name;
     }
 
+    /**
+     * Returns the labels associated with the deployed resource.
+     *
+     * @return a map of resource labels
+     */
     public Map<String, String> getLabels() {
         return this.labels;
     }
 
-}
+}