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 #862

Merged
merged 1 commit into from
Nov 8, 2023
Merged

Remove blank Javadoc #862

merged 1 commit into from
Nov 8, 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

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
Contributor

github-actions bot commented Nov 7, 2023

Test Results

     299 files  ±0       299 suites  ±0   6m 17s ⏱️ +53s
  4 095 tests ±0    4 086 ✔️  - 1    8 💤 ±0  1 +1 
12 197 runs  ±0  12 123 ✔️  - 1  73 💤 ±0  1 +1 

For more details on these failures, see this check.

Results for commit bca23c8. ± Comparison against base commit 030807a.

@jukzi
Copy link
Contributor Author

jukzi commented Nov 7, 2023

Build passed. Is it OK to submit such nonfunctional commits during freeze?

@jukzi jukzi merged commit 17dd4bc into eclipse-platform:master Nov 8, 2023
8 of 11 checks passed
@jukzi jukzi deleted the blankJavaDoc branch November 8, 2023 07:04
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.

2 participants