From 46fca012d57b822ef0f99bd60d62da4f18c129da Mon Sep 17 00:00:00 2001
From: Foivos Zakkak <fzakkak@redhat.com>
Date: Mon, 22 Apr 2024 15:06:49 +0300
Subject: [PATCH] Add documentation to NativeImageResourceBuildItem's
 constructors

(cherry picked from commit 757537b21b8c859c075349abd706642e0e315982)
---
 .../builditem/nativeimage/NativeImageResourceBuildItem.java | 6 +++++-
 1 file changed, 5 insertions(+), 1 deletion(-)

diff --git a/core/deployment/src/main/java/io/quarkus/deployment/builditem/nativeimage/NativeImageResourceBuildItem.java b/core/deployment/src/main/java/io/quarkus/deployment/builditem/nativeimage/NativeImageResourceBuildItem.java
index 56ecff462a4d0..f58313c940ae5 100644
--- a/core/deployment/src/main/java/io/quarkus/deployment/builditem/nativeimage/NativeImageResourceBuildItem.java
+++ b/core/deployment/src/main/java/io/quarkus/deployment/builditem/nativeimage/NativeImageResourceBuildItem.java
@@ -7,7 +7,11 @@
 import io.quarkus.builder.item.MultiBuildItem;
 
 /**
- * A build item that indicates that a static resource should be included in the native image
+ * A build item that indicates that a static resource should be included in the native image.
+ * <p>
+ * A static resource is a file that is not processed by the build steps, but is included in the native image as-is.
+ * The resource path passed to the constructor is a {@code /}-separated path name (with the same semantics as the parameters
+ * passed to {@link java.lang.ClassLoader#getResources(String)}.
  * <p>
  * Related build items:
  * <ul>