Cleanup of JavaDoc and remove inherit where not needed

pi4j-core/src/main/java/com/pi4j/Pi4J.java

@@ -34,12 +34,6 @@
 import java.io.InputStream;
 import java.util.Properties;
 
-/**
- * <p>Pi4J class.</p>
- *
- * @author Robert Savage (<a href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
- * @version $Id: $Id
- */
 public class Pi4J {
 
     private static final Logger logger = LoggerFactory.getLogger(Pi4J.class);
@@ -109,17 +103,12 @@ public void log() {
         }
     }
 
-    /**
-     * @return {@link BuildInfo}
-     */
     public static BuildInfo getBuildInfo() {
         return buildInfo;
     }
 
     /**
      * Reads the build info from the build.properties file.
-     *
-     * @return {@link BuildInfo}
      */
     private static BuildInfo loadBuildInfo() {
         try (InputStream is = Pi4J.class.getResourceAsStream("/build.properties")) {

pi4j-core/src/main/java/com/pi4j/boardinfo/util/PwmChipUtil.java

@@ -77,7 +77,7 @@ public class PwmChipUtil {
      *     <li>System with RP1 (RPi 5 and later): as detected or {@link #DEFAULT_RP1_PWM_CHIP}</li>
      * </ul>
      *
-     * @return {@link int} value for the pwmchip
+     * @return {@code int} value for the pwmchip
      */
     public static int getPWMChip() {
         if (!BoardInfoHelper.usesRP1()) {
@@ -89,7 +89,7 @@ public static int getPWMChip() {
     /**
      * getPWMChipForRP1 using the default PWM system path
      *
-     * @return {@link int} value for the pwmchip if configured,
+     * @return {@code int} value for the pwmchip if configured,
      * else defaults to original expected value defined by {@link #DEFAULT_RP1_PWM_CHIP}.
      */
     public static int getPWMChipForRP1() {
@@ -100,7 +100,7 @@ public static int getPWMChipForRP1() {
      * getPWMChipForRP1
      *
      * @param pwmFileSystemPath Device tree path to PWM chips, typically /sys/class/pwm
-     * @return {@link int} value for the pwmchip if configured,
+     * @return {@code int} value for the pwmchip if configured,
      * else defaults to original expected value of defined by {@link #DEFAULT_RP1_PWM_CHIP}.
      */
     public static int getPWMChipForRP1(String pwmFileSystemPath) {

pi4j-core/src/main/java/com/pi4j/common/Describable.java

@@ -25,17 +25,6 @@
  * #L%
  */
 
-/**
- * <p>Describable interface.</p>
- *
- * @author Robert Savage (<a href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
- * @version $Id: $Id
- */
 public interface Describable {
-    /**
-     * <p>describe.</p>
-     *
-     * @return a {@link com.pi4j.common.Descriptor} object.
-     */
     Descriptor describe();
 }

pi4j-core/src/main/java/com/pi4j/common/Descriptor.java

@@ -29,161 +29,50 @@
 
 import java.io.PrintStream;
 
-/**
- * <p>Descriptor interface.</p>
- *
- * @author Robert Savage (<a href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
- * @version $Id: $Id
- */
 public interface Descriptor {
-    /**
-     * <p>id.</p>
-     *
-     * @param id a {@link java.lang.String} object.
-     * @return a {@link com.pi4j.common.Descriptor} object.
-     */
     Descriptor id(String id);
-    /**
-     * <p>name.</p>
-     *
-     * @param name a {@link java.lang.String} object.
-     * @return a {@link com.pi4j.common.Descriptor} object.
-     */
+
     Descriptor name(String name);
-    /**
-     * <p>description.</p>
-     *
-     * @param description a {@link java.lang.String} object.
-     * @return a {@link com.pi4j.common.Descriptor} object.
-     */
+
     Descriptor description(String description);
-    /**
-     * <p>category.</p>
-     *
-     * @param category a {@link java.lang.String} object.
-     * @return a {@link com.pi4j.common.Descriptor} object.
-     */
+
     Descriptor category(String category);
-    /**
-     * <p>quantity.</p>
-     *
-     * @param quantity a {@link java.lang.Integer} object.
-     * @return a {@link com.pi4j.common.Descriptor} object.
-     */
+
     Descriptor quantity(Integer quantity);
-    /**
-     * <p>type.</p>
-     *
-     * @param type a {@link java.lang.Class} object.
-     * @return a {@link com.pi4j.common.Descriptor} object.
-     */
+
     Descriptor type(Class type);
 
-    /**
-     * <p>parent.</p>
-     *
-     * @param parent a {@link com.pi4j.common.Descriptor} object.
-     * @return a {@link com.pi4j.common.Descriptor} object.
-     */
     Descriptor parent(Descriptor parent);
 
-    /**
-     * <p>value.</p>
-     *
-     * @param value a {@link java.lang.Object} object.
-     * @return a {@link com.pi4j.common.Descriptor} object.
-     */
     Descriptor value(Object value);
 
-    /**
-     * <p>id.</p>
-     *
-     * @return a {@link java.lang.String} object.
-     */
     String id();
-    /**
-     * <p>name.</p>
-     *
-     * @return a {@link java.lang.String} object.
-     */
+
     String name();
-    /**
-     * <p>category.</p>
-     *
-     * @return a {@link java.lang.String} object.
-     */
+
     String category();
-    /**
-     * <p>description.</p>
-     *
-     * @return a {@link java.lang.String} object.
-     */
+
     String description();
-    /**
-     * <p>quantity.</p>
-     *
-     * @return a {@link java.lang.Integer} object.
-     */
+
     Integer quantity();
-    /**
-     * <p>value.</p>
-     *
-     * @return a {@link java.lang.Object} object.
-     */
+
     Object value();
-    /**
-     * <p>type.</p>
-     *
-     * @return a {@link java.lang.Class} object.
-     */
+
     Class type();
-    /**
-     * <p>parent.</p>
-     *
-     * @return a {@link com.pi4j.common.Descriptor} object.
-     */
+
     Descriptor parent();
 
-    /**
-     * <p>create.</p>
-     *
-     * @return a {@link com.pi4j.common.Descriptor} object.
-     */
-    static Descriptor create(){
+    static Descriptor create() {
         return new DescriptorImpl();
     }
 
-    /**
-     * <p>add.</p>
-     *
-     * @param descriptor a {@link com.pi4j.common.Descriptor} object.
-     * @return a {@link com.pi4j.common.Descriptor} object.
-     */
     Descriptor add(Descriptor descriptor);
 
-    /**
-     * <p>size.</p>
-     *
-     * @return a int.
-     */
     int size();
-    /**
-     * <p>isEmpty.</p>
-     *
-     * @return a boolean.
-     */
+
     boolean isEmpty();
-    /**
-     * <p>isNotEmpty.</p>
-     *
-     * @return a boolean.
-     */
+
     boolean isNotEmpty();
 
-    /**
-     * <p>print.</p>
-     *
-     * @param stream a {@link java.io.PrintStream} object.
-     */
     void print(PrintStream stream);
 }

pi4j-core/src/main/java/com/pi4j/common/Identity.java

@@ -25,80 +25,36 @@
  * #L%
  */
 
-/**
- * <p>Identity interface.</p>
- *
- * @author Robert Savage (<a href="http://www.savagehomeautomation.com">http://www.savagehomeautomation.com</a>)
- * @version $Id: $Id
- */
 public interface Identity extends Describable {
-    /**
-     * <p>id.</p>
-     *
-     * @return a {@link java.lang.String} object.
-     */
     String id();
-    /**
-     * <p>name.</p>
-     *
-     * @return a {@link java.lang.String} object.
-     */
+
     String name();
-    /**
-     * <p>description.</p>
-     *
-     * @return a {@link java.lang.String} object.
-     */
+
     String description();
-    /**
-     * <p>metadata.</p>
-     *
-     * @return a {@link com.pi4j.common.Metadata} object.
-     */
+
     Metadata metadata();
 
-    /**
-     * <p>getId.</p>
-     *
-     * @return a {@link java.lang.String} object.
-     */
-    default String getId(){
+    default String getId() {
         return id();
     }
 
-    /**
-     * <p>getName.</p>
-     *
-     * @return a {@link java.lang.String} object.
-     */
-    default String getName(){
+    default String getName() {
         return name();
     }
 
-    /**
-     * <p>getDescription.</p>
-     *
-     * @return a {@link java.lang.String} object.
-     */
-    default String getDescription(){
+    default String getDescription() {
         return description();
     }
 
-    /**
-     * <p>getMetadata.</p>
-     *
-     * @return a {@link com.pi4j.common.Metadata} object.
-     */
-    default Metadata getMetadata(){
+    default Metadata getMetadata() {
         return metadata();
     }
 
-    /** {@inheritDoc} */
     @Override
     default Descriptor describe() {
         return Descriptor.create()
-                .id(id())
-                .name(name())
-                .description(description());
+            .id(id())
+            .name(name())
+            .description(description());
     }
 }