bug: Spoon's "getShortDescription" and "getLongDescription" handling is too primitive

[I-Al-Istannen]

Context

Spoon offers a getShortDescription() method in CtJavadoc. This method should (I guess) return the short Javadoc the standard HTML Doclet displays in the method table. The javadoc tool description (e.g. here) says:

Copies the first sentence of the overview comment to the top of the overview summary page.

Problem statement

Sadly the current handling is a bit too simplistic (I heard an issue is only complete once it includes images, so here goes nothing):

As you can see the javadoc is cut off after java.. Spoon sees the Javadoc:

/**
 * An extended version of <code>java.awt.Frame</code> that adds support for
 * the JFC/Swing component architecture.

and the Javadoc

/**
 * Accepts a function that extracts a {@link java.lang.Comparable
 * Comparable} sort key from a type {@code T}, and returns a {@code
 * Comparator<T>} that compares by that sort key.

and assumes the span until the first dot is the summary. Sadly, this doesn't work with links - which are quite common.

Solutions

We could try a bit harder and not just scan for the first . but instead look for the first . followed by a space or a newline. This should at least improve the heuristic by quite a bit.

[andrewbwogi]

Your solution seems reasonable. I'll see if we can implement it.