Update doc for JavadocMethod

[baratali]

https://checkstyle.org/config_javadoc.html#JavadocMethod

Add example for each existing config to show what code is ok and what code cause violation.
Good example is https://checkstyle.org/config_naming.html#AbstractClassName
Look at referenced commits of #5832, to see what and how should be changed in code.

Please play with module/check by means of https://checkstyle.org/cmdline.html to understand how it works.

---

PLEASE READ https://github.com/checkstyle/checkstyle/wiki/Good-practice-on-how-to-update-examples

[romani]

It is not fixed, everyone in the world can help to fix it.

[rukundob451]

@romani can I be assigned this issue?

[rnveach]

There are no issue assignments. Just say "I am on it" and start working on it.

[aritrasinha108]

Since there are no updates here for a month now, should I start working on it?

[romani]

@aritrasinha108 , please send PR

[aritrasinha108]

@romani one of the tests is failing because of the param tags used as an example. One of the examples I added in /src/main/java/com/puppycrawl/tools/checkstyle/checks/javadoc/JavadocMethodCheck.java looks something like:

* /**
*  * A sample function to print the product two numbers
*  * @param number1 The first number
*  * @param number1 The second number
*  * @return An integer
*  */
* public void multiplyTwoNumbers(int number1, int number2){   // ok, param tags available

when I run mvn clean verify after making the changes, I get this checkstyle fail

This happens for all the instances where any tag is used. It's already inside a Javadoc. Not really how to fix this. Could you help me with this?

[aritrasinha108]

Created a PR in case you want to have a look on the changes