diff --git a/.github/workflows/javadoc-upload.yml b/.github/workflows/javadoc-upload.yml new file mode 100644 index 0000000..5681c9f --- /dev/null +++ b/.github/workflows/javadoc-upload.yml @@ -0,0 +1,28 @@ +name: Deploy Javadoc + +on: + push: + branches: + - master + - main + +jobs: + publish: + runs-on: ubuntu-latest + permissions: + contents: write + steps: + - name: Prepare output dir + run: | + mkdir -p ./javadoc + - name: Deploy JavaDoc 🚀 + uses: MathieuSoysal/Javadoc-publisher.yml@v2.5.0 + with: + GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }} + javadoc-branch: javadoc + java-version: 17 + target-folder: javadoc + project: gradle + - name: Publish documentation online + run: | + \ No newline at end of file diff --git a/src/main/java/me/cortex/TreeCracker/LCG/LcgComparison.java b/src/main/java/me/cortex/TreeCracker/LCG/LcgComparison.java index 65beb56..e872af5 100644 --- a/src/main/java/me/cortex/TreeCracker/LCG/LcgComparison.java +++ b/src/main/java/me/cortex/TreeCracker/LCG/LcgComparison.java @@ -1,10 +1,23 @@ package me.cortex.TreeCracker.LCG; +/** + * Class to represent a Comparaison for LCG. + * +*/ public class LcgComparison { public T comparingTo; public Type comparingType; boolean configured = false; + + /** + * Set this.comparingTo attribute of current class to the first argument compraingTo and comparingType attribute to Type.greaterThan. + * + * + * Argument 1, comparingTo: value set for this.comparingTo + * + * returns: nothing. + */ public void greaterThan(T comparingTo) { if (configured) throw new IllegalStateException("LcgComparison already configured");