Use Javadoc description to identify methods in the similarity algorithm

[ishtiaque05]

I'm realizing that this may be a bigger change than the annotation change. We would probably want to use javadoc in the similarity algorithm.

Is this because you want to track JavadocBlockTag such as PARAM, RETURN, THROWS etc changes?

Example of a proper javadoc with all its element block tag:

/**
	 * Subject line
	 *
	 * <p>Description of the method with optional {@code code} and {@link Object links to Javadoc}
	 * </p>
	 *
	 * <pre>
	 *    raw input
	 * </pre>
	 *
	 * @param foo first arg
	 * @return a bar
	 * @throws SomeException if bar goes wrong
	 * @see someOtherMethod()
	 * @since 2.2.2
	 * @author me
*/

Sorry should have replied here 😅

I think the description of the method may be useful in discerning if two methods match or are "the same method". It seems like it would be wasteful to not account for the Javadoc in the similarity calculation

Originally posted by @braxtonhall in https://github.com/ataraxie/codeshovel/issues/65#issuecomment-788167995