Improve javdoc

markusweigelt · Jan 9, 2024 · 14abde2 · 14abde2
1 parent 0ba9b31
commit 14abde2
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 5 deletions.
diff --git a/Kitodo/src/main/java/org/kitodo/production/forms/dataeditor/GalleryPanel.java b/Kitodo/src/main/java/org/kitodo/production/forms/dataeditor/GalleryPanel.java
@@ -1032,7 +1032,7 @@ public boolean hasMediaViewMimeTypePrefix(String mimeTypePrefix) {
     /**
      * Get the media partials panel.
      *
-     * @return The media partials
+     * @return The media partials panel
      */
     public MediaPartialsPanel getMediaPartialsPanel() {
         return mediaPartialsPanel;

diff --git a/Kitodo/src/main/java/org/kitodo/production/forms/dataeditor/MediaPartialForm.java b/Kitodo/src/main/java/org/kitodo/production/forms/dataeditor/MediaPartialForm.java
@@ -53,7 +53,7 @@ public boolean isEditable() {
     }
 
     /**
-     * Clean the media view division.
+     * Clean the form.
      */
     public void clean() {
         mediaPartialDivision = null;
@@ -82,7 +82,7 @@ public boolean hasValidationError() {
     }
 
     /**
-     * Save the media view.
+     * Save the media partial.
      */
     public void save() {
         if (!valid()) {

diff --git a/Kitodo/src/main/java/org/kitodo/production/forms/dataeditor/MediaPartialsPanel.java b/Kitodo/src/main/java/org/kitodo/production/forms/dataeditor/MediaPartialsPanel.java
@@ -147,9 +147,9 @@ public boolean isEnabled() {
     }
 
     /**
-     * Get the child divisions of use "mediaPartial" of the current selection.
+     * Retrieve the child divisions with use 'mediaPartial' from the current selection.
      *
-     * @return The divisions as selected items list
+     * @return The child divisions as selected items list
      */
     public List<SelectItem> getMediaPartialChildDivisionsOfSelection() {
         List<SelectItem> mediaPartialDivisions = new ArrayList<>();