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

ui: fix javadoc #1204

Closed
wants to merge 1 commit into from
Closed
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 @@ -122,9 +122,9 @@ public static String getVersionName(String name) {
}

/**
* Returns a label for Java element name. Example is 'new Test<? extends List>()
* { ...}'. This method should only be used for simple element names. Use
* JavaElementLabels to create a label from a Java element.
* Returns a label for Java element name. Example is {@code 'new Test<? extends
* List>() { ...}'}. This method should only be used for simple element names.
* Use JavaElementLabels to create a label from a Java element.
*
* @param name the Java element name.
* @return the label for the Java element
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -193,7 +193,7 @@ public ILaunchConfiguration getRerunLaunchConfiguration(List<ITestElement> tests
ILaunchConfigurationWorkingCopy res;
try {
res = launchConfiguration.copy(launchConfiguration.getName() + " - rerun"); //$NON-NLS-1$
res.setAttribute(JUnitLaunchConfigurationConstants.ATTR_TEST_METHOD_NAME, testMethodName);
res.setAttribute(JUnitLaunchConfigurationConstants.ATTR_TEST_NAME, testMethodName);
return res;
} catch (CoreException e) {
JUnitTestPlugin.log(e);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -857,7 +857,7 @@ public static void exclude(IPath path, List<CPListElement> existingEntries, List
* @param project the Java project
* @param monitor progress monitor, can be <code>null</code>
*
* @return the resulting <code>IResource<code>
* @return the resulting <code>IResource</code>
*/
public static IResource exclude(IJavaElement javaElement, CPListElement entry, IJavaProject project, IProgressMonitor monitor) {
if (monitor == null)
Expand Down Expand Up @@ -1031,8 +1031,10 @@ public static void commitClassPath(CPJavaProject cpProject, IProgressMonitor mon
*
* @param entries a list of entries to find an appropriate representation
* for. The list can contain elements of two types:
* <ul>
* <li><code>IResource</code></li>
* <li><code>IJavaElement</code></li>
* </ul>
* @param project the Java project
* @return a list of elements corresponding to the passed entries.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,12 +18,12 @@
/**
* The context type for templates inside Java code.
* The same class is used for several context types:
* <dl>
* <ul>
* <li>templates for all Java code locations</li>
* <li>templates for member locations</li>
* <li>templates for statement locations</li>
* <li>templates for module-info.java files</li>
* </dl>
* </ul>
*/
public class JavaContextType extends AbstractJavaContextType {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -18,11 +18,11 @@
/**
* The context type for templates inside SWT code.
* The same class is used for several context types:
* <dl>
* <ul>
* <li>templates for all Java code locations</li>
* <li>templates for member locations</li>
* <li>templates for statement locations</li>
* </dl>
* </ul>
* @since 3.4
*/
public class SWTContextType extends AbstractJavaContextType {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -198,7 +198,7 @@ public void run() {
/**
* Returns <code>true</code> if the group is enabled.
* <pre>
* Invariant: isEnabled() <=> fViewer and all actions are != null.
* Invariant: isEnabled() == fViewer and all actions are != null.
* </pre>
*
* @return <code>true</code> if the group is enabled
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -155,7 +155,7 @@ private IJavaElement[] getCategoryFilterActionGroupInput() {
* input for this part.
*
* @param element the object to test
* @return <true> if the given element is a valid input
* @return <code>true</code> if the given element is a valid input
*/
@Override
protected boolean isValidInput(Object element) {
Expand All @@ -171,7 +171,7 @@ protected boolean isValidInput(Object element) {
* element for this part.
*
* @param element the object to test
* @return <true> if the given element is a valid element
* @return <code>true</code> if the given element is a valid element
*/
@Override
protected boolean isValidElement(Object element) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -281,7 +281,7 @@ protected String getLinkToEditorKey() {
* input for this part.
*
* @param element the object to test
* @return <true> if the given element is a valid input
* @return <code>true</code> if the given element is a valid input
*/
@Override
protected boolean isValidInput(Object element) {
Expand All @@ -301,7 +301,7 @@ protected boolean isValidInput(Object element) {
* element for this part.
*
* @param element the object to test
* @return <true> if the given element is a valid element
* @return <code>true</code> if the given element is a valid element
*/
@Override
protected boolean isValidElement(Object element) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -130,7 +130,7 @@ protected void setInitialInput() {
* input for this part.
*
* @param element the object to test
* @return <true> if the given element is a valid input
* @return <code>true</code> if the given element is a valid input
*/
@Override
protected boolean isValidInput(Object element) {
Expand All @@ -142,7 +142,7 @@ protected boolean isValidInput(Object element) {
* element for this part.
*
* @param element the object to test
* @return <true> if the given element is a valid element
* @return <code>true</code> if the given element is a valid element
*/
@Override
protected boolean isValidElement(Object element) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -86,7 +86,7 @@ protected void addFilters() {
* input for this part.
*
* @param element the object to test
* @return <true> if the given element is a valid input
* @return <code>true</code> if the given element is a valid input
*/
@Override
protected boolean isValidInput(Object element) {
Expand All @@ -98,7 +98,7 @@ protected boolean isValidInput(Object element) {
* element for this part.
*
* @param element the object to test
* @return <true> if the given element is a valid element
* @return <code>true</code> if the given element is a valid element
*/
@Override
protected boolean isValidElement(Object element) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
*
* where <code>parameterSignatures</code> uses the signature format documented
* in the {@link org.eclipse.jdt.core.Signature Signature} class.
* </p>
*
* @since 3.2
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -40,7 +40,6 @@
* </ul>
* The <code>setFeedbackEnabled</code> method can be called to turn on and off
* visual insertion feedback (on by default).
* </p>
* <p>
* THIS IS (ALMOST) A ONE-TO-ONE COPY OF PLATFORMS ViewerDropAdapter
* REFERE THERE FIRST IF YOU NEED TO FIX SOMETHING.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,10 +48,9 @@
import org.eclipse.jdt.internal.ui.util.SWTUtil;

/**
* A drag adapter that transfers the current selection as </code>
* IResource</code>. Only those elements in the selection are part
* of the transfer which can be converted into an <code>IResource
* </code>.
* A drag adapter that transfers the current selection as <code>IResource</code>. Only those
* elements in the selection are part of the transfer which can be converted into an
* <code>IResource</code>.
*/
public class ResourceTransferDragAdapter extends DragSourceAdapter implements TransferDragSourceListener {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,13 @@
/**
* A fix that replaces <code>System.getProperty(xxx)</code> by Java methods:
* <ul>
* <li>Beware! The code doesn't any longer take the system property into account!</li>
*
* System.getProperties() can be overridden by calls to System.setProperty(String key, String value)
* <li> System.getProperties() can be overridden by calls to System.setProperty(String key, String value)
* or with command line parameters -Dfile.separator=/
* <br><b>Beware! The code doesn't any longer take the system property into account!</b>
*
* File.separator gets the separator for the default filesystem.
* <li>File.separator gets the separator for the default filesystem.
*
* FileSystems.getDefault() gets you the default filesystem.
* <li>FileSystems.getDefault() gets you the default filesystem.
* </ul>
*/
public class ConstantsForSystemPropertyCleanUp extends AbstractCleanUpCoreWrapper<ConstantsForSystemPropertiesCleanUpCore> {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,8 +44,8 @@
/**
* A fix that uses lazy logical operator when possible:
* <ul>
* <li>Replaces & by &&,</li>
* <li>Replaces | by ||.</li>
* <li>Replaces {@code &} by {@code &&},</li>
* <li>Replaces {@code |} by {@code ||}.</li>
* </ul>
*/
public class LazyLogicalCleanUp extends AbstractMultiFix {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,7 @@
import org.eclipse.jdt.ui.text.java.IProblemLocation;

/**
* A fix that replaces (X && Y) || (X && Z) by (X && (Y || Z)):
* A fix that replaces {@code (X && Y) || (X && Z) by (X && (Y || Z))}:
* <ul>
* <li>The operators can be lazy or eager,</li>
* <li>The factor operand must be passive and primitive,</li>
Expand All @@ -54,7 +54,7 @@
* </ul>
*
* Truth table:
* <pre>
* <pre>{@code
-------------------------------------------------------------------------------------------
| a | b | c | (a && b) || (a && c) | a && (b || c) | (a || b) && (a || c) | a || (b && c) |
| 0 | 0 | 0 | 0 | 0 | 0 | 0 |
Expand All @@ -66,7 +66,7 @@
| 1 | 1 | 0 | 1 | 1 | 1 | 1 |
| 1 | 1 | 1 | 1 | 1 | 1 | 1 |
-------------------------------------------------------------------------------------------
</pre>
}</pre>
*/
public class OperandFactorizationCleanUp extends AbstractMultiFix {
public OperandFactorizationCleanUp() {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,7 @@
* <li>Within an interface modifiers <code>public</code>, <code>static</code> and <code>final</code>
* are redundant for field declarations.</li>
* <li>Within an interface modifier <code>public</code> and
* <code>abstract</code are redundant for method declarations.</li>
* <code>abstract</code> are redundant for method declarations.</li>
* <li>Within a final class the <code>final</code> modifier is redundant for method
* declarations.</li>
* <li>For nested interfaces the <code>static</code> modifier is redundant.</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,7 @@
import org.eclipse.jdt.ui.text.java.IProblemLocation;

/**
* A fix that replaces <code>(X && !Y) || (!X && Y)</code> by <code>X ^ Y</code>:
* A fix that replaces {@code (X && !Y) || (!X && Y)} by {@code X ^ Y}:
* <ul>
* <li>Only works on boolean,</li>
* <li>Works with lazy or eager operators,</li>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
import org.eclipse.jdt.ui.text.java.IProblemLocation;

/**
* A fix that replaces <code>(X && Y) || (!X && Z)</code> by <code>X ? Y : Z</code>:
* A fix that replaces {@code (X && Y) || (!X && Z)} by {@code X ? Y : Z}:
* <ul>
* <li>The operands must be passive and boolean.</li>
* </ul>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@
* for associated refactorings, the wizard executes eventual refactorings,
* copies the JAR file over its old version, the dialog closes, and the call to
* <code>open</code> returns.
* </p>
*
* @since 3.2
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,7 +70,6 @@
* user. When the user hits Finish, the user-selected workspace resources
* are exported to the user-specified zip file, the dialog closes, and the call
* to <code>open</code> returns.
* </p>
*/
public class JarPackageWizard extends Wizard implements IExportWizard {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -1118,7 +1118,7 @@ protected void setCaretPosition(final int position) {
* not its enclosing Java element.</li>
* <li>If the selection spans one or more partitions of the document, then all
* partitions covered by the selection are entirely formatted.</li>
* <p>
* </ul>
* Partitions at the end of the selection are not completed, except for comments.
*
* @since 3.0
Expand Down Expand Up @@ -3822,7 +3822,7 @@ public ISelectionProvider getSelectionProvider() {
* Returns the cached selected range, which allows
* to query it from a non-UI thread.
* <p>
* The result might be outdated if queried from a non-UI thread.</em></p>
* The result might be outdated if queried from a non-UI thread.
*
* @return the caret offset in the master document
* @see ITextViewer#getSelectedRange()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -132,7 +132,7 @@ public void endCompoundEdit() {
* [0] move up
* [1] move down
* [2] copy up (duplicate)
* [3] copy down (duplicate & select)
* [3] copy down (duplicate and select)
* @param bundle the resource bundle
* @param editor the editor
* @return the quadruple of actions
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@
* Action which gets triggered when selecting (annotations) in the vertical ruler.
*
* <p>
* Was originally called >code>JavaSelectMarkerRulerAction</code>.
* Was originally called <code>JavaSelectMarkerRulerAction</code>.
* </p>
*/
public class JavaSelectAnnotationRulerAction extends SelectMarkerRulerAction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,13 +88,13 @@ public interface IPostSaveListener {
* <li>must not assume to be called in the UI thread</li>
* <li>should be as fast as possible since this code is executed every time the <code>compilationUnit</code> is saved</li>
* </ul>
* The compilation unit document provider can disable a listener that violates any of the above rules.</p>
* The compilation unit document provider can disable a listener that violates any of the above rules.
*
* @param compilationUnit
* the compilation unit which was saved
* @param changedRegions
* the regions where the compilationUnit has changed since the last save
* or <b>null</b> if </code>requiresChangedRegions</code> did return <code>false</code>.
* or <b>null</b> if <code>requiresChangedRegions</code> did return <code>false</code>.
* The changed regions do not include changes introduced by other save participants.
* @param monitor
* the progress monitor for reporting progress
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -89,7 +89,7 @@ public interface ISaveParticipantPreferenceConfiguration {

/**
* Called when a compilation unit is saved.
* <p>
*
* @param context the context in which the compilation unit is saved
* @return true if the corresponding {@link IPostSaveListener} needs to be informed
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -581,7 +581,7 @@ private ProblemTreeViewer createViewer(Composite composite) {

/**
* Answers whether this part shows the packages flat or hierarchical.
* @return <true> if flat layout is selected
* @return <code>true</code> if flat layout is selected
*
* @since 2.1
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,6 @@
* <li>pattern ~valueFilter</li>
* <li>~valueFilter pattern</li>
* </ul>
* </p>
*/
public class FilteredPreferenceTree {

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ public interface IPropertiesFilePartitions {

/**
* Array with properties file partitions.
* Value: {@value}
*/
String[] PARTITIONS= new String[] { COMMENT, PROPERTY_VALUE };

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -52,7 +52,6 @@
* {@link PropertiesFileEscapes#containsInvalidEscapeSequence(String)}</li>
* <li>a character which requires Unicode escapes</li>
* </ul>
* </p>
*
* @since 3.7
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -224,7 +224,6 @@ List<CompletionProposalComputerDescriptor> getProposalComputerDescriptors() {
* Returns the list of proposal categories contributed to the
* <code>javaCompletionProposalComputer</code> extension point.
* <p>
* <p>
* The returned list is read-only and is sorted in the order that the extensions were read in.
* There are no duplicate elements in the returned list. The returned list may change if
* plug-ins are loaded or unloaded while the application is running.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -93,7 +93,6 @@
* contexts are provided)</li>
* <li><code>getErrorMessage</code> to change error reporting</li>
* </ul>
* </p>
*
* @since 3.2
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
* <p>
* This collector is used when
* {@link PreferenceConstants#CODEASSIST_FILL_ARGUMENT_NAMES} is enabled.
* <p/>
*/
public final class FillArgumentNamesCompletionProposalCollector extends CompletionProposalCollector {

Expand Down
Loading
Loading