Skip to content

Commit

Permalink
Javadoc format fixes
Browse files Browse the repository at this point in the history 
Contributes to
eclipse-platform/eclipse.platform.releng.aggregator#1531
  • Loading branch information
@akurtakov @noopur2507
akurtakov authored and noopur2507 committed Dec 15, 2023
1 parent 8d43ac4 commit bd6867a
Show file tree
Hide file tree
Showing 21 changed files with 77 additions and 52 deletions.
2 changes: 2 additions & 0 deletions org.eclipse.jdt.core.compiler.batch/src/org/eclipse/jdt/core/compiler/CharOperation.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4047,11 +4047,13 @@ public static final char[][] splitOn(
* For example:
* <ol>
* <li><pre>
* {@code
* divider = ','
* array = { 'A' , '<', 'B', ',', 'C', '>', ',', 'D' }
* start = 0
* end = 8
* result => { { 'A' , '<', 'B', ',', 'C', '>'}, { 'D' }}
* }
* </pre>
* </li>
* </ol>
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.jdt.core.compiler.batch/src/org/eclipse/jdt/core/compiler/IProblem.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ public interface IProblem {
/**
* Problem Categories
* The high bits of a problem ID contains information about the category of a problem.
* For example, (problemID & TypeRelated) != 0, indicates that this problem is type related.
* For example, (problemID &amp; TypeRelated) != 0, indicates that this problem is type related.
*
* A problem category can help to implement custom problem filters. Indeed, when numerous problems
* are listed, focusing on import related problems first might be relevant.
Expand Down
2 changes: 2 additions & 0 deletions org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ASTNode.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1819,6 +1819,7 @@ public final ASTNode getParent() {
* Returns the location of this node within its parent,
* or <code>null</code> if this is a root node.
* <pre>
* {@code
* ASTNode node = ...;
* ASTNode parent = node.getParent();
* StructuralPropertyDescriptor location = node.getLocationInParent();
Expand All @@ -1827,6 +1828,7 @@ public final ASTNode getParent() {
* assert parent.getStructuralProperty(location) == node;
* if ((location != null) && location.isChildListProperty())
* assert ((List) parent.getStructuralProperty(location)).contains(node);
* }
* </pre>
* <p>
* Note that the relationship between an AST node and its parent node
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/ITypeBinding.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public interface ITypeBinding extends IBinding {
*
* @param dimension the given dimension
* @return an array type binding
* @throws IllegalArgumentException:<ul>
* @throws IllegalArgumentException <ul>
* <li>if the receiver represents the void type</li>
* <li>if the resulting dimensions is lower than one or greater than 255</li>
* </ul>
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/InfixExpression.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ public String toString() {
public static final Operator GREATER = new Operator(">");//$NON-NLS-1$
/** Less than or equals "&lt;=" operator. */
public static final Operator LESS_EQUALS = new Operator("<=");//$NON-NLS-1$
/** Greater than or equals "&gt=;" operator. */
/** Greater than or equals "&gt;=" operator. */
public static final Operator GREATER_EQUALS = new Operator(">=");//$NON-NLS-1$
/** Equals "==" operator. */
public static final Operator EQUALS = new Operator("==");//$NON-NLS-1$
Expand Down
2 changes: 2 additions & 0 deletions org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/RecordPattern.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,8 +22,10 @@
* TypePattern pattern AST node type.
*
* <pre>
* {@code
* RecordPattern:
* Pattern<Pattern<Patterns....>> Type SimpleName
* }
* </pre>
*
* @since 3.31
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.jdt.core/dom/org/eclipse/jdt/core/dom/rewrite/ImportRewrite.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1399,7 +1399,7 @@ public String[] getCreatedImports() {
* <p>
* Note that this list doesn't need to be the same as the added static imports ({@link #getAddedStaticImports()}) as
* implicit imports are not created and some imports are represented by on-demand imports instead.
* </p
* </p>
* @return the created imports
*/
public String[] getCreatedStaticImports() {
Expand Down
1 change: 0 additions & 1 deletion org.eclipse.jdt.core/formatter/org/eclipse/jdt/core/formatter/CodeFormatterApplication.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,6 @@
* files first so that a file does not get formatted twice. 2. Use a text based
* progress monitor for output.</p>
*
* @author Ben Konrath <bkonrath@redhat.com>
* @since 3.2
* @noinstantiate This class is not intended to be instantiated by clients.
* @noextend This class is not intended to be subclassed by clients.
Expand Down
34 changes: 17 additions & 17 deletions ...ipse.jdt.core/formatter/org/eclipse/jdt/core/formatter/DefaultCodeFormatterConstants.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -303,7 +303,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_ALIGNMENT_FOR_ARGUMENTS_IN_QUALIFIED_ALLOCATION_EXPRESSION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_arguments_in_qualified_allocation_expression"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option for alignment of assignment (=, +=, -=, *=, /=, %=, &=, ^=, |=, <<=, >>=, >>>=)
* FORMATTER / Option for alignment of assignment {@code (=, +=, -=, *=, /=, %=, &=, ^=, |=, <<=, >>=, >>>=) }
* - option id: "org.eclipse.jdt.core.formatter.alignment_for_assignment"
* - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
* - default: createAlignmentValue(false, WRAP_NO_SPLIT, INDENT_DEFAULT)
Expand Down Expand Up @@ -358,7 +358,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_ALIGNMENT_FOR_STRING_CONCATENATION = JavaCore.PLUGIN_ID + ".formatter.alignment_for_string_concatenation"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option for alignment of expressions with shift operators (<<, >>, >>>)
* FORMATTER / Option for alignment of expressions with shift operators {@code (<<, >>, >>>) }
* - option id: "org.eclipse.jdt.core.formatter.alignment_for_shift_operator"
* - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
* - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
Expand All @@ -369,7 +369,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_ALIGNMENT_FOR_SHIFT_OPERATOR = JavaCore.PLUGIN_ID + ".formatter.alignment_for_shift_operator"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option for alignment of expressions with relational operators (<, >, <=, >=, ==, !=)
* FORMATTER / Option for alignment of expressions with relational operators {@code (<, >, <=, >=, ==, !=)}
* - option id: "org.eclipse.jdt.core.formatter.alignment_for_relational_operator"
* - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
* - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
Expand All @@ -380,7 +380,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_ALIGNMENT_FOR_RELATIONAL_OPERATOR = JavaCore.PLUGIN_ID + ".formatter.alignment_for_relational_operator"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option for alignment of expressions with bitwise operators (&, ^, |)
* FORMATTER / Option for alignment of expressions with bitwise operators (&amp;, ^, |)
* - option id: "org.eclipse.jdt.core.formatter.alignment_for_bitwise_operator"
* - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
* - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
Expand All @@ -391,7 +391,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_ALIGNMENT_FOR_BITWISE_OPERATOR = JavaCore.PLUGIN_ID + ".formatter.alignment_for_bitwise_operator"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option for alignment of expressions with logical operators (&&, ||)
* FORMATTER / Option for alignment of expressions with logical operators (&amp;&amp;, ||)
* - option id: "org.eclipse.jdt.core.formatter.alignment_for_logical_operator"
* - possible values: values returned by <code>createAlignmentValue(boolean, int, int)</code> call
* - default: createAlignmentValue(false, WRAP_COMPACT, INDENT_DEFAULT)
Expand Down Expand Up @@ -2647,7 +2647,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_INSERT_SPACE_AFTER_STRING_CONCATENATION = JavaCore.PLUGIN_ID + ".formatter.insert_space_after_string_concatenation"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option to insert a space after a shift operator (<<, >>, >>>)
* FORMATTER / Option to insert a space after a shift operator {@code (<<, >>, >>>)}
* - option id: "org.eclipse.jdt.core.formatter.insert_space_after_shift_operator"
* - possible values: { INSERT, DO_NOT_INSERT }
* - default: INSERT
Expand All @@ -2659,7 +2659,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_INSERT_SPACE_AFTER_SHIFT_OPERATOR = JavaCore.PLUGIN_ID + ".formatter.insert_space_after_shift_operator"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option to insert a space after a relational operator (<, >, <=, >=, ==, !=)
* FORMATTER / Option to insert a space after a relational operator {@code (<, >, <=, >=, ==, !=)}
* - option id: "org.eclipse.jdt.core.formatter.insert_space_after_relational_operator"
* - possible values: { INSERT, DO_NOT_INSERT }
* - default: INSERT
Expand All @@ -2671,7 +2671,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_INSERT_SPACE_AFTER_RELATIONAL_OPERATOR = JavaCore.PLUGIN_ID + ".formatter.insert_space_after_relational_operator"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option to insert a space after a bitwise operator (&, ^, |)
* FORMATTER / Option to insert a space after a bitwise operator (&amp;, ^, |)
* - option id: "org.eclipse.jdt.core.formatter.insert_space_after_bitwise_operator"
* - possible values: { INSERT, DO_NOT_INSERT }
* - default: INSERT
Expand All @@ -2683,7 +2683,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_INSERT_SPACE_AFTER_BITWISE_OPERATOR = JavaCore.PLUGIN_ID + ".formatter.insert_space_after_bitwise_operator"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option to insert a space after a logical operator (&&, ||)
* FORMATTER / Option to insert a space after a logical operator (&amp;&amp;, ||)
* - option id: "org.eclipse.jdt.core.formatter.insert_space_after_logical_operator"
* - possible values: { INSERT, DO_NOT_INSERT }
* - default: INSERT
Expand Down Expand Up @@ -3552,7 +3552,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_INSERT_SPACE_BEFORE_STRING_CONCATENATION = JavaCore.PLUGIN_ID + ".formatter.insert_space_before_string_concatenation"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option to insert a space before a shift operator (<<, >>, >>>)
* FORMATTER / Option to insert a space before a shift operator {@code (<<, >>, >>>)}
* - option id: "org.eclipse.jdt.core.formatter.insert_space_before_shift_operator"
* - possible values: { INSERT, DO_NOT_INSERT }
* - default: INSERT
Expand All @@ -3564,7 +3564,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_INSERT_SPACE_BEFORE_SHIFT_OPERATOR = JavaCore.PLUGIN_ID + ".formatter.insert_space_before_shift_operator"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option to insert a space before a relational operator (<, >, <=, >=, ==, !=)
* FORMATTER / Option to insert a space before a relational operator {@code (<, >, <=, >=, ==, !=)}
* - option id: "org.eclipse.jdt.core.formatter.insert_space_before_relational_operator"
* - possible values: { INSERT, DO_NOT_INSERT }
* - default: INSERT
Expand All @@ -3576,7 +3576,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_INSERT_SPACE_BEFORE_RELATIONAL_OPERATOR = JavaCore.PLUGIN_ID + ".formatter.insert_space_before_relational_operator"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option to insert a space before a bitwise operator (&, ^, |)
* FORMATTER / Option to insert a space before a bitwise operator (&amp;, ^, |)
* - option id: "org.eclipse.jdt.core.formatter.insert_space_before_bitwise_operator"
* - possible values: { INSERT, DO_NOT_INSERT }
* - default: INSERT
Expand All @@ -3588,7 +3588,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_INSERT_SPACE_BEFORE_BITWISE_OPERATOR = JavaCore.PLUGIN_ID + ".formatter.insert_space_before_bitwise_operator"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option to insert a space before a logical operator (&&, ||)
* FORMATTER / Option to insert a space before a logical operator (&amp;&amp;, ||)
* - option id: "org.eclipse.jdt.core.formatter.insert_space_before_logical_operator"
* - possible values: { INSERT, DO_NOT_INSERT }
* - default: INSERT
Expand Down Expand Up @@ -5374,7 +5374,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_WRAP_BEFORE_STRING_CONCATENATION = JavaCore.PLUGIN_ID + ".formatter.wrap_before_string_concatenation"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option to wrap before the shift operator (<<, >>, >>>)
* FORMATTER / Option to wrap before the shift operator {@code (<<, >>, >>>)}
* - option id: "org.eclipse.jdt.core.formatter.wrap_before_shift_operator"
* - possible values: { TRUE, FALSE }
* - default: TRUE
Expand All @@ -5387,7 +5387,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_WRAP_BEFORE_SHIFT_OPERATOR = JavaCore.PLUGIN_ID + ".formatter.wrap_before_shift_operator"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option to wrap before the relational operator (<, >, <=, >=, ==, !=)
* FORMATTER / Option to wrap before the relational operator {@code (<, >, <=, >=, ==, !=)}
* - option id: "org.eclipse.jdt.core.formatter.wrap_before_"
* - possible values: { TRUE, FALSE }
* - default: TRUE
Expand All @@ -5400,7 +5400,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_WRAP_BEFORE_RELATIONAL_OPERATOR = JavaCore.PLUGIN_ID + ".formatter.wrap_before_relational_operator"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option to wrap before the bitwise operator (&, ^, |)
* FORMATTER / Option to wrap before the bitwise operator (&amp;, ^, |)
* - option id: "org.eclipse.jdt.core.formatter.wrap_before_bitwise_operator"
* - possible values: { TRUE, FALSE }
* - default: TRUE
Expand All @@ -5413,7 +5413,7 @@ public class DefaultCodeFormatterConstants {
public static final String FORMATTER_WRAP_BEFORE_BITWISE_OPERATOR = JavaCore.PLUGIN_ID + ".formatter.wrap_before_bitwise_operator"; //$NON-NLS-1$
/**
* <pre>
* FORMATTER / Option to wrap before the logical operator (&&, ||)
* FORMATTER / Option to wrap before the logical operator (&amp;&amp;, ||)
* - option id: "org.eclipse.jdt.core.formatter.wrap_before_logical_operator"
* - possible values: { TRUE, FALSE }
* - default: TRUE
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.jdt.core/formatter/org/eclipse/jdt/core/formatter/IndentManipulation.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ public static String extractIndentString(String line, int tabWidth, int indentWi
/**
* Removes the given number of indentation units from a given line. If the line
* has less indent than the given indentUnitsToRemove, all the available indentation is removed.
* If <code>indentsToRemove <= 0 or indent == 0</code> the line is returned.
* If <code>indentsToRemove &lt;= 0 or indent == 0</code> the line is returned.
*
* @param line the line to trim
* @param tabWidth the width of one tab in space equivalents
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.jdt.core/model/org/eclipse/jdt/core/CompletionProposal.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1800,7 +1800,7 @@ public void setReceiverRange(int startIndex, int endIndex) {
}

/**
* Returns whether it is safe to use the '<>' (diamond) operator in place of explicitly specifying
* Returns whether it is safe to use the {@code '<>'} (diamond) operator in place of explicitly specifying
* type arguments for this proposal.
*
* <p>
Expand Down
2 changes: 1 addition & 1 deletion org.eclipse.jdt.core/model/org/eclipse/jdt/core/Flags.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -511,7 +511,7 @@ public static boolean isModule(int flags) {
* unexpected description. Clients should ensure that the AccVarargs is not included in the flags of a method as follows:
* <pre>
* IMethod method = ...
* int flags = method.getFlags() & ~Flags.AccVarargs;
* int flags = method.getFlags() &amp; ~Flags.AccVarargs;
* return Flags.toString(flags);
* </pre>
* <p>
Expand Down
20 changes: 11 additions & 9 deletions org.eclipse.jdt.core/model/org/eclipse/jdt/core/ICodeAssist.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ public interface ICodeAssist {
*
* @exception JavaModelException if code assist could not be performed. Reasons include:<ul>
* <li>This Java element does not exist (ELEMENT_DOES_NOT_EXIST)</li>
* <li> The position specified is < -1 or is greater than this compilation unit's
* <li> The position specified is &lt; -1 or is greater than this compilation unit's
* source length (INDEX_OUT_OF_BOUNDS)
* </ul>
*
Expand All @@ -55,7 +55,7 @@ void codeComplete(int offset, ICodeCompletionRequestor requestor)
* @param requestor the given completion requestor
* @exception JavaModelException if code assist could not be performed. Reasons include:<ul>
* <li>This Java element does not exist (ELEMENT_DOES_NOT_EXIST)</li>
* <li> The position specified is < -1 or is greater than this compilation unit's
* <li> The position specified is &lt; -1 or is greater than this compilation unit's
* source length (INDEX_OUT_OF_BOUNDS)
* </ul>
*
Expand All @@ -77,7 +77,7 @@ void codeComplete(int offset, ICompletionRequestor requestor)
* @param requestor the given completion requestor
* @exception JavaModelException if code assist could not be performed. Reasons include:<ul>
* <li>This Java element does not exist (ELEMENT_DOES_NOT_EXIST)</li>
* <li> The position specified is < -1 or is greater than this compilation unit's
* <li> The position specified is &lt; -1 or is greater than this compilation unit's
* source length (INDEX_OUT_OF_BOUNDS)
* </ul>
*
Expand All @@ -100,7 +100,7 @@ void codeComplete(int offset, CompletionRequestor requestor)
* assist operation when a specified amount of time is reached could be used.
* </p>
*
* <pre>
* <pre>{@code
* new IProgressMonitor() {
* private final static int TIMEOUT = 500; //ms
* private long endTime;
Expand All @@ -112,14 +112,15 @@ void codeComplete(int offset, CompletionRequestor requestor)
* }
* ...
* };
* }
* </pre>
*
* @param offset the given offset position
* @param requestor the given completion requestor
* @param monitor the progress monitor used to report progress
* @exception JavaModelException if code assist could not be performed. Reasons include:<ul>
* <li>This Java element does not exist (ELEMENT_DOES_NOT_EXIST)</li>
* <li> The position specified is < -1 or is greater than this compilation unit's
* <li> The position specified is &lt; -1 or is greater than this compilation unit's
* source length (INDEX_OUT_OF_BOUNDS)
* </ul>
*
Expand Down Expand Up @@ -148,7 +149,7 @@ void codeComplete(int offset, CompletionRequestor requestor, IProgressMonitor mo
* @param owner the owner of working copies that take precedence over their original compilation units
* @exception JavaModelException if code assist could not be performed. Reasons include:<ul>
* <li>This Java element does not exist (ELEMENT_DOES_NOT_EXIST)</li>
* <li> The position specified is < -1 or is greater than this compilation unit's
* <li> The position specified is &lt; -1 or is greater than this compilation unit's
* source length (INDEX_OUT_OF_BOUNDS)
* </ul>
*
Expand Down Expand Up @@ -178,7 +179,7 @@ void codeComplete(int offset, ICompletionRequestor requestor, WorkingCopyOwner o
* @param owner the owner of working copies that take precedence over their original compilation units
* @exception JavaModelException if code assist could not be performed. Reasons include:<ul>
* <li>This Java element does not exist (ELEMENT_DOES_NOT_EXIST)</li>
* <li> The position specified is < -1 or is greater than this compilation unit's
* <li> The position specified is &lt; -1 or is greater than this compilation unit's
* source length (INDEX_OUT_OF_BOUNDS)
* </ul>
*
Expand Down Expand Up @@ -208,7 +209,7 @@ void codeComplete(int offset, CompletionRequestor requestor, WorkingCopyOwner ow
* assist operation when a specified amount of time is reached could be used.
* </p>
*
* <pre>
* <pre>{@code
* new IProgressMonitor() {
* private final static int TIMEOUT = 500; //ms
* private long endTime;
Expand All @@ -220,6 +221,7 @@ void codeComplete(int offset, CompletionRequestor requestor, WorkingCopyOwner ow
* }
* ...
* };
* }
* </pre>
*
* @param offset the given offset position
Expand All @@ -228,7 +230,7 @@ void codeComplete(int offset, CompletionRequestor requestor, WorkingCopyOwner ow
* @param monitor the progress monitor used to report progress
* @exception JavaModelException if code assist could not be performed. Reasons include:<ul>
* <li>This Java element does not exist (ELEMENT_DOES_NOT_EXIST)</li>
* <li> The position specified is < -1 or is greater than this compilation unit's
* <li> The position specified is &lt; -1 or is greater than this compilation unit's
* source length (INDEX_OUT_OF_BOUNDS)
* </ul>
*
Expand Down
Loading

0 comments on commit bd6867a

Please sign in to comment.