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

Merged
merged 2 commits into from
Dec 4, 2023
Merged

Remove blank Javadoc #344

merged 2 commits into from
Dec 4, 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

@iloveeclipse
Copy link
Member

Be careful, some test resources are line dependent because the tests create line breakpoints.

@jukzi
Copy link
Contributor Author

jukzi commented Nov 7, 2023

Be careful, some test resources are line dependent because the tests create line breakpoints.

totally agreed. i tried to filter resources away. if i missed some i will remove those from commit

@jukzi jukzi force-pushed the blankJavaDoc branch 2 times, most recently from 2fb3ef3 to bd74604 Compare November 29, 2023 08:17
@jukzi
Copy link
Contributor Author

jukzi commented Nov 29, 2023

@laeubi tycho still does not build output.jdimodel.jar = bin/

09:37:20  [ERROR] Failed to execute goal org.eclipse.tycho:tycho-apitools-plugin:4.0.4:verify (verify) on project org.eclipse.jdt.debug: There are API errors:
09:37:20  [ERROR] jdi/org/eclipse/jdi/Bootstrap.java:19 The type org.eclipse.jdi.Bootstrap has been removed from org.eclipse.jdt.debug_3.21.300

@akurtakov
Copy link
Contributor

@laeubi is eclipse-platform/eclipse.platform.releng.aggregator#1530 supposed to help here ?

@laeubi
Copy link
Contributor

laeubi commented Nov 29, 2023

@jukzi
Copy link
Contributor Author

jukzi commented Nov 29, 2023

@jukzi build still uses "old" Tycho 4.0.4 as there is no new release yet.

When will the build use a working Tycho version? Is there a workaround?

@jukzi jukzi force-pushed the blankJavaDoc branch 5 times, most recently from 4c6130c to 788a34e Compare December 1, 2023 16:30
@akurtakov
Copy link
Contributor

Manual rebase needed.

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 merged commit 6665a8e into eclipse-jdt:master Dec 4, 2023
9 checks passed
@jukzi jukzi deleted the blankJavaDoc branch December 4, 2023 07:38
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.

5 participants