Adds javadoc in Basyx.SDK project

Signed-off-by: Ashfaqul Haque <ashfaqul.haque@iese.fraunhofer.de>
Change-Id: I4048df3ee472234c52cb59869cae13d78434991d

Author: Ashfaqul Haque

pom.xml

@@ -113,6 +113,24 @@
 					</execution>
 				</executions>
 			</plugin>
+			
+			<plugin>
+                <groupId>org.apache.maven.plugins</groupId>
+                <artifactId>maven-javadoc-plugin</artifactId>
+                <version>3.2.0</version>
+                <configuration>
+      				<source>8</source>
+    			</configuration>
+                <executions>
+	                <execution>
+	                	<goals>
+	                    	<goal>javadoc</goal>
+	                    </goals>
+	                    <id>generate-javadoc</id>
+	                    <phase>package</phase>
+	                </execution>
+				</executions>
+			</plugin>
 		</plugins>
 	</build>
 

src/main/java/org/eclipse/basyx/aas/aggregator/api/IAASAggregator.java

@@ -19,7 +19,7 @@
 
 
 /**
- * Interface for the Asset Administration Shell Aggregator API <br />
+ * Interface for the Asset Administration Shell Aggregator API <br>
  * It is used to manage multiple AASs at the same endpoint
  * 
  * @author conradi

src/main/java/org/eclipse/basyx/aas/aggregator/restapi/AASAggregatorProvider.java

@@ -60,7 +60,7 @@ private String stripPrefix(String path) throws MalformedRequestException {
 	}
 
 	/**
-	 * Makes sure, that given Object is an AAS by checking its ModelType<br />
+	 * Makes sure, that given Object is an AAS by checking its ModelType<br>
 	 * Creates a new AAS with the content of the given Map
 	 * 
 	 * @param value

src/main/java/org/eclipse/basyx/aas/factory/xml/XMLToMetamodelConverter.java

@@ -92,9 +92,6 @@ public List<IAsset> parseAssets() throws ParserConfigurationException, SAXExcept
 	 * Parses the Submodels form the XML
 	 * 
 	 * @return the Submodels parsed form the XML
-	 * @throws ParserConfigurationException
-	 * @throws SAXException
-	 * @throws IOException
 	 */
 	@SuppressWarnings("unchecked")
 	public List<ISubmodel> parseSubmodels() {
@@ -107,9 +104,6 @@ public List<ISubmodel> parseSubmodels() {
 	 * Parses the ConceptDescriptions form the XML
 	 * 
 	 * @return the ConceptDescriptions parsed form the XML
-	 * @throws ParserConfigurationException
-	 * @throws SAXException
-	 * @throws IOException
 	 */
 	@SuppressWarnings("unchecked")
 	public List<IConceptDescription> parseConceptDescriptions() {

src/main/java/org/eclipse/basyx/aas/manager/ConnectedAssetAdministrationShellManager.java

@@ -32,8 +32,8 @@
 import org.eclipse.basyx.vab.protocol.http.connector.HTTPConnectorFactory;
 
 /**
- * Implement a AAS manager backend that communicates via HTTP/REST<br />
- * <br />
+ * Implement a AAS manager backend that communicates via HTTP/REST<br>
+ * <br>
  * 
  * @author kuhn, schnicke
  * 
@@ -54,8 +54,8 @@ public ConnectedAssetAdministrationShellManager(IAASRegistry directory) {
 	}
 
 	/**
-	 * @param networkDirectoryService
-	 * @param providerProvider
+	 * @param directory
+	 * @param provider
 	 */
 	public ConnectedAssetAdministrationShellManager(IAASRegistry directory,
 			IConnectorFactory provider) {

src/main/java/org/eclipse/basyx/aas/manager/api/IAssetAdministrationShellManager.java

@@ -41,7 +41,6 @@ public interface IAssetAdministrationShellManager {
 	 * Creates an AAS on a remote server
 	 * 
 	 * @param aas
-	 * @param aasId
 	 * @param endpoint
 	 */
 	void createAAS(AssetAdministrationShell aas, String endpoint);

src/main/java/org/eclipse/basyx/aas/metamodel/api/IAssetAdministrationShell.java

@@ -35,7 +35,7 @@ public interface IAssetAdministrationShell extends IElement, IIdentifiable, IHas
 	/**
 	 * Return all registered submodels of this AAS
 	 * 
-	 * @return IdShort -> ISubmodel
+	 * @return {@literal IdShort -> ISubmodel}
 	 */
 	public Map<String, ISubmodel> getSubmodels();
 
@@ -98,7 +98,7 @@ public interface IAssetAdministrationShell extends IElement, IIdentifiable, IHas
 
 
 	/**
-	 * Gets the views associated with the AAS. <br/>
+	 * Gets the views associated with the AAS. <br>
 	 * If needed stakeholder specific views can be defined on the elements of the
 	 * AAS.
 	 * 
@@ -107,7 +107,7 @@ public interface IAssetAdministrationShell extends IElement, IIdentifiable, IHas
 	public Collection<IView> getViews();
 
 	/**
-	 * Gets the concept dictionaries associated with the AAS. <br/>
+	 * Gets the concept dictionaries associated with the AAS. <br>
 	 * An AAS may have one or more concept dictionaries assigned to it. The concept
 	 * dictionaries typically contain only descriptions for elements that are also
 	 * used within the AAS (via HasSemantics).

src/main/java/org/eclipse/basyx/aas/metamodel/api/parts/IConceptDictionary.java

@@ -16,10 +16,10 @@
 import org.eclipse.basyx.submodel.metamodel.api.reference.IReference;
 
 /**
- * A dictionary contains elements that can be reused. <br />
- * <br />
- * The concept dictionary contains concept descriptions. <br />
- * <br />
+ * A dictionary contains elements that can be reused. <br>
+ * <br>
+ * The concept dictionary contains concept descriptions. <br>
+ * <br>
  * Typically a concept description dictionary of an AAS contains only concept
  * descriptions of elements used within submodels of the AAS.
  * 

src/main/java/org/eclipse/basyx/aas/metamodel/api/parts/asset/AssetKind.java

@@ -13,7 +13,7 @@
 import org.eclipse.basyx.submodel.metamodel.enumhelper.StandardizedLiteralEnumHelper;
 
 /**
- * AssetKind enum as defined by DAAS document<br />
+ * AssetKind enum as defined by DAAS document<br>
  * Enumeration for denoting whether an element is a type or an instance.
  * 
  * @author schnicke

src/main/java/org/eclipse/basyx/aas/metamodel/map/AasEnv.java

@@ -57,7 +57,7 @@ public AasEnv(Collection<IAssetAdministrationShell> aasList, Collection<IAsset>
 	/**
 	 * Creates a AssetAdministrationShell object from a map
 	 * 
-	 * @param obj
+	 * @param map
 	 *            a AssetAdministrationShell object as raw map
 	 * @return a AssetAdministrationShell object, that behaves like a facade for the
 	 *         given map