a few small improvements to the javadoc source code documentation

Conversation 0 Commits 2 Files Changed 5

eUgEntOptIc44 commented

As the title of this PR reads I recently learned about the role of package-info.java within javadoc. It introduces the possibility of adding a short¹ description to the package overview on the index page of the javadoc.

It's only a little change but it'd fill the blank space right in the middle of the page.

I also found a few typos in the source code and fixed them.

Looking forward to your feedback on this.

Regards,

Jean-Luc

only one line ↩︎

Hi @Starfish, As the title of this PR reads I recently learned about the role of `package-info.java` within javadoc. It introduces the possibility of adding a short[^1] description to the package overview on the index page of the javadoc. It's only a little change but it'd fill the blank space right in the middle of the page. ![Screenshot of javadoc index page](https://codeberg.org/attachments/df2013e1-b5d3-4400-8e84-b59a7e1259f1) I also found a few typos in the source code and fixed them. Looking forward to your feedback on this. Regards, Jean-Luc [^1]: only one line

Screenshot_20220928_javadoc-index.jpg

440 KiB

eUgEntOptIc44 added 2 commits

2599f7dc79 added package-info.java to add package descriptions in javadoc

5a1175419c remove typos and improve javadoc documentation