Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove blank Javadoc #396

Merged
merged 2 commits into from
Nov 29, 2023
Merged

Remove blank Javadoc #396

merged 2 commits into from
Nov 29, 2023

Conversation

jukzi
Copy link
Contributor

@jukzi jukzi commented Nov 7, 2023

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

Copy link

github-actions bot commented Nov 7, 2023

Test Results

     24 files  ±0       24 suites  ±0   10m 39s ⏱️ -15s
2 150 tests ±0  2 105 ✔️ ±0  45 💤 ±0  0 ±0 
2 194 runs  ±0  2 149 ✔️ ±0  45 💤 ±0  0 ±0 

Results for commit 72045d3. ± Comparison against base commit 627f44a.

♻️ This comment has been updated with latest results.

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`
@jukzi jukzi force-pushed the blankJavaDoc branch 10 times, most recently from bfc78b9 to 46ba540 Compare November 29, 2023 10:22
@jukzi
Copy link
Contributor Author

jukzi commented Nov 29, 2023

there are unrelated test errors

@akurtakov akurtakov merged commit 9c62e8b into eclipse-equinox:master Nov 29, 2023
20 of 23 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants