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

Fail on javadoc errors #716

Merged
merged 20 commits into from
Dec 12, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@ Bundle-ManifestVersion: 2
Bundle-Name: Common Eclipse Runtime Tests
Bundle-Vendor: Eclipse.org - Equinox
Bundle-SymbolicName: org.eclipse.equinox.common.tests;singleton:=true
Bundle-Version: 3.17.200.qualifier
Bundle-Version: 3.17.300.qualifier
Automatic-Module-Name: org.eclipse.equinox.common.tests
Bundle-RequiredExecutionEnvironment: JavaSE-17
Bundle-ActivationPolicy: lazy
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,15 @@
import static org.junit.Assert.assertTrue;

import java.io.IOException;
import org.eclipse.core.runtime.*;
import org.eclipse.core.runtime.dynamichelpers.*;

import org.eclipse.core.runtime.IExtension;
import org.eclipse.core.runtime.IExtensionDelta;
import org.eclipse.core.runtime.IExtensionPoint;
import org.eclipse.core.runtime.IExtensionRegistry;
import org.eclipse.core.runtime.RegistryFactory;
import org.eclipse.core.runtime.dynamichelpers.ExtensionTracker;
import org.eclipse.core.runtime.dynamichelpers.IExtensionChangeHandler;
import org.eclipse.core.runtime.dynamichelpers.IExtensionTracker;
import org.eclipse.core.tests.harness.BundleTestingHelper;
import org.eclipse.core.tests.harness.TestRegistryChangeListener;
import org.junit.Test;
Expand Down Expand Up @@ -61,7 +68,7 @@ public void testAddition() throws IOException, BundleException {
}

/**
* @see bug 65783
* @see "bug 65783"
*/
@Test
public void testReresolving() throws IOException, BundleException {
Expand Down Expand Up @@ -95,7 +102,7 @@ public void testReresolving() throws IOException, BundleException {
boolean removalCalled = false;

/**
* @see bug 178028
* @see "bug 178028"
*/
@Test
public void testEventTracker() throws IOException, BundleException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %pluginName
Bundle-SymbolicName: org.eclipse.equinox.concurrent
Bundle-Version: 1.3.100.qualifier
Bundle-Version: 1.3.200.qualifier
Bundle-Vendor: %pluginProvider
Bundle-RequiredExecutionEnvironment: JavaSE-17
Import-Package: org.eclipse.core.runtime;version="3.4.0";common=split,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
* values have been provided to the future (if <code>true</code>, meaning that
* subsequent calls to {@link #get()} will not block), or {@link #isDone()} to
* determine if <b>all</b> operations and results have been completed.
* </p>
* <p>
* If {@link #hasValue()} is true, then the client may access status information
* associated with the completed operation(s) via {@link #getStatus()}. Until
Expand Down Expand Up @@ -72,8 +71,7 @@ public interface IFuture<ResultType> {
* @throws InterruptedException if thread calling this method is
* interrupted.
* @throws OperationCanceledException if the operation has been canceled via
* progress monitor
* {@link #getProgressMonitor()}.
* progress monitor.
*/
ResultType get() throws InterruptedException, OperationCanceledException;

Expand All @@ -90,8 +88,7 @@ public interface IFuture<ResultType> {
* @throws TimeoutException if the given wait time is exceeded without
* getting result.
* @throws OperationCanceledException if the operation has been canceled via
* progress monitor
* {@link #getProgressMonitor()}.
* progress monitor.
*/
ResultType get(long waitTimeInMillis) throws InterruptedException, TimeoutException, OperationCanceledException;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %bundleName
Bundle-SymbolicName: org.eclipse.equinox.console.ssh
Bundle-Version: 1.3.100.qualifier
Bundle-Version: 1.3.200.qualifier
Bundle-Activator: org.eclipse.equinox.console.ssh.Activator
Bundle-Vendor: %bundleVendor
Bundle-Localization: plugin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -42,9 +42,9 @@ public class UserAdminCommand {
/**
* Command for adding a user
*
* @param args command line arguments in the format -username <username>
* @param args command line arguments in the format {@code -username <username>
* -password <password> -roles <comma-separated list of user roles
* (optional)>
* (optional)>}
*/
@Descriptor("Add user with password and roles")
public void addUser(
Expand Down Expand Up @@ -89,8 +89,8 @@ public void addUser(
/**
* Command for setting or changing the password of a user.
*
* @param args command-line arguments in the format -username <username>
* -password <password>
* @param args command-line arguments in the format {@code -username <username>
* -password <password>}
*/
@Descriptor("Set or change password")
public void setPassword(@Descriptor("-username <username>\r\n-password <password>") String[] args)
Expand Down Expand Up @@ -256,8 +256,8 @@ public void setPassword(final CommandSession session,
/**
* Command to add roles to a user
*
* @param args command line arguments in the format -username
* <username>\r\n-roles <comma-separated list of roles to add>
* @param args command line arguments in the format {@code -username
* <username>\r\n-roles <comma-separated list of roles to add>}
*/
@Descriptor("Add roles to user")
public void addRoles(
Expand Down Expand Up @@ -294,8 +294,8 @@ public void addRoles(
/**
* Command to remove roles for a particular user
*
* @param args command line arguments in the format -username
* <username>\r\n-roles <comma-separated list of roles to remove>
* @param args command line arguments in the format {@code -username
* <username>\r\n-roles <comma-separated list of roles to remove>}
*/
@Descriptor("Remove user roles")
public void removeRoles(
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,8 @@
/**
* This class implements a storage for users, passwords and roles. The data is
* stored in a properties-like file in the format
* /ssh/<username>/password=<password> and
* /ssh/<username>/roles=<comma_separated_list_of_roles>
* {@code /ssh/<username>/password=<password>} and
* {@code /ssh/<username>/roles=<comma_separated_list_of_roles>}
*/
public class SecureUserStore {

Expand Down
2 changes: 1 addition & 1 deletion bundles/org.eclipse.equinox.console/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ Manifest-Version: 1.0
Bundle-ManifestVersion: 2
Bundle-Name: %bundleName
Bundle-SymbolicName: org.eclipse.equinox.console
Bundle-Version: 1.4.800.qualifier
Bundle-Version: 1.4.900.qualifier
Bundle-Activator: org.eclipse.equinox.console.command.adapter.Activator
Bundle-Vendor: %bundleVendor
Bundle-Localization: plugin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -96,36 +96,36 @@
* <li>gc - perform a garbage collection</li>
* <li>init - uninstall all bundles</li>
* <li>launch - start the Service Management Framework</li>
* <li>setprop <key>=<value> - set the OSGI property</li>
* <li>setprop {@code <key>=<value>} - set the OSGI property</li>
* <li>shutdown - shutdown the Service Management Framework</li>
* </ul>
* <p>
* ---Controlliing Bundles---
* </p>
* <ul>
* <li>install <url> {s[tart]} - install and optionally start bundle from the
* <li>install {@code <url>} {s[tart]} - install and optionally start bundle from the
* given URL</li>
* <li>refresh (<id>|<location>) - refresh the packages of the specified
* <li>refresh ({@code <id>|<location>}) - refresh the packages of the specified
* bundles</li>
* <li>start (<id>|<location>) - start the specified bundle(s)</li>
* <li>stop (<id>|<location>) - stop the specified bundle(s)</li>
* <li>uninstall (<id>|<location>) - uninstall the specified bundle(s)</li>
* <li>update (<id>|<location>|<*>) - update the specified bundle(s)</li>
* <li>start ({@code <id>|<location>}) - start the specified bundle(s)</li>
* <li>stop ({@code <id>|<location>}) - stop the specified bundle(s)</li>
* <li>uninstall ({@code <id>|<location>}) - uninstall the specified bundle(s)</li>
* <li>update ({@code <id>|<location>|<*>}) - update the specified bundle(s)</li>
* </ul>
* <p>
* ---Displaying Status---
* </p>
* <ul>
* <li>bundle (<id>|<location>) - display details for the specified
* <li>bundle ({@code <id>|<location>}) - display details for the specified
* bundle(s)</li>
* <li>bundles - display details for all installed bundles</li>
* <li>headers (<id>|<location>) - print bundle headers</li>
* <li>packages {<pkgname>|<id>|<location>} - display imported/exported package
* <li>headers ({@code <id>|<location>}) - print bundle headers</li>
* <li>packages {{@code <pkgname>|<id>|<location>}} - display imported/exported package
* details</li>
* <li>props - display System properties</li>
* <li>services {filter} - display registered service details. Examples for
* [filter]: (objectClass=com.xyz.Person);
* (&(objectClass=com.xyz.Person)(|(sn=Jensen)(cn=Babs J*))); passing only
* [filter]: {@code (objectClass=com.xyz.Person);
* (&(objectClass=com.xyz.Person)(|(sn=Jensen)(cn=Babs J*)));} passing only
* com.xyz.Person is a shortcut for (objectClass=com.xyz.Person). The filter
* syntax specification is available at http://www.ietf.org/rfc/rfc1960.txt</li>
* <li>ss - display installed bundles (short status)</li>
Expand All @@ -136,25 +136,25 @@
* ---Extras---
* </p>
* <ul>
* <li>exec <command> - execute a command in a separate process and wait</li>
* <li>fork <command> - execute a command in a separate process</li>
* <li>getprop <name> - Displays the system properties with the given name, or
* <li>exec {@code <command>} - execute a command in a separate process and wait</li>
* <li>fork {@code <command>} - execute a command in a separate process</li>
* <li>getprop {@code <name>} - Displays the system properties with the given name, or
* all of them.</li>
* <li>requiredBundles [<bsn>] - lists required bundles having the specified
* <li>requiredBundles [{@code <bsn>}] - lists required bundles having the specified
* symbolic name or all if no bsn is specified</li>
* <li>classSpaces [<bsn>] - lists required bundles having the specified
* <li>classSpaces [{@code <bsn>}] - lists required bundles having the specified
* symbolic name or all if no bsn is specified</li>
* </ul>
* <p>
* ---Controlling StartLevel---
* </p>
* <ul>
* <li>sl {(<id>|<location>)} - display the start level for the specified
* <li>sl {({@code <id>|<location>})} - display the start level for the specified
* bundle, or for the framework if no bundle specified</li>
* <li>setfwsl <start level> - set the framework start level</li>
* <li>setbsl <start level> (<id>|<location>) - set the start level for the
* <li>setfwsl {@code <start level>} - set the framework start level</li>
* <li>setbsl {@code <start level> (<id>|<location>)} - set the start level for the
* bundle(s)</li>
* <li>setibsl <start level> - set the initial bundle start level</li>
* <li>setibsl {@code <start level>} - set the initial bundle start level</li>
* </ul>
* <p>
* ---Eclipse Runtime commands---
Expand Down Expand Up @@ -1873,7 +1873,7 @@ private void getRequiredBundlePackages(BundleWire requiredWire, Set<String> impo
* an int
*
* @param value A string containing a potential startlevel
* @return The start level or an int <0 if it was invalid
* @return The start level or an int &lt;0 if it was invalid
*/
protected int getStartLevelFromToken(String value) {
int retval = -1;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -98,7 +98,7 @@ public void startService() {
* Provides help for the available commands. Prints the names, descriptions and
* parameters of all registered commands.
*
* If -scope <command_scope> is passed to the command, help is printed only for
* If -scope {@code <command_scope>} is passed to the command, help is printed only for
* the commands with the specified scope.
*
* If a command name is passed as argument to the help command, then the help
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,6 @@ public class Util {
/**
* Performs a quicksort of the given objects by their string representation in
* ascending order.
* <p>
*
* @param array The array of objects to sort
*/
Expand All @@ -33,13 +32,14 @@ public static void sortByString(Object[] array) {
* Sorts the array of objects by their string representation in ascending order.
* <p>
* This is a version of C.A.R Hoare's Quick Sort algorithm.
* </p>
*
* @param array the array of objects to sort
* @param start the start index to begin sorting
* @param stop the end index to stop sorting
*
* @exception ArrayIndexOutOfBoundsException when <code>start < 0</code> or
* <code>end >= array.length</code>
* @exception ArrayIndexOutOfBoundsException when <code>start &lt; 0</code> or
* <code>end &gt;= array.length</code>
*/
public static void qSortByString(Object[] array, int start, int stop) {
if (start >= stop)
Expand Down Expand Up @@ -95,9 +95,9 @@ public static void qSortByString(Object[] array, int start, int stop) {
* not implement Comparable or
* elements cannot be compared to each
* other
* @exception IllegalArgumentException when <code>start > end</code>
* @exception ArrayIndexOutOfBoundsException when <code>start < 0</code> or
* <code>end > array.size()</code>
* @exception IllegalArgumentException when {@code start > end}
* @exception ArrayIndexOutOfBoundsException when {@code start < 0} or
* {@code end > array.size()}
*/
@SuppressWarnings("unchecked")
public static void sort(Object[] array, int start, int end) {
Expand Down Expand Up @@ -137,9 +137,9 @@ public static void sort(Object[] array, int start, int end) {
* not implement Comparable or
* elements cannot be compared to each
* other
* @exception IllegalArgumentException when <code>start > end</code>
* @exception ArrayIndexOutOfBoundsException when <code>start < 0</code> or
* <code>end > array.size()</code>
* @exception IllegalArgumentException when {@code start > end}
* @exception ArrayIndexOutOfBoundsException when {@code start < 0} or
* {@code end > array.size()}
*/
public static void dsort(Object[] array, int start, int end) {
// first sort in ascending order
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.eclipse.equinox.device/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Bundle-ManifestVersion: 2
Bundle-Name: %bundleName
Bundle-Version: 1.2.100.qualifier
Bundle-Version: 1.2.200.qualifier
Bundle-Activator: org.eclipse.equinox.device.Activator
Bundle-SymbolicName: org.eclipse.equinox.device;deprecated:="Deprecated without any direct replacement, please use a different implementation or get in contact with the Equinox team to fix up this one"
Bundle-Vendor: %bundleVendor
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,21 +33,25 @@ public class DriverTracker extends ServiceTracker {
/** LogService object */
protected LogTracker log;

/** Dictionary mapping DRIVER_ID strings <==> Driver ServiceReferences */
/**
* Dictionary mapping {@code DRIVER_ID strings <==> Driver ServiceReferences}
*/
protected Hashtable<Object, Object> drivers;

/** DeviceManager object. */
protected Activator manager;

/**
* Dictionary mapping Driver ID String => Hashtable (Device ServiceReference =>
* cached Match objects)
* Dictionary mapping
* {@code Driver ID String => Hashtable (Device ServiceReference =>
* cached Match objects)}
*/
protected Hashtable<String, Hashtable<ServiceReference, Match>> matches;

/**
* Dictionary mapping Driver ID String => Hashtable (Device ServiceReference =>
* cached referral String)
* Dictionary mapping
* {@code Driver ID String => Hashtable (Device ServiceReference =>
* cached referral String)}
*/
protected Hashtable<String, Hashtable<ServiceReference, String>> referrals;

Expand Down
2 changes: 1 addition & 1 deletion bundles/org.eclipse.equinox.metatype/META-INF/MANIFEST.MF
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
Bundle-ManifestVersion: 2
Bundle-Name: %bundleName
Bundle-Version: 1.6.600.qualifier
Bundle-Version: 1.6.700.qualifier
Bundle-SymbolicName: org.eclipse.equinox.metatype
Bundle-Activator: org.eclipse.equinox.metatype.impl.Activator
Import-Package: javax.xml.parsers,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@
* attribute definition} allowing access to any
* {@link Extendable#getExtensionAttributes(String) extension attributes}
* provided by third parties.
* <p/>
* <p>
* For example, an Equinox attribute definition will contain all XML attributes
* specified as part of the &lt;AD/&gt; element with namespaces other than the
* metatype namespace as extension attributes.
* </p>
*
* @since 1.2
* @noimplement This interface is not intended to be implemented by clients.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,11 @@
* object class definition} allowing access to any
* {@link Extendable#getExtensionAttributes(String) extension attributes}
* provided by third parties.
* <p/>
* <p>
* For example, an Equinox object class definition will contain all XML
* attributes specified as part of the &lt;OCD/&gt; element with namespaces
* other than the metatype namespace as extension attributes.
* </p>
*
* @since 1.2
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,8 +19,8 @@
* a custom property added by a third party.
*
* The use case for this interface was to expose third party attributes included
* in the metadata XML on elements that support <anyAttribute/> according to the
* metatype schema, but it is not strictly limited to this use.
* in the metadata XML on elements that support {@code <anyAttribute/>}
* according to the metatype schema, but it is not strictly limited to this use.
*
* @since 1.2
*/
Expand Down
Loading
Loading