Fix javadoc warnings

DEVSIX-4161

Author: BlackEgoist

forms/src/main/java/com/itextpdf/forms/xfdf/ActionObject.java

@@ -102,6 +102,8 @@ public ActionObject(PdfName type) {
     /**
      * Returns the type of inner action element. Possible values: {@link PdfName#URI}, {@link PdfName#Launch},
      * {@link PdfName#GoTo}, {@link PdfName#GoToR}, {@link PdfName#Named}.
+     *
+     * @return {@link PdfName} type of inner action element
      */
     public PdfName getType() {
         return type;
@@ -110,6 +112,9 @@ public PdfName getType() {
     /**
      * Sets the type of inner action element. Possible values: {@link PdfName#URI}, {@link PdfName#Launch},
      * {@link PdfName#GoTo}, {@link PdfName#GoToR}, {@link PdfName#Named}.
+     *
+     * @param type {@link PdfName} type of inner action object
+     * @return current {@link ActionObject}
      */
     public ActionObject setType(PdfName type) {
         this.type = type;
@@ -119,14 +124,19 @@ public ActionObject setType(PdfName type) {
     /**
      * Gets the string value of URI elements. Corresponds to Name, required attribute of URI element.
      * For more details see paragraph 6.5.30 in Xfdf specification.
+     *
+     * @return {@link PdfString} value of URI element
      */
     public PdfString getUri() {
         return uri;
     }
 
     /**
-     * Sets the string value of URI elements. Corresponds to Name, required attribute of URI element.
+     * Sets the string value of URI element. Corresponds to Name, required attribute of URI element.
      * For more details see paragraph 6.5.30 in Xfdf specification.
+     *
+     * @param uri {@link PdfString} value to be set to URI element
+     * @return current {@link ActionObject}
      */
     public ActionObject setUri(PdfString uri) {
         this.uri = uri;
@@ -135,13 +145,18 @@ public ActionObject setUri(PdfString uri) {
 
     /**
      * Gets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
+     *
+     * @return boolean indicating if URI element is a map
      */
     public boolean isMap() {
         return isMap;
     }
 
     /**
      * Sets IsMap, optional attribute of URI element. For more details see paragraph 6.5.30 in Xfdf specification.
+     *
+     * @param map boolean indicating if URI element is a map
+     * @return current {@link ActionObject}
      */
     public ActionObject setMap(boolean map) {
         isMap = map;
@@ -150,13 +165,18 @@ public ActionObject setMap(boolean map) {
 
     /**
      * Gets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
+     *
+     * @return {@link PdfName} value of Name attribute of a named action element
      */
     public PdfName getNameAction() {
         return nameAction;
     }
 
     /**
      * Sets the value of Name, required attribute of Named element. For more details see paragraph 6.5.24 in Xfdf specification.
+     *
+     * @param nameAction {@link PdfName} value to be set to Name attribute of a named action element
+     * @return current {@link ActionObject}
      */
     public ActionObject setNameAction(PdfName nameAction) {
         this.nameAction = nameAction;
@@ -167,6 +187,8 @@ public ActionObject setNameAction(PdfName nameAction) {
      * Gets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
      * Corresponds to F key in go-to action or launch dictionaries.
      * For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
+     *
+     * @return {@link String} value of OriginalName attribute of current action object
      */
     public String getFileOriginalName() {
         return fileOriginalName;
@@ -176,21 +198,29 @@ public String getFileOriginalName() {
      * Sets the string value of OriginalName, required attribute of File inner element of GoToR or Launch element.
      * Corresponds to F key in go-to action or launch dictionaries.
      * For more details see paragraphs 6.5.11, 6.5.23 in Xfdf specification.
+     *
+     * @param fileOriginalName {@link String} value of OriginalName attribute of action object
+     * @return current {@link ActionObject}
      */
     public ActionObject setFileOriginalName(String fileOriginalName) {
         this.fileOriginalName = fileOriginalName;
         return this;
     }
 
     /**
-     * Sets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
+     * Gets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
+     *
+     * @return boolean indicating if current Launch action element should be opened in a new window
      */
     public boolean isNewWindow() {
         return isNewWindow;
     }
 
     /**
-     * Gets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
+     * Sets the boolean value of NewWindow, optional attribute of Launch element. For more details see paragraph 6.5.23 in Xfdf specification.
+     *
+     * @param newWindow boolean indicating if current Launch action element should be opened in a new window
+     * @return current {@link ActionObject}
      */
     public ActionObject setNewWindow(boolean newWindow) {
         isNewWindow = newWindow;
@@ -201,6 +231,8 @@ public ActionObject setNewWindow(boolean newWindow) {
      * Gets Dest, inner element of link, GoTo, and GoToR elements.
      * Corresponds to Dest key in link annotation dictionary.
      * For more details see paragraph 6.5.10 in Xfdf specification.
+     *
+     * @return {@link DestObject} destination attribute of current action element
      */
     public DestObject getDestination() {
         return destination;
@@ -210,6 +242,9 @@ public DestObject getDestination() {
      * Sets Dest, inner element of link, GoTo, and GoToR elements.
      * Corresponds to Dest key in link annotation dictionary.
      * For more details see paragraph 6.5.10 in Xfdf specification.
+     *
+     * @param destination {@link DestObject} destination attribute of the action element
+     * @return current {@link ActionObject}
      */
     public ActionObject setDestination(DestObject destination) {
         this.destination = destination;