Skip to content

Commit

Permalink
Remove blank Javadoc
Browse files Browse the repository at this point in the history
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`
  • Loading branch information
EcljpseB0T authored and jukzi committed Nov 7, 2023
1 parent fd387ab commit cfccc46
Show file tree
Hide file tree
Showing 17 changed files with 0 additions and 90 deletions.
Expand Up @@ -8,7 +8,6 @@
*******************************************************************************/
/**
* Parses feature.xml, plugin.xml, and fragment.xml files
*
*/

package org.eclipse.releng;
Expand Down
Expand Up @@ -556,9 +556,6 @@ public String getDropTokenList() {
return dropTokenList;
}

/**
* @return
*/
public Vector<String> getDropTokens() {
return dropTokens;
}
Expand Down Expand Up @@ -607,16 +604,10 @@ public String getTestResultsHtmlFileName() {
return testResultsHtmlFileName;
}

/**
* @return
*/
public String getTestResultsWithProblems() {
return testResultsWithProblems;
}

/**
* @return
*/
public String getTestResultsXmlUrls() {
return testResultsXmlUrls;
}
Expand Down Expand Up @@ -1169,9 +1160,6 @@ public void setDropTokenList(final String dropTokenList) {
this.dropTokenList = dropTokenList;
}

/**
* @param vector
*/
public void setDropTokens(final Vector<String> vector) {
dropTokens = vector;
}
Expand Down Expand Up @@ -1218,9 +1206,6 @@ public void setTestResultsHtmlFileName(final String aString) {
testResultsHtmlFileName = aString;
}

/**
* @param string
*/
public void setTestResultsWithProblems(final String string) {
testResultsWithProblems = string;
}
Expand Down Expand Up @@ -1314,8 +1299,6 @@ private void writeFile(File outputFile, final String contents) {
* This method writes the computed HTML to the file specified by caller in
* testResultsHtmlFileName. There must be an appropriate file on Download
* site that "includes" the file.
*
* @param contents
*/
private void writeTestResultsFile(String contents) {
final String outputFileName = dropDirectoryName + File.separator + testResultsHtmlFileName;
Expand Down
Expand Up @@ -18,7 +18,6 @@
* the huge maven debug log.
*
* @author davidw
*
*/
public class Extractor {

Expand Down
Expand Up @@ -121,7 +121,6 @@ private Repository createRepository(boolean bare) throws IOException {
* true for a bare repository; false for a repository with a
* working directory
* @return a unique directory for a test repository
* @throws IOException
*/
protected File createUniqueTestGitDir(boolean bare) throws IOException {
String gitdirName = createUniqueTestFolderPrefix();
Expand Down
Expand Up @@ -61,7 +61,6 @@
/**
* Validates the content of the pom.xml. Currently the only check is that the
* version specified in pom.xml matches the bundle version.
*
*/
public class PomVersionErrorReporter implements IResourceChangeListener, IEclipsePreferences.IPreferenceChangeListener {

Expand Down Expand Up @@ -316,8 +315,6 @@ public String getVersion() {

/**
* Clean up all markers
*
* @param project
*/
void cleanMarkers(IResource resource) {
try {
Expand All @@ -330,9 +327,6 @@ void cleanMarkers(IResource resource) {

/**
* Validates the manifest or feature version against the version in the <code>pom.xml</code> file
*
* @param project
* @param severity
*/
public void validate(IProject project) {
if(project == null || !project.isAccessible()) {
Expand Down Expand Up @@ -456,7 +450,6 @@ void reportMarker(String message, int lineNumber, int charStart, int charEnd, St
* is returned if the {@link IFile} does not exist or the {@link ITextFileBufferManager}
* cannot be acquired or there was an exception trying to create the {@link IDocument}.
*
* @param file
* @return a new {@link IDocument} or <code>null</code>
*/
protected IDocument createDocument(IFile file) {
Expand Down
Expand Up @@ -35,7 +35,6 @@
* Tested in {@link org.eclipse.releng.tests.AdvancedCopyrightCommentTestsJunit4}<br>
* Please verify that tests run after modifications.
* </p>
*
*/
public class AdvancedCopyrightComment extends CopyrightComment {

Expand Down Expand Up @@ -125,7 +124,6 @@ public String getCopyrightComment() {
* @param commentStyle
* the comment style. {@link CopyrightComment}
* @return {@link AdvancedCopyrightComment} an copyright comment with the year updated.
*
*/
public static AdvancedCopyrightComment parse(BlockComment commentBock, int commentStyle) {
// If the given comment is empty, return the default comment.
Expand Down Expand Up @@ -266,9 +264,6 @@ private static String[] getLegalLines() {
/**
* Write out the copyright statement, line by line, adding in the created/revision
* year as well as comment line prefixes.
*
* @param writer
* @param linePrefix
*/
private void writeLegal(PrintWriter writer, String linePrefix) {
String[] legalLines = getLegalLines();
Expand Down Expand Up @@ -334,10 +329,6 @@ private static String updateLastYear(String line, int newYear) {
* <p>
* This should <b>only</b> be used for lines that have a single year.
* </p>
*
* @param line
* @param year
* @return
*/
private static String insertRevisedYear(String line, int year) {
Matcher matcher = Pattern.compile(YEAR_REGEX).matcher(line);
Expand All @@ -355,9 +346,6 @@ private static String insertRevisedYear(String line, int year) {

/**
* Given a line with one or multiple years on it, count how many years occur on it.
*
* @param line
* @return
*/
private static int countYearsOnLine(String line) {
Matcher yearMatcher = Pattern.compile(YEAR_REGEX).matcher(line);
Expand Down Expand Up @@ -391,7 +379,6 @@ private static int getFirstYear(String line) {
* in the range YEAR_REGEX
*
* @see #YEAR_REGEX
* @param line
* @return e.g 2011
*/
private static int getLastYear(String line) {
Expand Down
Expand Up @@ -296,9 +296,6 @@ protected RepositoryProviderCopyrightAdapter createCopyrightAdapter(IResource[]
return factory.createAdapater(results);
}

/**
*
*/
private void writeLogs() {

FileOutputStream aStream;
Expand Down Expand Up @@ -360,8 +357,6 @@ private void displayLogs(MessageConsoleStream stream) {
*
* @param file
* - file to be proccessed (.java, .bat, .xml etc...)
* @param adapter
* @param monitor
*/
private void processFile(IFile file, RepositoryProviderCopyrightAdapter adapter, IProgressMonitor monitor) {

Expand Down Expand Up @@ -543,8 +538,6 @@ private boolean checkUserFileIgnoreSettings(IPreferenceStore prefStore, SourceFi
/**
* Check if the file has multiple copyright notices. Skip such files.
*
* @param file
* @param aSourceFile
* @return true if it has a single notice.
*/
private boolean checkMultipleCopyright(IFile file, SourceFile aSourceFile) {
Expand Down
Expand Up @@ -24,11 +24,6 @@ public class BlockComment {
private String copyrightHolder;


/**
* @param commentStart
* @param commentEnd
* @param comment
*/
public BlockComment(int commentStartLine, int commentEndLine, String comment) {
start = commentStartLine;
end = commentEndLine;
Expand Down
Expand Up @@ -119,7 +119,6 @@ public void setRevisionYear(int year) {
}

/**
* @param lineDelimiter
* @since 3.7
*/
public void setLineDelimiter(String lineDelimiter) {
Expand Down
Expand Up @@ -21,7 +21,6 @@
* that can be used by the {@link AdvancedFixCopyrightAction} to determine the last modified year
* for a set of files. It should be obtained by adapting the repository provider type to an instance
* of this interface using the {@link IAdapterManager}.
*
*/
public interface IRepositoryProviderCopyrightAdapterFactory {

Expand Down
Expand Up @@ -18,9 +18,6 @@

public class JavaFile extends SourceFile {

/**
* @param file
*/
public JavaFile(IFile file) {
super(file);
}
Expand Down
Expand Up @@ -18,9 +18,6 @@

public class PropertiesFile extends SourceFile {

/**
* @param file
*/
public PropertiesFile(IFile file) {
super(file);
}
Expand Down
Expand Up @@ -43,7 +43,6 @@ public RepositoryProviderCopyrightAdapter(IResource[] resources) {
* @param file the file
* @param monitor a progress monitor
* @return the last modified year or -1
* @throws CoreException
*/
public abstract int getLastModifiedYear(IFile file, IProgressMonitor monitor) throws CoreException;

Expand Down
Expand Up @@ -185,7 +185,6 @@ public BlockComment firstBlockComment() {
* If this method is called, <b>ensure</b> that you close the file buffer after usage. <br>
* Otherwise you leave a memory leak. {@link #closeFileBuffer()}
* {@code textFileBufferManager.disconnect(file.getFullPath(), LocationKind.IFILE, null); }
* @return
*/
private ITextFileBuffer openFileBuffer() {
try {
Expand Down Expand Up @@ -261,7 +260,6 @@ public BlockComment getFirstCopyrightComment() {
}

/**
* @param aCommet
* @param newCopyrightComment Comment to be inserted.
*/
public void replace(BlockComment aComment, String newCopyrightComment) {
Expand Down
Expand Up @@ -40,7 +40,6 @@
* [x] Document with XML header, copyright on 2nd line, stuff.
* [x] test with non-IBM header.
* 2014.07.15 tested.
*
*/

/**
Expand Down Expand Up @@ -150,9 +149,6 @@ protected void doInsert(final String comment, IDocument document) throws BadLoca

/**
* Given the document, find the place after the xml header to insert the comment.
* @param document
* @return
* @throws BadLocationException
*/
private int findInsertOffset(IDocument document) throws BadLocationException {
boolean inInstruction = false;
Expand Down Expand Up @@ -212,9 +208,7 @@ private int findInsertOffset(IDocument document) throws BadLocationException {
* {@literal<?xml version="1.0" encoding="UTF-8" standalone="no"?> } <br>
* {@literal <?xml version="1.0" ?> } </p>
*
* @param xmlDoc
* @return True if it contains a header.
* @throws BadLocationException
*/
public boolean containsXmlEncoding(IDocument xmlDoc) throws BadLocationException {

Expand Down
Expand Up @@ -297,8 +297,6 @@ public boolean performOk() {

/**
* Fix up line delimiters in doc to use only \n
* @param doc
* @return
*/
private String fixupLineDelimiters(IDocument doc) {
String docContents = doc.get();
Expand Down
Expand Up @@ -42,7 +42,6 @@

/**
* This block is used to add error/warning combos to the {@link PomVersionPreferencePage}
*
*/
public class PomErrorLevelBlock extends ConfigurationBlock {
/**
Expand All @@ -54,8 +53,6 @@ protected static class ControlData {

/**
* Constructor
* @param key
* @param values
*/
public ControlData(Key key, String[] values) {
this.key = key;
Expand Down Expand Up @@ -97,8 +94,6 @@ protected static class Key {

/**
* Constructor
* @param qualifier
* @param key
*/
public Key(String qualifier, String key) {
this.qualifier= qualifier;
Expand All @@ -107,8 +102,6 @@ public Key(String qualifier, String key) {

/**
* Returns the {@link IEclipsePreferences} node for the given context and {@link IWorkingCopyManager}
* @param context
* @param manager
* @return the {@link IEclipsePreferences} node or <code>null</code>
*/
private IEclipsePreferences getNode(IScopeContext context, IWorkingCopyManager manager) {
Expand All @@ -121,8 +114,6 @@ private IEclipsePreferences getNode(IScopeContext context, IWorkingCopyManager m

/**
* Returns the value stored in the {@link IEclipsePreferences} node from the given context and working copy manager
* @param context
* @param manager
* @return the value from the {@link IEclipsePreferences} node or <code>null</code>
*/
public String getStoredValue(IScopeContext context, IWorkingCopyManager manager) {
Expand All @@ -136,9 +127,6 @@ public String getStoredValue(IScopeContext context, IWorkingCopyManager manager)
/**
* Returns the stored value of this {@link IEclipsePreferences} node using a given lookup order, and allowing the
* top scope to be ignored
* @param lookupOrder
* @param ignoreTopScope
* @param manager
* @return the value from the {@link IEclipsePreferences} node or <code>null</code>
*/
public String getStoredValue(IScopeContext[] lookupOrder, boolean ignoreTopScope, IWorkingCopyManager manager) {
Expand All @@ -153,9 +141,6 @@ public String getStoredValue(IScopeContext[] lookupOrder, boolean ignoreTopScope

/**
* Sets the value of this key
* @param context
* @param value
* @param manager
*/
public void setStoredValue(IScopeContext context, String value, IWorkingCopyManager manager) {
IEclipsePreferences node = getNode(context, manager);
Expand Down Expand Up @@ -242,7 +227,6 @@ public void widgetSelected(SelectionEvent e) {

/**
* Constructor
* @param project
*/
public PomErrorLevelBlock(IWorkbenchPreferenceContainer container) {
fLookupOrder = new IScopeContext[] {
Expand Down Expand Up @@ -347,9 +331,6 @@ public void dispose() {

/**
* Creates a {@link Label} | {@link Combo} control. The combo is initialised from the given {@link Key}
* @param parent
* @param label
* @param key
*/
protected Combo createComboControl(Composite parent, String label, Key key) {
Label lbl = new Label(parent, SWT.NONE);
Expand Down

0 comments on commit cfccc46

Please sign in to comment.