From f94eee3fc37ea9800543b9ea7f04cd355efccf11 Mon Sep 17 00:00:00 2001
From: Alexey Semenyuk <alexey.semenyuk@oracle.com>
Date: Mon, 21 Oct 2024 11:50:52 -0400
Subject: [PATCH] Update javadoc

---
 .../share/classes/jdk/jpackage/internal/Package.java  | 11 ++++++++++-
 .../share/classes/jdk/jpackage/internal/Workshop.java |  7 ++++---
 2 files changed, 14 insertions(+), 4 deletions(-)

diff --git a/src/jdk.jpackage/share/classes/jdk/jpackage/internal/Package.java b/src/jdk.jpackage/share/classes/jdk/jpackage/internal/Package.java
index f187680a8447a..f22def824f30b 100644
--- a/src/jdk.jpackage/share/classes/jdk/jpackage/internal/Package.java
+++ b/src/jdk.jpackage/share/classes/jdk/jpackage/internal/Package.java
@@ -87,10 +87,16 @@ default StandardPackageType asStandardPackageType() {
 
     Path predefinedAppImage();
 
+    /**
+     * Returns source app image layout.
+     */
     default ApplicationLayout appLayout() {
         return app().appLayout();
     }
 
+    /**
+     * Returns app image layout inside of the package.
+     */
     default ApplicationLayout packageLayout() {
         var layout = appLayout();
         var pathGroup = layout.pathGroup();
@@ -103,6 +109,9 @@ default ApplicationLayout packageLayout() {
         return layout;
     }
 
+    /**
+     * Returns app image layout of the installed package.
+     */
     default ApplicationLayout installedPackageLayout() {
         Path root = relativeInstallDir();
         if (type() instanceof StandardPackageType type) {
@@ -247,7 +256,7 @@ public Path predefinedAppImage() {
         public Path configuredInstallBaseDir() {
             throw new UnsupportedOperationException();
         }
-        
+
     }
 
     static class Proxy<T extends Package> extends ProxyBase<T> implements Package {
diff --git a/src/jdk.jpackage/share/classes/jdk/jpackage/internal/Workshop.java b/src/jdk.jpackage/share/classes/jdk/jpackage/internal/Workshop.java
index 86932da965666..983e52db01788 100644
--- a/src/jdk.jpackage/share/classes/jdk/jpackage/internal/Workshop.java
+++ b/src/jdk.jpackage/share/classes/jdk/jpackage/internal/Workshop.java
@@ -33,9 +33,10 @@ interface Workshop {
     Path resourceDir();
 
     /**
-     * Returns path to application image directory. When building app image this is the path to a
-     * directory where it is assembled. When building a package this is the path to the source app
-     * image.
+     * Returns path to application image directory.
+     *
+     * The return value is supposed to be used as a parameter for
+     * ApplicationLayout#resolveAt function.
      */
     default Path appImageDir() {
         return buildRoot().resolve("image");