Adding Javadocs to build (#180)

.github/workflows/build-adoc-javadoc.yml → .github/workflows/asciidoc-build.yml

@@ -1,4 +1,4 @@
-name: Build Adocs and Javadocs
+name: build adocs
 
 on:
   push:
@@ -9,16 +9,15 @@ on:
 jobs:
   adoc_build:
     runs-on: ubuntu-latest
-    name: Build Adocs and Javadocs
+    name: ASCII DOC build
     steps:
     - name: Checkout code
       uses: actions/checkout@v2
     - name: Get build container
       id: adocbuild
       uses: tonynv/asciidoctor-action@master
       with:
-          program: "./gradlew asciidoctor javadoc"
-
+          program: "./gradlew asciidoctor"
     - name: Deploy docs to ghpages
       uses: peaceiris/actions-gh-pages@v3
       with: 

pi4micronaut-utils/build.gradle

@@ -35,6 +35,14 @@ java {
     targetCompatibility = JavaVersion.toVersion("17")
 }
 
+tasks.named('build').configure {
+    dependsOn 'javadoc'
+    copy {
+        from tasks.javadoc.destinationDir
+        into "src/docs/javadoc"
+    }
+}
+
 asciidoctor {
     attributes 'stylesheet': "style.css"
     baseDirFollowsSourceDir()
@@ -58,6 +66,11 @@ tasks.register('javadocJar', Jar) {
     from javadoc.destinationDir
 }
 
+tasks.named('javadocJar').configure {
+    dependsOn 'javadoc'
+}
+
+
 artifacts {
     archives sourcesJar, javadocJar
 }

pi4micronaut-utils/src/main/java/com/opensourcewithslu/inputdevices/PhotoResistorHelper.java

@@ -42,7 +42,9 @@ public PhotoResistorHelper(DigitalInput sensorInput, DigitalOutput sensorOutput)
         photoResistorOutput.high();
         this.isDark = photoResistorInput.isHigh();
     }
-
+    /**
+     * @return current darknessValue.
+     */
     public int getDark() {
         return darknessValue;
     }

pi4micronaut-utils/src/main/java/com/opensourcewithslu/outputdevices/ActiveBuzzerHelper.java

@@ -16,7 +16,9 @@ public class ActiveBuzzerHelper {
     private static final Logger log = LoggerFactory.getLogger(ActiveBuzzerHelper.class);
 
     private final Pwm activeBuzzer;
-
+    /**
+     * To check if the buzzer is active or not
+     */
     protected boolean actBuzzCheck;