[EAK-504] Apply JS doc corrections

Co-authored-by: Dmytro Shovchko <[email protected]>
exadel-inc · Jan 24, 2024 · 2ded0e6 · 2ded0e6
1 parent 1aefa8c
commit 2ded0e6
Show file tree

Hide file tree

Showing 4 changed files with 8 additions and 8 deletions.
diff --git a/core/src/main/java/com/exadel/aem/toolkit/api/annotations/policies/MaxChildren.java b/core/src/main/java/com/exadel/aem/toolkit/api/annotations/policies/MaxChildren.java
@@ -28,8 +28,8 @@
     long value();
 
     /**
-     * Used to specify target node for max children limit. If set to {@link PolicyTarget#CURRENT} the limitation applies
-     * to the current annotated component. Otherwise, the limitation is applied to a container nested within the current
+     * Used to specify target node for max children limit. The limitation applies to the current annotated component
+     * if set to {@link PolicyTarget#CURRENT}. Otherwise, the limitation is applied to a container nested within the current
      * component. E.g. if the current component is an inheritor of parsys, setting {@code targetContainer} to {@link
      * PolicyTarget#CURRENT} means that the limitation affects which components can be added to the current
      * one. But if the current component contains a parsys inside you need to skip {@code targetContainer} or set it to

diff --git a/core/src/main/java/com/exadel/aem/toolkit/api/annotations/policies/PolicyTarget.java b/core/src/main/java/com/exadel/aem/toolkit/api/annotations/policies/PolicyTarget.java
@@ -14,7 +14,7 @@
 package com.exadel.aem.toolkit.api.annotations.policies;
 
 /**
- * Defines possible values of {@link AllowedChildren#targetContainer()} and {@link MaxChildren#targetContainer()} property
+ * Defines possible values of {@link AllowedChildren#targetContainer()} and {@link MaxChildren#targetContainer()} properties
  */
 public enum PolicyTarget {
     CHILD,

diff --git a/ui.apps/src/main/content/jcr_root/apps/etoolbox-authoring-kit/policies/js/maxChildren.js b/ui.apps/src/main/content/jcr_root/apps/etoolbox-authoring-kit/policies/js/maxChildren.js
@@ -13,7 +13,7 @@
  */
 
 /**
- * Utility that disables insertion, drag/drop and copy/paste actions for container component
+ * Utility that disables insertion, drag/drop, and copy/paste actions for container component
  * if there are more child components inserted than the {@link MaxChildrenLimiter.LIMIT_RESOLVER_NAME} listener returns or
  * defined by {@link MaxChildrenLimiter.LIMIT_RESOLVER_PROPERTY} in policies or designs.
  */
@@ -42,7 +42,7 @@
 
     /**
      * Resolves max children limit for the given editable using {@link LIMIT_RESOLVER_NAME} listener.
-     * If listener does not exist or return a number, then {@link resolveChildrenLimitFromPolicy} is used.
+     * If a listener does not exist or return a number, then {@link resolveChildrenLimitFromPolicy} is used.
      * @param editable
      * @returns {number} - max children for the given editable
      */
@@ -72,7 +72,7 @@
     };
 
     /**
-     * Checks if editable contains equal or less children than defined in 'childrenLimit' property
+     * Checks if editable contains equal or fewer children than defined in 'childrenLimit' property
      * @param editable
      * @returns {boolean} true if children limit is reached
      */

diff --git a/ui.apps/src/main/content/jcr_root/apps/etoolbox-authoring-kit/utils/js/utils.js b/ui.apps/src/main/content/jcr_root/apps/etoolbox-authoring-kit/utils/js/utils.js
@@ -15,7 +15,7 @@
     'use strict';
 
     /**
-     * Wrap the given function with the provided wrapper. Do not wrap twice.
+     * Wraps the given function with the provided wrapper. Does not wrap twice.
      * @param {function} fn
      * @param {function} wrapper
      * @returns {function} - wrapped function
@@ -36,7 +36,7 @@
     }
 
     /**
-     * Execute listener for the given editable
+     * Executes listener for the given editable
      * @param {Editable} editable
      * @param {string} name
      * @param {Array} params