Adds javadoc plugin in components project
Signed-off-by: Ashfaqul Haque <ashfaqul.haque@iese.fraunhofer.de>
Change-Id: Ief6553e33a839f2855e34aed9f9badab2f3812a2
diff --git a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/executable/AASServerExecutable.java b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/executable/AASServerExecutable.java
index 58527c2..172fe74 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/executable/AASServerExecutable.java
+++ b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/executable/AASServerExecutable.java
@@ -22,12 +22,11 @@
/**
* Starts an HTTP server that is able to receive AAS and submodels pushed from
- * remote <br />
+ * remote <br>
* They are made available at
* <i>localhost:4000/aasServer/shells/${aasId}/aas</i>. Submodels are available
* at
- * <i>localhost:4000/aasServer/shells/${aasId}/submodels/${submodelId}/submodel</i><br
- * />
+ * <i>localhost:4000/aasServer/shells/${aasId}/submodels/${submodelId}/submodel</i><br>
*
* @author schnicke, espen
*/
diff --git a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mongodb/MongoDBAASAPI.java b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mongodb/MongoDBAASAPI.java
index 6ae87c1..dfc61dc 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mongodb/MongoDBAASAPI.java
+++ b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mongodb/MongoDBAASAPI.java
@@ -49,7 +49,7 @@
/**
* Receives the path of the configuration.properties file in it's constructor.
*
- * @param configFilePath
+ * @param config
*/
public MongoDBAASAPI(BaSyxMongoDBConfiguration config, String aasId) {
this.setConfiguration(config);
@@ -84,7 +84,7 @@
* Sets the aas id, so that this API points to the aas with aasId. Can be changed
* to point to a different aas in the database.
*
- * @param smId
+ * @param aasId
*/
public void setAASId(String aasId) {
this.aasId = aasId;
@@ -94,7 +94,7 @@
* Depending on whether the model is already in the db, this method inserts or replaces the existing data.
* The new aas id for this API is taken from the given aas.
*
- * @param sm
+ * @param aas
*/
public void setAAS(AssetAdministrationShell aas) {
String id = aas.getIdentification().getId();
diff --git a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mongodb/MongoDBAASAggregator.java b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mongodb/MongoDBAASAggregator.java
index 4d3ead9..cbe9929 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mongodb/MongoDBAASAggregator.java
+++ b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mongodb/MongoDBAASAggregator.java
@@ -89,7 +89,7 @@
/**
* Receives the path of the configuration.properties file in it's constructor.
*
- * @param configFilePath
+ * @param config
*/
public MongoDBAASAggregator(BaSyxMongoDBConfiguration config) {
this.setConfiguration(config);
diff --git a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mongodb/MongoDBSubmodelAPI.java b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mongodb/MongoDBSubmodelAPI.java
index bdc4b53..dce0578 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mongodb/MongoDBSubmodelAPI.java
+++ b/components/basys.components/basyx.components.docker/basyx.components.AASServer/src/main/java/org/eclipse/basyx/components/aas/mongodb/MongoDBSubmodelAPI.java
@@ -61,7 +61,7 @@
/**
* Receives the path of the configuration.properties file in it's constructor.
*
- * @param configFilePath
+ * @param config
*/
public MongoDBSubmodelAPI(BaSyxMongoDBConfiguration config, String smId) {
this.setConfiguration(config);
diff --git a/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/java/org/eclipse/basyx/components/registry/mongodb/MongoDBRegistryHandler.java b/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/java/org/eclipse/basyx/components/registry/mongodb/MongoDBRegistryHandler.java
index acb080e..cc75480 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/java/org/eclipse/basyx/components/registry/mongodb/MongoDBRegistryHandler.java
+++ b/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/java/org/eclipse/basyx/components/registry/mongodb/MongoDBRegistryHandler.java
@@ -45,7 +45,7 @@
/**
* Receives the path of the configuration.properties file in it's constructor.
*
- * @param configFilePath
+ * @param config
*/
public MongoDBRegistryHandler(BaSyxMongoDBConfiguration config) {
this.setConfiguration(config);
diff --git a/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/java/org/eclipse/basyx/components/registry/sql/AASDescriptorMap.java b/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/java/org/eclipse/basyx/components/registry/sql/AASDescriptorMap.java
index 87cfc7e..e8d1e21 100644
--- a/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/java/org/eclipse/basyx/components/registry/sql/AASDescriptorMap.java
+++ b/components/basys.components/basyx.components.docker/basyx.components.registry/src/main/java/org/eclipse/basyx/components/registry/sql/AASDescriptorMap.java
@@ -17,8 +17,8 @@
import org.eclipse.basyx.aas.metamodel.map.descriptor.AASDescriptor;
/**
- * This is a map implementation for a <String, AASDescriptor> map which is needed
- * by map registries. It is based on an arbitrary <String, Object> map and provides a proxy
+ * This is a map implementation for a {@literal <String, AASDescriptor>} map which is needed
+ * by map registries. It is based on an arbitrary {@literal <String, Object>} map and provides a proxy
* access to that map by assuming AASDescriptor entries.
*
* @author espen
diff --git a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/configuration/BaSyxConfiguration.java b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/configuration/BaSyxConfiguration.java
index 08ae715..b97ad28 100644
--- a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/configuration/BaSyxConfiguration.java
+++ b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/configuration/BaSyxConfiguration.java
@@ -66,7 +66,7 @@
/**
* Load the configuration from a path relative to the current folder
*
- * @param filePath Path to the resource in the application folder
+ * @param fileKey key where the file path to the resource in the application folder
*/
public void loadFileOrDefaultResource(String fileKey, String defaultResource) {
// Try to load property that points to the configuration file (e.g. java -DfileKey=yx.properties [...])
diff --git a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/configuration/BaSyxMongoDBConfiguration.java b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/configuration/BaSyxMongoDBConfiguration.java
index a0e0136..2ef39d3 100644
--- a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/configuration/BaSyxMongoDBConfiguration.java
+++ b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/configuration/BaSyxMongoDBConfiguration.java
@@ -107,8 +107,7 @@
*
* @param connectionUrl Connection-URL for the mongodb
* @param database The database that shall be used
- * @param aasCollection Collection name for the AAS data
- * @param submodelCollection Collection name for the submodel data
+ * @param registryCollection collection of the registry
*/
public BaSyxMongoDBConfiguration(String connectionUrl, String database, String registryCollection) {
this();
diff --git a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/configuration/builder/BaSyxConfigurationBuilder.java b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/configuration/builder/BaSyxConfigurationBuilder.java
index 60e35fa..5cf25f7 100644
--- a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/configuration/builder/BaSyxConfigurationBuilder.java
+++ b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/configuration/builder/BaSyxConfigurationBuilder.java
@@ -43,7 +43,7 @@
/**
* End configuration
*
- * This base implementation invokes the <<<>>> operation of the configured component if configured
+ * This base implementation invokes the {@literal <<<>>>} operation of the configured component if configured
* component is not null. Only set the configured component for the top level builder, not for
* nested builders.
*/
diff --git a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/device/IBaSysNativeDeviceStatus.java b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/device/IBaSysNativeDeviceStatus.java
index 3734c51..5c6703e 100644
--- a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/device/IBaSysNativeDeviceStatus.java
+++ b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/device/IBaSysNativeDeviceStatus.java
@@ -22,7 +22,7 @@
* or they may be called synchronously as response to signals to the device.
*
* It resembles the following basic state machine
- * OFF --(deviceInitialized)--> IDLE --(serviceRunning)--> RUNNING --(serviceCompleted)--> COMPLETE --(resetCompleted)--> IDLE
+ * OFF --(deviceInitialized){@literal -->} IDLE --(serviceRunning){@literal -->} RUNNING --(serviceCompleted){@literal -->} COMPLETE --(resetCompleted){@literal -->} IDLE
*
* @author kuhn
*
diff --git a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/json/JSONAASBundleFactory.java b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/json/JSONAASBundleFactory.java
index bd9ae1d..d333952 100644
--- a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/json/JSONAASBundleFactory.java
+++ b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/json/JSONAASBundleFactory.java
@@ -32,7 +32,7 @@
/**
* Creates multiple {@link AASBundle} from a JSON containing several AAS and
- * Submodels <br />
+ * Submodels <br>
* TODO: ConceptDescriptions
*
* @author espen
diff --git a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/tools/propertyfile/opdef/ResultFilter.java b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/tools/propertyfile/opdef/ResultFilter.java
index 38d1851..75aecdd 100644
--- a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/tools/propertyfile/opdef/ResultFilter.java
+++ b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/tools/propertyfile/opdef/ResultFilter.java
@@ -37,7 +37,7 @@
/**
* Extract a column from a SQL result set and return this column as set
*
- * @param result SQL result
+ * @param sqlResult SQL result
* @param columnName Name of column to extract
*/
public static Set<String> stringSet(ResultSet sqlResult, Object... columnName) {
@@ -59,7 +59,7 @@
/**
* Extract a column from a SQL result set and return this column as collection
*
- * @param result SQL result
+ * @param sqlResult SQL result
* @param columnName Name of column to extract
*/
public static Object stringArray(ResultSet sqlResult, Object... columnName) {
@@ -81,8 +81,8 @@
/**
* Return SQL result set as Map
*
- * @param result SQL result
- * @param columnName Name of column to extract
+ * @param sqlResult SQL result
+ * @param columnNames Name of column to extract
*/
public static Object mapArray(ResultSet sqlResult, Object... columnNames) {
// Create result
@@ -108,8 +108,8 @@
/**
* Return SQL result set as List of Maps
*
- * @param result SQL result
- * @param columnName Name of column to extract
+ * @param sqlResult SQL result
+ * @param columnNames Name of column to extract
*/
public static Object listOfMaps(ResultSet sqlResult, Object... columnNames) {
// Create result
diff --git a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/xml/XMLAASBundleFactory.java b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/xml/XMLAASBundleFactory.java
index 751dea4..c41ce34 100644
--- a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/xml/XMLAASBundleFactory.java
+++ b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/components/xml/XMLAASBundleFactory.java
@@ -36,7 +36,7 @@
/**
* Creates multiple {@link AASBundle} from an XML containing several AAS and
- * Submodels <br />
+ * Submodels <br>
* TODO: ConceptDescriptions
*
* @author schnicke
diff --git a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/tools/sqlproxy/SQLProxy.java b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/tools/sqlproxy/SQLProxy.java
index f517e36..f528718 100644
--- a/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/tools/sqlproxy/SQLProxy.java
+++ b/components/basys.components/basyx.components.lib/src/main/java/org/eclipse/basyx/tools/sqlproxy/SQLProxy.java
@@ -43,7 +43,7 @@
*
* @param driver SQL Driver to connect with the database
* @param tableID ID of table for this map in database
- * @param rootTableID ID of root table in database
+ * @param rootElement ID of root element in database
*/
public SQLProxy(ISQLDriver driver, String tableID, SQLRootElement rootElement) {
// Invoke base constructor
@@ -118,7 +118,6 @@
/**
* Insert an object into the data base
*
- * @param drv JDBC driver to be used
* @param collectionName Name of collection
* @param sqlCollectionElement Collection element
*/
@@ -154,7 +153,7 @@
* Insert a collection of SQLMapElements into the database
*
* @param mapName Name of map
- * @param sqlMapElement Map element
+ * @param values row values
*/
protected void addToMapMultiple(String mapName, Collection<SQLTableRow> values) {
// Execute operation
@@ -167,7 +166,7 @@
*
* @param drv JDBC driver to be used
* @param mapName Name of map
- * @param sqlMapElement Map element
+ * @param values row values
*/
protected void addToMapMultiple(ISQLDriver drv, String mapName, Collection<SQLTableRow> values) {
// Build value variables for SQL insert string
@@ -273,7 +272,7 @@
* Get an entry from data base table
*
* @param mapName Name of map
- * @param sqlMapElement Map element
+ * @param key
*/
protected Object getValueFromMap(String mapName, String key) {
return getValueFromMap(getDriver(), mapName, key);
@@ -285,7 +284,7 @@
*
* @param drv JDBC driver to be used
* @param mapName Name of map
- * @param sqlMapElement Map element
+ * @param key
*/
protected Object getValueFromMap(ISQLDriver drv, String mapName, String key) {
// SQL query string
@@ -313,9 +312,8 @@
/**
* Get an entry from data base table
*
- * @param drv JDBC driver to be used
* @param mapName Name of map
- * @param sqlMapElement Map element
+ * @param key
*/
protected Object getMapRowRaw(String mapName, String key) {
return getMapRowRaw(getDriver(), mapName, key);
@@ -327,7 +325,7 @@
*
* @param drv JDBC driver to be used
* @param mapName Name of map
- * @param sqlMapElement Map element
+ * @param key
*/
protected Object getMapRowRaw(ISQLDriver drv, String mapName, String key) {
// SQL query string
@@ -347,7 +345,6 @@
/**
* Get a column from data base table as set
*
- * @param drv JDBC driver to be used
* @param mapName Name of map
* @param columnName Table column name
*/
@@ -380,7 +377,7 @@
* Get a column from data base table as array of maps
*
* @param mapName Name of map
- * @param columnName Table column name
+ * @param columnNames Table column names
*/
protected Object getMapColumnRaw(String mapName, String... columnNames) {
return getMapColumnRaw(getDriver(), mapName, columnNames);
@@ -392,7 +389,7 @@
*
* @param drv JDBC driver to be used
* @param mapName Name of map
- * @param columnName Table column name
+ * @param columnNames Table column names
*/
protected Object getMapColumnRaw(ISQLDriver drv, String mapName, String... columnNames) {
// Builder for ID list
diff --git a/components/basys.components/pom.xml b/components/basys.components/pom.xml
index 6bc6bf7..44e6ac8 100644
--- a/components/basys.components/pom.xml
+++ b/components/basys.components/pom.xml
@@ -101,6 +101,26 @@
</plugin>
</plugins>
</pluginManagement>
+
+ <plugins>
+ <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>
<!-- Every submodule depends on these dependencies -->
