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 29, 2023
1 parent 0582356 commit d5445e1
Show file tree
Hide file tree
Showing 194 changed files with 8 additions and 510 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,6 @@ public interface ScheduledApplication {
* Returns the identifier of this schedule. The identifier is unique within
* the scope of the application that the schedule is related to.
* @return the identifier of this schedule
*
*/
public String getScheduleId();

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -389,7 +389,6 @@ public void _unschedApp(CommandInterpreter intp) throws Exception {
/**
* Handles the help command
*
* @param intp
* @return description for a particular command or false if there is no command
* with the specified name
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -141,14 +141,7 @@ static void removeScheduledApp(EclipseScheduledApplication scheduledApp) {
* Used by {@link ScheduledApplication} to persistently schedule an application
* launch
*
* @param descriptor
* @param arguments
* @param topic
* @param eventFilter
* @param recurring
* @return the scheduled application
* @throws InvalidSyntaxException
* @throws ApplicationException
*/
public static ScheduledApplication addScheduledApp(ApplicationDescriptor descriptor, String scheduleId,
Map<String, Object> arguments, String topic, String eventFilter, boolean recurring)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -91,7 +91,6 @@
* fullText = expert.leanToFullText(leanText,);
* System.out.println("full text = " + fullText);
* </pre>
*
*/
public interface IStructuredTextExpert {

Expand Down Expand Up @@ -182,7 +181,6 @@ public interface IStructuredTextExpert {
* @return the structured text string without directional formatting characters
* which might have been added by processing it with
* {@link #leanToFullText}.
*
*/
public String fullToLeanText(String text);

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -337,7 +337,6 @@ public int getDirection(IStructuredTextExpert expert, String text, StructuredTex
* {@link StructuredTextTypeHandler#processSpecial}. Examples of special
* cases are comments, literals, or anything which is not identified by
* a one-character separator.
*
*/
public int getSpecialsCount(IStructuredTextExpert expert) {
return 0;
Expand All @@ -362,7 +361,6 @@ public int getSpecialsCount(IStructuredTextExpert expert) {
*
* @return a flag indicating if there is no need to process the structured text
* to add directional formatting characters.
*
*/
public boolean skipProcessing(IStructuredTextExpert expert, String text, StructuredTextCharTypes charTypes) {
return false;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
/**
* ReliableFile class used by ReliableFileInputStream and ReliableOutputStream.
* This class encapsulates all the logic for reliable file support.
*
*/
public class ReliableFile {
/**
Expand Down Expand Up @@ -404,7 +403,6 @@ void closeOutputFile(Checksum checksum) throws IOException {

/**
* Abort the current output stream and do not update the reliable file table.
*
*/
void abortOutputFile() {
if (outputFile == null)
Expand Down Expand Up @@ -673,8 +671,6 @@ public static void cleanupGenerations(File base) {

/**
* Inform ReliableFile that a file has been updated outside of ReliableFile.
*
* @param file
*/
public static void fileUpdated(File file) {
lastGenerationFile = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,6 @@ private static void reportFloatingPointWorkInLoop(IProgressMonitor monitor, int
* remaining work, and will run for the given number of iterations. Retuns the
* number of ticks reported (out of 1000).
*
* @param ratio
* @return the number of ticks reported
*/
private double runInfiniteProgress(int ratio, int iterations) {
Expand Down Expand Up @@ -750,8 +749,6 @@ public void testCreateChildrenUnderCustomParent() {
* Creates a chain of n nested progress monitors. Calls beginTask on all
* monitors except for the innermost one.
*
* @param parent
* @param depth
* @return the innermost SubMonitor
*/
public static SubMonitor createSubProgressChain(SubMonitor parent, int depth) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,9 +17,6 @@
import org.eclipse.core.runtime.IProgressMonitor;
import org.junit.Assert;

/**
*
*/
public class TestProgressMonitor implements IProgressMonitor {

private double totalWork;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -83,8 +83,6 @@ public void testToJARURI() {

/**
* Tests for {@link URIUtil#toFile(URI)}.
*
* @throws URISyntaxException
*/
public void testToFile() throws URISyntaxException {
File base = new File(System.getProperty("java.io.tmpdir"));
Expand All @@ -98,8 +96,6 @@ public void testToFile() throws URISyntaxException {

/**
* Tests for {@link URIUtil#toFile(URI)} involving UNC paths.
*
* @throws URISyntaxException
*/
public void testToFileUNC() throws URISyntaxException {
if (!WINDOWS) {
Expand Down Expand Up @@ -283,8 +279,6 @@ public void testFileWithBrackets() throws MalformedURLException, URISyntaxExcept

/**
* Tests for {@link URIUtil#append(URI, String)}.
*
* @throws URISyntaxException
*/
public void testAppend() throws URISyntaxException {
URI base = new URI("http://a.b.c/a%20b/");
Expand Down Expand Up @@ -314,8 +308,6 @@ public void testAppendUNC() throws URISyntaxException {
/**
* Tests for {@link URIUtil#append(URI, String)} when dealing with paths
* containing brackets.
*
* @throws URISyntaxException
*/
public void testAppendWithBrackets() throws URISyntaxException {
// append a simple string
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,6 @@
import org.eclipse.core.runtime.IAdapterFactory;
import org.junit.Assert;

/**
*/
public class TestAdapterFactory extends Assert implements IAdapterFactory {
@Override
public <T> T getAdapter(Object adaptableObject, Class<T> adapterType) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,6 @@
import org.eclipse.core.runtime.IAdapterFactory;
import org.junit.Assert;

/**
*/
public class TestAdapterFactory2 extends Assert implements IAdapterFactory {

private Supplier<TestAdapter2> supplier;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -81,9 +81,6 @@ public void testResolution() throws IOException, BundleException {
* bundleA, bundleB, and fragment on bundleA all use the same namespace. Verify
* that getting elements by contributor returns all elements from the
* contributor and only from that contributor.
*
* @throws IOException
* @throws BundleException
*/
@Test
public void testByContributor() throws IOException, BundleException {
Expand Down Expand Up @@ -146,9 +143,6 @@ public void testByContributor() throws IOException, BundleException {
* {@link IDynamicExtensionRegistry#removeContributor(IContributor, Object)}. A
* separate registry is created as removal functionality is not allowed by the
* default Eclipse registry.
*
* @throws IOException
* @throws BundleException
*/
@Test
public void testContributorRemoval() throws IOException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -66,8 +66,6 @@ public void testExtensionPointAddition() throws IOException {
/**
* Tests that configuration elements associated with the removed extension are
* removed.
*
* @throws IOException
*/
@Test
public void testAssociatedConfigElements() throws IOException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -61,7 +61,7 @@ org.eclipse.jdt.core.compiler.problem.missingJavadocComments=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsOverriding=enabled
org.eclipse.jdt.core.compiler.problem.missingJavadocCommentsVisibility=public
org.eclipse.jdt.core.compiler.problem.missingJavadocTagDescription=all_standard_tags
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=warning
org.eclipse.jdt.core.compiler.problem.missingJavadocTags=ignore
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsMethodTypeParameters=disabled
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsOverriding=disabled
org.eclipse.jdt.core.compiler.problem.missingJavadocTagsVisibility=protected
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
/**
* Acts as abridge between {@link IAdapterManager} services registered in the
* OSGi-Service-Registry and AdapterManager
*
*/
public class AdapterFactoryBridge
implements ServiceTrackerCustomizer<IAdapterFactory, AdapterFactoryBridge.LazyAdapterFactory> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -138,7 +138,6 @@ private void addFactoriesFor(String adaptableTypeName, Map<String, List<IAdapter
* @return the class with the given fully qualified name, or <code>null</code>
* if that class does not exist or belongs to a plug-in that has not yet
* been loaded.
*
*/
private Class<?> classForName(IAdapterFactory adapterFactory, String typeName) {
return classLookup.computeIfAbsent(adapterFactory, factory -> new ConcurrentHashMap<>())
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
* Abstract implementation of {@link IExecutor} and {@link IRunnableExecutor}.
*
* @since 1.1
*
*/
public abstract class AbstractExecutor implements IRunnableExecutor, IExecutor {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
* provided by the IExecutor that creates the future instance.
*
* @since 1.1
*
*/
public class FutureProgressMonitor extends ProgressMonitorWrapper {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
* @param <ResultType> the type that will be returned by {@link #get()} and/or
* {@link #get(long)}
* @since 1.1
*
*/
public interface IFuture<ResultType> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@
* {@link IProgressMonitor}) to be executed via an {@link IExecutor}.
*
* @since 1.1
*
*/
public interface IListenableFuture<ResultType> extends IFuture<ResultType> {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@ public interface IProgressRunnable<ResultType> {
*
* @param monitor the IProgressMonitor associated with this callable
* @return result from the call
* @throws Exception
*/
ResultType run(IProgressMonitor monitor) throws Exception;
}
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@
* possibly thrown by the given {@link IProgressRunnable}.
*
* @since 1.1
*
*/
public interface ISafeProgressRunner {
void runWithProgress(IProgressRunnable<?> runnable);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,6 @@ public static class ParseKeyException extends IOException {

/**
* Creates a new instance.
*
* @param message
* @param cause
*/
public ParseKeyException(final String message, final Throwable cause) {
super(message, cause);
Expand Down Expand Up @@ -85,8 +82,6 @@ public static void main(final String[] args) {

/**
* Creates a new instance.
*
* @throws FileNotFoundException
*/
public AuthorizedKeys(final String authorizedKeysFile) throws FileNotFoundException, IOException {
// read file line-by-line
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@

/**
* This class represents a user role
*
*/
public class RolePrincipal implements Principal {
private String roleName;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
/**
* This class implements a JAAS LoginModule, which performs username/password
* based authentication. It reads the user data from the store.
*
*/
public class SecureStorageLoginModule implements LoginModule {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,6 @@

/**
* This class represents a user with password and roles
*
*/
public class UserPrincipal implements Principal {
private String username;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@

/**
* This class implements a command for starting/stopping a simple ssh server.
*
*/
public class SshCommand {
private String defaultHost = null;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,6 @@
/**
* This class customizes the generic handler with a concrete content processor,
* which provides ssh protocol handling.
*
*/
public class SshInputHandler extends InputHandler {
public SshInputHandler(InputStream input, ConsoleInputStream in, ConsoleOutputStream out) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,6 @@
/**
* This class performs preprocessing of the input from the ssh server in order
* to echo the visible characters back to the console.
*
*/
public class SshInputScanner extends Scanner {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@

/**
* This class configures and start an ssh server
*
*/
public class SshServ extends Thread {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,6 @@
* This class manages a ssh connection. It is responsible for wrapping the
* original io streams from the socket, and starting a CommandSession to execute
* commands from the ssh.
*
*/
public class SshSession extends Thread implements Closeable {
private CommandProcessor processor;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
* This class manages a ssh connection. It is responsible for starting a
* sessions to execute commands from the ssh. If there are multiple
* CommandProcessors, a session is started for each of them.
*
*/
public class SshShell implements Command {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@

/**
* Shell factory used by the SSH server to create a SSH shell
*
*/
public class SshShellFactory implements ShellFactory {

Expand Down
Loading

0 comments on commit d5445e1

Please sign in to comment.