Remove blank Javadoc #841
Remove blank Javadoc #841
Conversation
Test Results 591 files + 197 591 suites +197 1h 2m 19s ⏱️ + 26m 31s For more details on these failures, see this check. Results for commit 1985eca. ± Comparison against base commit 7fc35d7. ♻️ This comment has been updated with latest results. |
|
I need help: the jenkins build keeps failing with wrong API errors: |
|
See also eclipse-platform/eclipse.platform.ui#1286 results. |
jukzi
force-pushed
the
blankJavaDoc
branch
3 times, most recently
from
2c5c0a9
to
a11fdac
Compare
|
Note this change is supposed to eleminate warings like this: |
jukzi
force-pushed
the
blankJavaDoc
branch
6 times, most recently
from
e8170bc
to
2ae17f1
Compare
This commit cleans up Javadoc that does not add information. It resolves ecj warnings: `Javadoc: Description expected after ...` It helps to prevent future empty javadoc by disabling missingJavaDoc warnings. This resolves `Javadoc: Missing ...` The modification is a result of regular expression search&replace: in files `*.java` `^[\s]*\*[\s]*(@return|@param[\s]*[^\s]+|@throws[\s]*[^\s]+)\R([\s]*\*[\s]*@|[\s]*\*/\R)` ->`$2` `^([\s]*\*[\s]*\R)([\s]*\*/\R)` ->`$2` `^[\S\t]*/\*\*\R[\s]*\*/\R` ->`` in files `org.eclipse.jdt.core.prefs` `org\.eclipse\.jdt\.core\.compiler\.problem\.missingJavadoc(Comments|Tags)\=[^\s]*` ->`org\.eclipse\.jdt\.core\.compiler\.problem\.missingJavadoc$1\=ignore`
There was a problem hiding this comment.
Great to see this kind of cleanup! I have not checked every single change, but the used patterns look sound and when scanning through some of the changed files I did not find any unexpected changes.
And as a "side effect", although I know this is quite some work for you, @jukzi, it is great to have this PR with many required version bumps at the beginning of the current development cycle. That will ease all further PRs because in most cases no version bumps will be required anymore. So thank you for that!
jukzi
force-pushed
the
blankJavaDoc
branch
2 times, most recently
from
02cfe5e
to
abfd3d3
Compare
|
Remaining test fail is unrelated random fail: #770 |
This commit cleans up Javadoc that does not add information.
It resolves ecj warnings:
Javadoc: Description expected after ...It helps to prevent future empty javadoc by disabling
missingJavaDoc warnings. This resolves
Javadoc: Missing ...The modification is a result of regular expression search&replace:
in files
*.java^[\s]*\*[\s]*(@return|@param[\s]*[^\s]+|@throws[\s]*[^\s]+)\R([\s]*\*[\s]*@|[\s]*\*/\R)->
$2^([\s]*\*[\s]*\R)([\s]*\*/\R)->
$2^[\S\t]*/\*\*\R[\s]*\*/\R->``
in files
org.eclipse.jdt.core.prefsorg\.eclipse\.jdt\.core\.compiler\.problem\.missingJavadoc(Comments|Tags)\=[^\s]*->
org\.eclipse\.jdt\.core\.compiler\.problem\.missingJavadoc$1\=ignore