add proper javadoc #82

	# This workflow will build a Java project with Maven, and cache/restore any dependencies to improve the workflow execution time
	# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-java-with-maven

	# This workflow uses actions that are not certified by GitHub.
	# They are provided by a third-party and are governed by
	# separate terms of service, privacy policy, and support
	# documentation.

	name: Build & Tests

	on:
	push:
	branches: [ "main" ]
	pull_request:
	branches: [ "main" ]

	jobs:
	build:

	runs-on: ubuntu-latest

	steps:
	- uses: actions/checkout@v4

	- name: Set up JDK 22
	uses: actions/setup-java@v4
	with:
	java-version: '22'
	distribution: 'oracle'
	cache: maven

	- name: Cache packages
	uses: actions/cache@v1
	with:
	path: ~/.m2
	key: ${{ runner.os }}-m2-${{ hashFiles('**/pom.xml') }}
	restore-keys: ${{ runner.os }}-m2

	- name: Build with Maven
	run: mvn -B package --file pom.xml

	- name: Test with Maven
	run: mvn clean verify

Provide feedback