Skip to content

Commit

Permalink
Eliminate Javadoc errors
Browse files Browse the repository at this point in the history
  • Loading branch information
merks committed Sep 18, 2024
1 parent 4a873fb commit 699e7dc
Show file tree
Hide file tree
Showing 22 changed files with 177 additions and 135 deletions.
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.p2.artifact.repository;singleton:=true
Bundle-Version: 1.5.400.qualifier
Bundle-Version: 1.5.500.qualifier
Bundle-Activator: org.eclipse.equinox.internal.p2.artifact.repository.Activator
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,8 +40,7 @@ public final class PGPSignatureVerifier extends ProcessingStep {

/**
* ID of the registering
* <code>org.eclipse.equinox.p2.artifact.repository.processingSteps</tt>
* extension.
* {@code org.eclipse.equinox.p2.artifact.repository.processingSteps} extension.
*/
public static final String ID = "org.eclipse.equinox.p2.processing.PGPSignatureCheck"; //$NON-NLS-1$

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -35,13 +35,13 @@
import org.xml.sax.SAXException;

/**
* Mirror support class for repositories. This class implements
* mirror support equivalent to the mirroring of update manager sites. A repository
* optionally provides a mirror URL via the {@link IRepository#PROP_MIRRORS_URL} key.
* The contents of the file at this URL is expected to be an XML document
* containing a list of <mirror> elements. The mirrors are assumed to be already
* sorted geographically with closer mirrors first.
* <br><br>
* Mirror support class for repositories. This class implements mirror support
* equivalent to the mirroring of update manager sites. A repository optionally
* provides a mirror URL via the {@link IRepository#PROP_MIRRORS_URL} key. The
* contents of the file at this URL is expected to be an XML document containing
* a list of &lt;mirror&gt; elements. The mirrors are assumed to be already
* sorted geographically with closer mirrors first. <br>
* <br>
* Always use {@link MirrorSelector.MirrorInfoComparator} for comparison.
*/
public class MirrorSelector {
Expand Down
2 changes: 1 addition & 1 deletion bundles/org.eclipse.equinox.p2.core/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: %pluginName
Bundle-SymbolicName: org.eclipse.equinox.p2.core;singleton:=true
Bundle-Version: 2.12.100.qualifier
Bundle-Version: 2.12.200.qualifier
Bundle-Activator: org.eclipse.equinox.internal.p2.core.Activator
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,14 +55,13 @@ public OrderedProperties(Map<String, String> properties) {
/**
* Set the property value.
* <p>
* If a property with the key already exists, the previous
* value is replaced. Otherwise a new property is added at
* the end collection.
* If a property with the key already exists, the previous value is replaced.
* Otherwise a new property is added at the end collection.
*
* @param key must not be null
* @param value must not be null
* @return previous value associated with specified key, or <tt>null</tt>
* if there was no mapping for key.
* @return previous value associated with specified key, or {@code null} if
* there was no mapping for key.
*/
public Object setProperty(String key, String value) {
init();
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: %Bundle-Name
Bundle-SymbolicName: org.eclipse.equinox.p2.discovery.compatibility;singleton:=true
Bundle-Version: 1.3.400.qualifier
Bundle-Version: 1.3.500.qualifier
Bundle-Vendor: %Bundle-Vendor
Bundle-RequiredExecutionEnvironment: JavaSE-17
Require-Bundle: org.eclipse.core.runtime;bundle-version="3.29.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@

/**
* Connector Discovery extension point reader, for extension points of type
* <tt>org.eclipse.mylyn.discovery.core.connectorDiscovery</tt>
* {@code org.eclipse.mylyn.discovery.core.connectorDiscovery}
*
* @author David Green
*/
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: %Bundle-Name
Bundle-SymbolicName: org.eclipse.equinox.p2.discovery;singleton:=true
Bundle-Version: 1.3.300.qualifier
Bundle-Version: 1.3.400.qualifier
Bundle-Vendor: %Bundle-Vendor
Bundle-RequiredExecutionEnvironment: JavaSE-17
Require-Bundle: org.eclipse.core.runtime;bundle-version="3.29.0",
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -108,8 +108,7 @@ public boolean isSelected() {
/**
* support selection
*
* @param selected
* true if the item is selected, otherwise false
* @param selected true if the item is selected, otherwise false
*/
public void setSelected(boolean selected) {
this.selected = selected;
Expand All @@ -127,8 +126,8 @@ public Boolean getAvailable() {
/**
* indicate if this connector is available
*
* @param available
* true if available, false if not, or null if availability is unknown
* @param available true if available, false if not, or null if availability is
* unknown
*/
public void setAvailable(Boolean available) {
if (available != this.available || (available != null && !available.equals(this.available))) {
Expand All @@ -155,8 +154,8 @@ public void removePropertyChangeListener(String propertyName, PropertyChangeList
}

/**
* the name of the connector including the name of the organization that produces the repository if appropriate, for
* example 'Mozilla Bugzilla'.
* the name of the connector including the name of the organization that
* produces the repository if appropriate, for example 'Mozilla Bugzilla'.
*/
public String getName() {
return name;
Expand All @@ -178,7 +177,8 @@ public void setProvider(String provider) {
}

/**
* The short name of the license, for example 'EPL 1.0', 'GPL 2.0', or 'Commercial'.
* The short name of the license, for example 'EPL 1.0', 'GPL 2.0', or
* 'Commercial'.
*/
public String getLicense() {
return license;
Expand All @@ -189,10 +189,9 @@ public void setLicense(String license) {
}

/**
* A description of the connector. Plug-ins should provide a description, especially if the description is not
* self-evident from the @name and
*
* @organization.
* A description of the connector. Plug-ins should provide a description,
* especially if the description is not self-evident from the @name and
* organization.
*/
public String getDescription() {
return description;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -281,31 +281,36 @@ public static void gatherCertificates(Map<URI, List<Certificate>> authorities, I
}

/**
* <p>
* Returns a list of URIs representing the hierarchical chain, starting from the
* root authority, to the given location. The location will always be present as
* the last element in the list. The first element represents the root
* authority.
* </p>
*
* <ul>
* <li>file:/C:/folder/file</li>
* <li>file:/C:/folder/file
* <ul>
* <li>file:/</li>
* <li>file:/C:/</li>
* <li>file:/C:/folder/</li>
* </ul>
* <li>https://host/folder/file</li>
* </li>
* <li>https://host/folder/file
* <ul>
* <li>https://host</li>
* <li>https://host/folder/</li>
* <li>https://host/folder/file</li>
* </ul>
* <li>jar:https://host/folder/file.jar!/path</li>
* </li>
* <li>jar:https://host/folder/file.jar!/path
* <ul>
* <li>https://host</li>
* <li>https://host/folder/</li>
* <li>https://host/folder/file.jar</li>
* <li>jar:https://host/folder/file.jar!/path</li>
* </ul>
* </li>
* </ul>
*
* @param location an arbitrary location.
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.p2.garbagecollector;singleton:=true
Bundle-Version: 1.3.300.qualifier
Bundle-Version: 1.3.400.qualifier
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Export-Package: org.eclipse.equinox.internal.p2.garbagecollector;x-friends:="org.eclipse.equinox.p2.touchpoint.eclipse,org.eclipse.pde.core,org.eclipse.equinox.p2.ui.sdk.scheduler"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,10 +18,11 @@
import org.eclipse.equinox.p2.repository.artifact.IArtifactRepository;

/**
* Any class which declares itself as an extension to the <tt>org.eclipse.equinox.p2.garbagecollector.marksetproviders</tt>
* extension point must extend this base class. Given a Profile, implementors are required
* to provide an array of MarkSet objects, each of which must contain an IArtifactRepository
* and the IArtifactKeys used by the given Profile.
* Any class which declares itself as an extension to the
* {@code org.eclipse.equinox.p2.garbagecollector.marksetproviders} extension
* point must extend this base class. Given a Profile, implementors are required
* to provide an array of MarkSet objects, each of which must contain an
* IArtifactRepository and the IArtifactKeys used by the given Profile.
*/
public abstract class MarkSetProvider {

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.p2.metadata;singleton:=true
Bundle-Version: 2.9.100.qualifier
Bundle-Version: 2.9.200.qualifier
Bundle-Vendor: %providerName
Bundle-Localization: plugin
Export-Package: org.eclipse.equinox.internal.p2.metadata;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,30 +26,17 @@
* <p>
* The format of a touchpoint instruction statement sequence is as follows:
*
* statement-sequence :
* | statement ';'
* | statement-sequence statement
* ;
* statement-sequence : | statement ';' | statement-sequence statement ;
*
*Where a statement is of the format:
* Where a statement is of the format:
*
* statement :
* | actionName '(' parameters ')'
* ;
* statement : | actionName '(' parameters ')' ;
*
* parameters :
* | // empty
* | parameter
* | parameters ',' parameter
* ;
* parameters : | // empty | parameter | parameters ',' parameter ;
*
* parameter :
* | paramName ':' paramValue
* ;
* parameter : | paramName ':' paramValue ;
*
* actionName, paramName, paramValue :
* | String
* ;
* actionName, paramName, paramValue : | String ;
*
* @noextend This class is not intended to be subclassed by clients.
* @see MetadataFactory#createTouchpointInstruction(String, String)
Expand All @@ -60,12 +47,13 @@ public class TouchpointInstruction implements ITouchpointInstruction {
private final String importAttribute;

/**
* Encodes an action statement in string form. This method will
* take care of escaping any illegal characters in function parameter values.
* Encodes an action statement in string form. This method will take care of
* escaping any illegal characters in function parameter values.
*
* @param actionName The name of the action.
* @param parameters The function's parameters. This is a Map<String,String>
* where the keys are parameter names, and the values are parameter values
* @param parameters The function's parameters. This is a
* Map&lt;String,String&gt; where the keys are parameter names
* and the values are parameter values
* @return An encoded touchpoint instruction statement
*/
public static String encodeAction(String actionName, Map<String, String> parameters) {
Expand Down Expand Up @@ -93,16 +81,16 @@ private static void appendEncoded(StringBuilder buf, String value) {
char[] chars = value.toCharArray();
for (char c : chars) {
switch (c) {
case '$' :
case ',' :
case ':' :
case ';' :
case '{' :
case '}' :
buf.append("${#").append(Integer.toString(c)).append('}'); //$NON-NLS-1$
break;
default :
buf.append(c);
case '$':
case ',':
case ':':
case ';':
case '{':
case '}':
buf.append("${#").append(Integer.toString(c)).append('}'); //$NON-NLS-1$
break;
default:
buf.append(c);
}
}
}
Expand Down Expand Up @@ -138,8 +126,8 @@ public boolean equals(Object obj) {
}

/**
* Returns the body of this touchpoint instruction. The body is either a sequence
* of instruction statements, or a simple string value.
* Returns the body of this touchpoint instruction. The body is either a
* sequence of instruction statements, or a simple string value.
*
* @return The body of this touchpoint instruction
*/
Expand All @@ -148,7 +136,7 @@ public String getBody() {
return body;
}

//TODO What is this? Please doc
// TODO What is this? Please doc
@Override
public String getImportAttribute() {
return importAttribute;
Expand All @@ -164,7 +152,8 @@ public int hashCode() {
}

/**
* Returns a string representation of this instruction for debugging purposes only.
* Returns a string representation of this instruction for debugging purposes
* only.
*/
@Override
public String toString() {
Expand Down
Loading

0 comments on commit 699e7dc

Please sign in to comment.