#21 Allow Eclipse style non-javadoc comments for public methods

[Roy Wright]

Howdy,

When you override a method in Eclipse, it will use
comments of the following format:

/*
* (non-Javadoc)
*
* @see ...
*/
public foobar()

It would be really nice if JCSC didn't flag these are
missing javadoc for a public method, but still flag
public methods that really are missing javadocs.

Glimpsing in the source code, it looks like this could be
supported in the JavaDocParser.parse(String) method
with something like:

private void parse(String docs)
{
docs = docs.trim();

if (docs.startsWith("/**") && docs.endsWith("*/"))
{
mIsJavaDoc = true;
}
else if (docs.startsWith("/*") &&
docs.endsWith("*/"))
{
StringTokenizer st = new StringTokenizer(docs,
"\n");

while (st.hasMoreTokens())
{
String line = (String) st.nextElement();

if (sNONJAVADOCRegexp.isMatch(line) &&
sSEERegexp.isMatch(line))
{
mIsJavaDoc = true;
return;
}
}
else
{
return;
}

This may be oversimplified.

Comments?

TIA,
Roy

[Nobody/Anonymous]

Logged In: NO

Hi Roy,
thanks for your investigative work for the feature you want.
I'll check it out. However, I am busy doing many other
things right now so it might be a while.

Thanks,
Ralph