[skip ci] Added missing documentation required to release

Axway-API-Management-Plus · Jun 15, 2020 · f7e19a6 · f7e19a6
1 parent 95a51d7
commit f7e19a6
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 3 deletions.
diff --git a/modules/apim-adapter/src/main/java/com/axway/apim/adapter/apis/APIManagerAPIAdapter.java b/modules/apim-adapter/src/main/java/com/axway/apim/adapter/apis/APIManagerAPIAdapter.java
@@ -239,8 +239,7 @@ public <profile> void translateMethodIds(API api, String apiId, METHOD_TRANSLATI
 
 	/**
 	 * Translates the methodIds of the given api. The operations are loaded from the API-Manager based on the api.getId()
-	 * @param <profile> An Outbound- or InboundProfile
-	 * @param apis in which the methods should be translated
+	 * @param api in which the methods should be translated
 	 * @param mode translation direction 
 	 * @throws AppException if methods cannot be translated
 	 */

diff --git a/modules/apim-adapter/src/main/java/com/axway/apim/adapter/clientApps/ClientAppAdapter.java b/modules/apim-adapter/src/main/java/com/axway/apim/adapter/clientApps/ClientAppAdapter.java
@@ -20,7 +20,6 @@ protected ClientAppAdapter() {
 
 	/**
 	 * Returns a list of application according to the provided filter
-	 * @param filter object to filter the results
 	 * @return applications according to the provided filter
 	 * @throws AppException when something goes wrong
 	 */

diff --git a/modules/apim-adapter/src/main/java/com/axway/apim/api/API.java b/modules/apim-adapter/src/main/java/com/axway/apim/api/API.java
@@ -238,6 +238,8 @@ public void setState(String state) {
 	 * the API-Manager internally doesn't. In API-Manager deprecation is just a true/false toggle.
 	 * To make Desired and Actual API comparable this method is encapsulating the difference. 
 	 * @see com.axway.apim.api.API#getState()
+	 * @return the state of the API (unpublished, deprecated, etc.)
+	 * @throws AppException in case of an error
 	 */
 	public String getState() throws AppException {
 		if(this.deprecated!=null 

diff --git a/modules/apim-adapter/src/main/java/com/axway/apim/api/state/APIChangeState.java b/modules/apim-adapter/src/main/java/com/axway/apim/api/state/APIChangeState.java
@@ -130,6 +130,10 @@ public static void copyChangedProps(API desiredAPI, API createdAPI, List<String>
 
 	/**
 	 * Copied all changed properties of the API having APIPropertyAnnotation set to copyProp = true (default)
+	 * @sourceAPI copy the properties from this source API
+	 * @targetAPI copy the properties into this target API
+	 * @propsToCopy the list of API properties to copy
+	 * @logMessage controls if a log message is created which properties are copied
 	 * @throws AppException if something goes wrong
 	 */
 	public static void copyProps(API sourceAPI, API targetAPI, List<String> propsToCopy, boolean logMessage) throws AppException {