Add JavaDoc to build and fix outdated javadoc comments

roboticsapi · Jun 9, 2021 · 65fedbe · 65fedbe
1 parent b95fa32
commit 65fedbe
Show file tree

Hide file tree

Showing 2 changed files with 42 additions and 21 deletions.
diff --git a/pom.xml b/pom.xml
@@ -19,14 +19,6 @@
 				<version>3.1.1</version>
 			</plugin>
 
-			<plugin>
-				<groupId>org.apache.maven.plugins</groupId>
-				<artifactId>maven-javadoc-plugin</artifactId>
-				<version>3.1.0</version>
-				<executions>
-				</executions>
-			</plugin>
-
 			<plugin>
 				<artifactId>maven-compiler-plugin</artifactId>
 				<version>3.8.0</version>
@@ -35,7 +27,36 @@
 					<target>1.8</target>
 				</configuration>
 			</plugin>
-
+
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-javadoc-plugin</artifactId>
+				<configuration>
+					<outputDirectory>${doc.output.folder}</outputDirectory>
+					<failOnError>false</failOnError>
+				</configuration>
+				<executions>
+					<execution>
+						<id>attach-javadocs</id>
+						<goals>
+							<goal>jar</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
+
+			<plugin>
+				<groupId>org.apache.maven.plugins</groupId>
+				<artifactId>maven-source-plugin</artifactId>
+				<executions>
+					<execution>
+						<id>attach-sources</id>
+						<goals>
+							<goal>jar</goal>
+						</goals>
+					</execution>
+				</executions>
+			</plugin>
 		</plugins>
 	</build>
 

diff --git a/src/main/java/org/roboticsapi/device/kuka/lwr/activity/LwrMotionInterface.java b/src/main/java/org/roboticsapi/device/kuka/lwr/activity/LwrMotionInterface.java
@@ -24,7 +24,7 @@
 public interface LwrMotionInterface extends MotionInterface {
 
 	/**
-	 * Creates an {@link RtActivity} that activates the {@link Lwr4}'s
+	 * Creates an {@link Activity} that activates the {@link Lwr4}'s
 	 * gravitation compensation mode. Will switch to {@link JointPositionController}
 	 * when cancelled.
 	 *
@@ -35,7 +35,7 @@ public interface LwrMotionInterface extends MotionInterface {
 	Activity gravComp(DeviceParameters... parameters) throws RoboticsException;
 
 	/**
-	 * Creates an {@link RtActivity} that activates the {@link Lwr4}'s
+	 * Creates an {@link Activity} that activates the {@link Lwr4}'s
 	 * gravitation compensation mode. Will switch to supplied
 	 * {@link JointController} when cancelled.
 	 *
@@ -47,7 +47,7 @@ public interface LwrMotionInterface extends MotionInterface {
 	Activity gravComp(JointController finalController, DeviceParameters... parameters) throws RoboticsException;
 
 	/**
-	 * Creates an {@link RtActivity} that activates the {@link Lwr4}'s
+	 * Creates an {@link Activity} that activates the {@link Lwr4}'s
 	 * gravitation compensation mode. Will switch to supplied
 	 * {@link CartesianController} when cancelled.
 	 *
@@ -59,7 +59,7 @@ public interface LwrMotionInterface extends MotionInterface {
 	Activity gravComp(CartesianController finalController, DeviceParameters... parameters) throws RoboticsException;
 
 	/**
-	 * Creates an {@link RtActivity} that performs a linear motion to the given
+	 * Creates an {@link Activity} that performs a linear motion to the given
 	 * cartesian goal. The RtActivity expects to establish contact on the way to the
 	 * goal and will then build up the specified (absolute) cartesian force and
 	 * stop.
@@ -80,7 +80,7 @@ public interface LwrMotionInterface extends MotionInterface {
 	Activity linToContact(Pose to, double contactForce, DeviceParameters... parameters) throws RoboticsException;
 
 	/**
-	 * Creates an {@link RtActivity} that performs a linear motion to the given
+	 * Creates an {@link Activity} that performs a linear motion to the given
 	 * cartesian goal. The RtActivity expects to establish contact on the way to the
 	 * goal and will then build up the specified cartesian force and stop.
 	 *
@@ -102,7 +102,7 @@ Activity linToContact(Pose to, double contactForce, boolean absoluteForce, Devic
 			throws RoboticsException;
 
 	/**
-	 * Creates an {@link RtActivity} that performs a linear motion to the given
+	 * Creates an {@link Activity} that performs a linear motion to the given
 	 * cartesian goal. The RtActivity expects to establish contact on the way to the
 	 * goal and will then build up the specified (absolute) cartesian force and
 	 * stop.
@@ -131,7 +131,7 @@ Activity linToContact(Pose to, double contactForceX, double contactForceY, doubl
 			DeviceParameters... parameters) throws RoboticsException;
 
 	/**
-	 * Creates an {@link RtActivity} that performs a linear motion to the given
+	 * Creates an {@link Activity} that performs a linear motion to the given
 	 * cartesian goal. The RtActivity expects to establish contact on the way to the
 	 * goal and will then build up the specified cartesian force and stop.
 	 *
@@ -158,7 +158,7 @@ Activity linToContact(Pose to, double contactForceX, double contactForceY, doubl
 			boolean absoluteForce, DeviceParameters... parameters) throws RoboticsException;
 
 	/**
-	 * Creates an {@link RtActivity} that performs a linear motion to the given
+	 * Creates an {@link Activity} that performs a linear motion to the given
 	 * cartesian goal. The RtActivity expects to establish contact on the way to the
 	 * goal and will then build up the specified (absolute) cartesian force and
 	 * stop.
@@ -181,7 +181,7 @@ Activity linToContact(Pose to, double contactForce, double speedFactor, DevicePa
 			throws RoboticsException;
 
 	/**
-	 * Creates an {@link RtActivity} that performs a linear motion to the given
+	 * Creates an {@link Activity} that performs a linear motion to the given
 	 * cartesian goal. The RtActivity expects to establish contact on the way to the
 	 * goal and will then build up the specified cartesian force and stop.
 	 *
@@ -204,7 +204,7 @@ Activity linToContact(Pose to, double contactForce, boolean absoluteForce, doubl
 			DeviceParameters... parameters) throws RoboticsException;
 
 	/**
-	 * Creates an {@link RtActivity} that performs a linear motion to the given
+	 * Creates an {@link Activity} that performs a linear motion to the given
 	 * cartesian goal. The RtActivity expects to establish contact on the way to the
 	 * goal and will then build up the specified (absolute) cartesian force and
 	 * stop.
@@ -234,7 +234,7 @@ Activity linToContact(Pose to, double contactForceX, double contactForceY, doubl
 			DeviceParameters... parameters) throws RoboticsException;
 
 	/**
-	 * Creates an {@link RtActivity} that performs a linear motion to the given
+	 * Creates an {@link Activity} that performs a linear motion to the given
 	 * cartesian goal. The RtActivity expects to establish contact on the way to the
 	 * goal and will then build up the specified cartesian force and stop.
 	 *
@@ -262,7 +262,7 @@ Activity linToContact(Pose to, double contactForceX, double contactForceY, doubl
 			boolean absoluteForce, double speedFactor, DeviceParameters... parameters) throws RoboticsException;
 
 	/**
-	 * Creates an {@link RtActivity} that releases contact force by performing a
+	 * Creates an {@link Activity} that releases contact force by performing a
 	 * linear motion from the {@link Lwr4}'s commanded position to its measured
 	 * position.
 	 *