update java doc params

Author: wildone

aemdesign-aem-services/src/main/java/design/aem/models/v2/common/Timing.java

@@ -219,7 +219,9 @@ private static String shortForm(String str) {
         }
 
         /**
-         * Remove chars up to separator in this.input, and return result
+         * Remove chars up to separator in this.input, and return result.
+         * @param separator separator to stop at
+         * @return string up to separator
          */
         private String scan(char separator) {
             final StringBuilder sb = new StringBuilder();

aemdesign-aem-services/src/main/java/design/aem/models/v2/content/Download.java

@@ -224,7 +224,7 @@ private String getFormattedDownloadSize(com.day.cq.wcm.foundation.Download dld)
 
     /**
      * Determine the filetype by extracting and uppercasing the last element of the mimetype
-     *
+     * @param resolver resource resolver instance
      * @param download is the download to do this for
      * @return the filetype for the download
      */

aemdesign-aem-services/src/main/java/design/aem/models/v2/lists/AssetList.java

@@ -185,6 +185,7 @@ private void populateDescendantsListItems() {
 
     /**
      * populate list items from children of a root page.
+     * @param path path to use
      * @param flat only select children on root page
      */
     @SuppressWarnings("Duplicates")

aemdesign-aem-services/src/main/java/design/aem/models/v2/lists/List.java

@@ -327,15 +327,15 @@ private void generateId() {
     /**
      * get request parameter with component id prefix.
      * @param name name of querystring param suffix
-     * @return
+     * @return parameter value
      */
     private String getParameter(String name) {
         return getRequest().getParameter(id + PATH_UNDERSCORE + name);
     }
 
     /**
      * get next page url.
-     * @return
+     * @return next page url
      */
     private String getNextPageLink() {
         long nextPageStart = pageStart + pageMax;
@@ -350,7 +350,7 @@ private String getNextPageLink() {
 
     /**
      * get previous page url.
-     * @return
+     * @return previous page url
      */
     private String getPreviousPageLink() {
         if (isPaginating && pageMax > 0 && resultPages.size() > 0 && pageStart != 0) {
@@ -365,8 +365,8 @@ private String getPreviousPageLink() {
 
     /**
      * get page badge info from a page.
-     * @param page
-     * @return
+     * @param page page to use
+     * @return map of badge attributes
      */
     private Map<String,Object> getPageBadgeInfo(Page page) {
         return getPageBadgeInfo(page,detailsNameSuffix,getResourceResolver(),detailsBadge);
@@ -378,7 +378,7 @@ private Map<String,Object> getPageBadgeInfo(Page page) {
      * @param detailsNameSuffix details siffix to look for
      * @param resourceResolver resource resolver to use
      * @param detailsBadge badge selectors to add
-     * @return
+     * @return map of page badge attributes
      */
     static Map<String,Object> getPageBadgeInfo(Page page,String[] detailsNameSuffix, ResourceResolver resourceResolver, String detailsBadge) {
 
@@ -527,7 +527,7 @@ private void updateListSplit() {
      * @param page page to check
      * @param includeInvalid include if page is invalid
      * @param includeHidden include in page is hidden
-     * @return
+     * @return boolean if page should be included in the list
      */
     static boolean includePageInList(Page page, boolean includeInvalid, boolean includeHidden) {
         return (includeHidden || !page.isHideInNav()) && (includeInvalid || page.isValid()) && page.getDeleted() == null;
@@ -584,6 +584,7 @@ private void populateDescendantsListItems() {
 
     /**
      * populate list items from children of a root page.
+     * @param path path to use
      * @param flat only select children on root page
      */
     private void populateChildListItems(String path, Boolean flat) {

aemdesign-aem-services/src/main/java/design/aem/models/v2/lists/ListNav.java

@@ -202,6 +202,7 @@ private void populateDescendantsListItems() {
 
     /**
      * populate list items from children of a root page.
+     * @param path path to use
      * @param flat only select children on root page
      */
     @SuppressWarnings("Duplicates")

aemdesign-aem-services/src/main/java/design/aem/models/v2/lists/NavList.java

@@ -87,8 +87,8 @@ protected void ready() {
 
     /***
      * return path before /JCR:CONTENT
-     * @param slingRequest
-     * @return
+     * @param slingRequest sling request instance
+     * @return path
      */
 
     private String getPrimaryPath(SlingHttpServletRequest slingRequest) {

aemdesign-aem-services/src/main/java/design/aem/models/v2/lists/TagList.java

@@ -173,6 +173,7 @@ private void populateDescendantsListItems() {
 
     /**
      * populate list items from children of a root page.
+     * @param path path to use
      * @param flat only select children on root page
      */
     @SuppressWarnings("Duplicates")

aemdesign-aem-services/src/main/java/design/aem/utils/components/ContentFragmentUtil.java

@@ -23,6 +23,7 @@ public class ContentFragmentUtil {
      * get content fragment content in an ordered map
      * @param contentFragmentPath path to content fragment
      * @param variationName variation of content fragment
+     * @param resourceResolver resource resolver to use
      * @return ordered map of key value fields
      */
     @SuppressWarnings("squid:S3776")