Reviewed all Javadoc

[alessandrodalbello]

This PR is an attempt to enhance the already existing Javadoc comments to better document the code and provide more useful information to the users of the library, especially developers importing chesslib into their own projects for the very first time and who are not familiar with its APIs. All Javadoc comments for non-private methods (and in some cases fields) have been reviewed and extended with more information. A common style has been adopted across the entire codebase, in an effort to keep the documentation as much as possible consistent.

On almost no occasion real code has been touched, except for a very few cases in which:

• imports were re-ordered (as per Java conventions),
• arguments were renamed to fix their meaning (but not to improve readability),
• immutable private fields of enum classes were declared final,
• missing @Override annotations were added,
• or order of class fields or method declarations was swapped for clarity.

The main principle driving these changes has always been to not affect anyhow the behavior of the existing implementation, but only to improve the quality of the documentation.

This was also the opportunity for me to understand better the library, the design choices behind it, its structure, and to identify another few defects and potential improvements for which I have already opened (or going to) issues in this repository.

⚠️ By no means this PR is simple to review ⚠️ On the contrary, the PR is huge! All the classes have been modified and there are a lot of differences due to the high amount of Javadoc added/edited. I took the conscious decision not to split the work into smaller chunks to avoid having only some parts of the code documented and not others. I hope you will excuse me.

[alessandrodalbello]

Absolutely! 👍🏻 What a miss 😔 Locally, on my environment, running the package phase, and so generating the Javadoc files, I get no error using <p/>. But honestly, I didn't know the official tag is <p>, as reported clearly here. My bad.

I pushed the changes but can't run the pipeline myself.