Add missing JavaDoc

kitodo · Sep 16, 2024 · 580ab16 · 580ab16
1 parent 292c903
commit 580ab16
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 2 deletions.
diff --git a/Kitodo/src/main/java/org/kitodo/production/forms/dataeditor/StructurePanel.java b/Kitodo/src/main/java/org/kitodo/production/forms/dataeditor/StructurePanel.java
@@ -601,8 +601,10 @@ private String buildPageRangeFromLogicalDivision(LogicalDivision structure) {
     /**
      * Build a StructureTreeNode for a logical division, which is then visualized in the logical structure tree.
      *
-     * @param structure the logical division
-     * @return the StructureTreeNode instance
+     * @param structure the logical division for which the tree node is being constructed
+     * @param idTypeMap the mapping of process id to basetype
+     * @param viewCache a cache for storing and retrieving already processed StructuralElementViews
+     * @return the constructed {@link StructureTreeNode} instance representing the given logical division
      */
     private StructureTreeNode buildStructureTreeNode(LogicalDivision structure,  Map<Integer, String> idTypeMap,
                                                      Map<String, StructuralElementViewInterface> viewCache) {
@@ -640,6 +642,7 @@ private StructureTreeNode buildStructureTreeNode(LogicalDivision structure,  Map
      * @param structure the current logical structure
      * @param result the current corresponding primefaces tree node
      * @param processTypeMap the mapping of process id to basetype
+     * @param viewCache a cache for storing and retrieving already processed StructuralElementViews
      * @return a collection of views that contains all views of the full sub-tree
      */
     private Collection<View> buildStructureTreeRecursively(LogicalDivision structure, TreeNode result, Map<Integer,

diff --git a/Kitodo/src/main/java/org/kitodo/production/services/data/ProcessService.java b/Kitodo/src/main/java/org/kitodo/production/services/data/ProcessService.java
@@ -1730,6 +1730,13 @@ public String getBaseType(int processId) throws DataException {
         return "";
     }
 
+    /**
+     * Retrieves a mapping of process IDs to their corresponding base types.
+     *
+     * @param processIds
+     *            list of document IDs to retrieve and process.
+     * @return a map where the keys are document IDs and the values are their associated base types
+     */
     public Map<Integer, String> getIdBaseTypeMap(List<Integer> processIds) throws DataException {
         return fetchIdToBaseTypeMap(processIds);
     }