Skip to content

Commit

Permalink
Another round of javadoc fixes
Browse files Browse the repository at this point in the history
  • Loading branch information
akurtakov committed Dec 11, 2024
1 parent f80b0d5 commit ee05b6b
Show file tree
Hide file tree
Showing 29 changed files with 111 additions and 110 deletions.
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
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
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@
* {@link BundleIdBasedRegion} is an implementation of {@link Region} which
* keeps a track of the bundles in the region by recording their bundle
* identifiers.
* <p />
*
* <strong>Concurrent Semantics</strong><br />
* <p>
* <strong>Concurrent Semantics</strong>
* </p>
* Thread safe.
*/
public final class BundleIdBasedRegion implements Region {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,9 @@
/**
* {@link RegionLifecycleListener} is a service interface to listen for regions
* being added to and deleted from the region digraph.
* <p />
* <p>
* Note that this is an internal interface and is not intended for external use.
* <p />
* </p>
*
* <strong>Concurrent Semantics</strong><br />
* Implementations of this interface must be thread safe.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
/**
* Creates and manages the {@link RegionDigraph} associated with the running
* framework.
* <p />
*
* <strong>Concurrent Semantics</strong><br />
* <p>
* <strong>Concurrent Semantics</strong>
* </p>
*
* Threadsafe.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,9 +26,9 @@
/**
* {@link StandardRegionDigraph} is the default implementation of
* {@link RegionDigraph}.
* <p />
*
* <strong>Concurrent Semantics</strong><br />
* <p>
* <strong>Concurrent Semantics</strong>
* </p>
*
* Thread safe.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
/**
*
* Class used for reading and writing a region digraph to persistent storage.
* <p />
*
* <strong>Concurrent Semantics</strong><br />
* <p>
* <strong>Concurrent Semantics</strong>
* </p>
* Thread safe.
*/
public final class StandardRegionDigraphPersistence implements RegionDigraphPersistence {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
* The current implementation delegates to {@link RegionBundleFindHook}. This is
* likely to perform adequately because of the low frequency of bundle events
* and the typically small number of bundle listeners.
* <p />
* </p>
*
* <strong>Concurrent Semantics</strong><br />
* Thread safe.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -23,9 +23,9 @@
/**
* {@link RegionBundleFindHook} manages the visibility of bundles across regions
* according to the {@link RegionDigraph}.
* <p />
*
* <strong>Concurrent Semantics</strong><br />
* <p>
* <strong>Concurrent Semantics</strong>
* </p>
* Thread safe.
*/
public final class RegionBundleFindHook implements FindHook {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -25,9 +25,9 @@
/**
* {@link RegionResolverHook} manages the visibility of bundles across regions
* according to the {@link RegionDigraph}.
* <p />
*
* <strong>Concurrent Semantics</strong><br />
* <p>
* <strong>Concurrent Semantics</strong>
* </p>
* Thread safe.
*/
public final class RegionResolverHook implements ResolverHook {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,20 +14,18 @@

package org.eclipse.equinox.internal.region.hook;

import org.eclipse.equinox.region.RegionDigraph;

import java.util.Collection;

import org.eclipse.equinox.region.RegionDigraph;
import org.osgi.framework.hooks.resolver.ResolverHook;
import org.osgi.framework.hooks.resolver.ResolverHookFactory;
import org.osgi.framework.wiring.BundleRevision;

/**
* {@link RegionResolverHook} constructs an instance of
* {@link RegionResolverHook} for a particular resolution operation.
* <p />
*
* <strong>Concurrent Semantics</strong><br />
* <p>
* <strong>Concurrent Semantics</strong>
* </p>
*
* Thread safe.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
* The current implementation avoids traversing the graph multiple times from
* the same region. This is necessary to optimize the case where many bundles
* with service listeners are contained in the same region.
* <p />
* </p>
*
* <strong>Concurrent Semantics</strong><br />
* Thread safe.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,9 +22,9 @@
/**
* {@link RegionServiceFindHook} manages the visibility of services across
* regions according to the {@link RegionDigraph}.
* <p />
*
* <strong>Concurrent Semantics</strong><br />
* <p>
* <strong>Concurrent Semantics</strong>
* </p>
* Thread safe.
*/
public final class RegionServiceFindHook implements FindHook {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -14,22 +14,19 @@

package org.eclipse.equinox.internal.region.management;

import java.util.*;
import org.eclipse.equinox.region.Region;
import org.eclipse.equinox.region.RegionDigraph;
import org.eclipse.equinox.region.RegionDigraph.FilteredRegion;
import org.eclipse.equinox.region.management.ManageableRegion;
import org.eclipse.equinox.region.management.ManageableRegionDigraph;

import java.util.ArrayList;
import java.util.List;
import java.util.Set;

/**
* {@link StandardManageableRegion} is the default implementation of
* {@link ManageableRegion}.
* <p />
*
* <strong>Concurrent Semantics</strong><br />
* <p>
* <strong>Concurrent Semantics</strong>
* </p>
* Thread safe.
*/
public class StandardManageableRegion implements ManageableRegion {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,9 +28,9 @@
/**
* {@link StandardManageableRegionDigraph} is a {@link ManageableRegionDigraph}
* that delegates to the {@link RegionDigraph}.
* <p />
*
* <strong>Concurrent Semantics</strong><br />
* <p>
* <strong>Concurrent Semantics</strong>
* </p>
* Thread safe.
*/
public final class StandardManageableRegionDigraph implements ManageableRegionDigraph {
Expand Down
Loading

0 comments on commit ee05b6b

Please sign in to comment.