Fix javadoc generation in terminal

akurtakov · akurtakov · commit 064f2eb71e28 · 2025-06-07T13:14:35.000+03:00
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/control/CommandInputFieldWithHistory.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/control/CommandInputFieldWithHistory.java
@@ -42,14 +42,14 @@
 /**
  * Manages the Command History for the command line input
  * of the terminal control.
- * <li>
- * <ul>Navigate with ARROW_UP,ARROW_DOWN,PAGE_UP,PAGE_DOWN
- * <ul>ESC to cancel history editing
- * <ul>History can be edited (by moving up and edit) but changes are
- * not persistent (like in bash).
- * <ul>If the same command is entered multiple times in a row,
- * only one entry is kept in the history.
- * </li>
+ * <ul>
+ * <li>Navigate with ARROW_UP,ARROW_DOWN,PAGE_UP,PAGE_DOWN</li>
+ * <li>ESC to cancel history editing</li>
+ * <li>History can be edited (by moving up and edit) but changes are
+ * not persistent (like in bash).</li>
+ * <li>If the same command is entered multiple times in a row,
+ * only one entry is kept in the history.</li>
+ * </ul>
  *
  */
 public class CommandInputFieldWithHistory implements ICommandInputField {
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/control/ITerminalListener.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/control/ITerminalListener.java
@@ -13,6 +13,7 @@
  *******************************************************************************/
 package org.eclipse.tm.internal.terminal.control;
 
+import org.eclipse.tm.internal.terminal.control.ITerminalListener3.TerminalTitleRequestor;
 import org.eclipse.tm.internal.terminal.provisional.api.TerminalState;
 
 /**
@@ -29,7 +30,7 @@ public interface ITerminalListener {
 
 	/**
 	 * @deprecated Migrate to implementing {@link ITerminalListener3} and
-	 * override {@link ITerminalListener3#setTerminalTitle(String, String)
+	 * override {@link ITerminalListener3#setTerminalTitle(String, TerminalTitleRequestor)}
 	 * @param title
 	 */
 	@Deprecated(forRemoval = true)
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/control/ITerminalListener3.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/control/ITerminalListener3.java
@@ -12,7 +12,7 @@
 /**
  * Terminal listener allowing to listen to terminal selection changes.
  * The interface overrides the deprecated {@link #setTerminalTitle(String)} with
- * {@link #setTerminalTitle(String, String)} that should be called instead.
+ * {@link #setTerminalTitle(String, TerminalTitleRequestor)} that should be called instead.
  *
  * @since 5.5
  */
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/control/ITerminalViewControl.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/control/ITerminalViewControl.java
@@ -194,7 +194,7 @@ public interface ITerminalViewControl {
 
 	/**
 	 * @since 5.1
-	 * @deprecated call {@link #setTerminalTitle(String, String)} instead
+	 * @deprecated call {@link #setTerminalTitle(String, TerminalTitleRequestor)} instead
 	 */
 	@Deprecated(forRemoval = true)
 	void setTerminalTitle(String newTitle);
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/emulator/IVT100EmulatorBackend.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/emulator/IVT100EmulatorBackend.java
@@ -121,7 +121,7 @@ public interface IVT100EmulatorBackend {
 	 * There are never any ANSI control characters or escape sequences in the
 	 * text being displayed by this method (this includes newlines, carriage
 	 * returns, and tabs).
-	 * <p>
+	 * </p>
 	 */
 	void appendString(String buffer);
 
@@ -143,7 +143,7 @@ public interface IVT100EmulatorBackend {
 	 * code) _always_ interprets a CR to mean "move the cursor to the beginning
 	 * of the current line" and a NL to mean "move the cursor to the same column
 	 * on the next line".
-	 * <p>
+	 * </p>
 	 */
 	void processNewline();
 
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/emulator/VT100Emulator.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/emulator/VT100Emulator.java
@@ -60,10 +60,6 @@
  * return, linefeed, and a subset of ANSI escape sequences sufficient to allow
  * use of screen-oriented applications, such as vi, Emacs, and any GNU
  * readline-enabled application (Bash, bc, ncftp, etc.).
- * <p>
- *
- * @author Fran Litterio <francis.litterio@windriver.com>
- * @author Chris Thew <chris.thew@windriver.com>
  */
 public class VT100Emulator implements ControlListener {
 	/** This is a character processing state: Initial state. */
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/emulator/VT100TerminalControl.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/emulator/VT100TerminalControl.java
@@ -132,8 +132,6 @@
  * methods in the nested classes directly access the fields of the enclosing class.
  * One day we should pull the nested classes out into their own source files (but still
  * in this package).
- *
- * @author Chris Thew <chris.thew@windriver.com>
  */
 public class VT100TerminalControl implements ITerminalControlForText, ITerminalControl, ITerminalViewControl {
 	protected final static String[] LINE_DELIMITERS = { "\n" }; //$NON-NLS-1$
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/preferences/TerminalColorsFieldEditor.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/preferences/TerminalColorsFieldEditor.java
@@ -62,8 +62,6 @@ public class TerminalColorsFieldEditor extends FieldEditor {
 
 	/**
 	 * Creates a field editor for editing colors of {@link TerminalColor}.
-	 * The preference names used are as they are returned from {@link TerminalColor#getPreferenceName()}
-	 * @param parent
 	 */
 	public TerminalColorsFieldEditor(Composite parent) {
 		super("", "", parent); //$NON-NLS-1$ //$NON-NLS-2$
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalControl.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/provisional/api/ITerminalControl.java
@@ -156,7 +156,7 @@ public interface ITerminalControl {
 	OutputStream getRemoteToTerminalOutputStream();
 
 	/**
-	 * @deprecated call {@link #setTerminalTitle(String, String)} instead
+	 * @deprecated call {@link #setTerminalTitle(String, TerminalTitleRequestor)} instead
 	 */
 	@Deprecated(forRemoval = true)
 	void setTerminalTitle(String title);
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/provisional/api/Logger.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/provisional/api/Logger.java
@@ -30,14 +30,12 @@
  * A simple logger class. Every method in this class is static, so they can be
  * called from both class and instance methods. To use this class, write code
  * like this:
- * <p>
  *
  * <pre>
  * Logger.log(&quot;something has happened&quot;);
  * Logger.log(&quot;counter is &quot; + counter);
  * </pre>
  *
- * @author Fran Litterio <francis.litterio@windriver.com>
  * <p>
  * <strong>EXPERIMENTAL</strong>. This class or interface has been added as
  * part of a work in progress. There is no guarantee that this API will
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/textcanvas/PipedInputStream.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/textcanvas/PipedInputStream.java
@@ -281,9 +281,9 @@ public int read() throws IOException {
 	}
 
 	/**
-	 * Closing a <tt>PipedInputStream</tt> is the same as closing the output stream.
+	 * Closing a {@code PipedInputStream} is the same as closing the output stream.
 	 * The stream will allow reading data that's still in the pipe after which it will
-	 * throw an <tt>IOException</tt>.
+	 * throw an {@code IOException}.
 	 */
 	@Override
 	public void close() throws IOException {
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/textcanvas/VirtualCanvas.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/internal/terminal/textcanvas/VirtualCanvas.java
@@ -166,9 +166,6 @@ protected void paintUnoccupiedSpace(GC gc, Rectangle clipping) {
 		}
 	}
 
-	/**
-	 * @private
-	 */
 	protected boolean inClipping(Rectangle clipping, Rectangle r) {
 		// TODO check if this is OK in all cases (the <=!)
 		//
@@ -186,7 +183,7 @@ protected boolean inClipping(Rectangle clipping, Rectangle r) {
 
 	/**
 	 * @return the screen rect in virtual space (starting with (0,0))
-	 * of the visible screen. (x,y>=0)
+	 * of the visible screen. (x,y&gt;=0)
 	 */
 	protected Rectangle getScreenRectInVirtualSpace() {
 		Rectangle r = new Rectangle(fClientArea.x - fVirtualBounds.x, fClientArea.y - fVirtualBounds.y,
@@ -196,7 +193,7 @@ protected Rectangle getScreenRectInVirtualSpace() {
 
 	/**
 	 * @return the rect in virtual space (starting with (0,0))
-	 * of the visible screen. (x,y>=0)
+	 * of the visible screen. (x,y&gt;=0)
 	 */
 	protected Rectangle getRectInVirtualSpace(Rectangle r) {
 		return new Rectangle(r.x - fVirtualBounds.x, r.y - fVirtualBounds.y, r.width, r.height);
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/terminal/model/ITerminalTextData.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/terminal/model/ITerminalTextData.java
@@ -42,8 +42,8 @@ public interface ITerminalTextData extends ITerminalTextDataReadOnly {
 
 	/**
 	 * Set a single character and the associated {@link TerminalStyle}.
-	 * @param line line must be >=0 and < height
-	 * @param column column must be >=0 and < width
+	 * @param line line must be &gt;=0 and &lt; height
+	 * @param column column must be &gt;=0 and &lt; width
 	 * @param c the new character at this position
 	 * @param style the style or null
 	 * @since 5.0
@@ -52,8 +52,8 @@ public interface ITerminalTextData extends ITerminalTextDataReadOnly {
 
 	/**
 	 * Set an array of characters showing in the same {@link TerminalStyle}.
-	 * @param line line must be >=0 and < height
-	 * @param column column must be >=0 and < width
+	 * @param line line must be &gt;=0 and &lt; height
+	 * @param column column must be &gt;=0 and &lt; width
 	 * @param chars the new characters at this position
 	 * @param style the style or null
 	 * @since 5.0
@@ -62,8 +62,8 @@ public interface ITerminalTextData extends ITerminalTextDataReadOnly {
 
 	/**
 	 * Set a subrange of an array of characters showing in the same {@link TerminalStyle}.
-	 * @param line line must be >=0 and < height
-	 * @param column column must be >=0 and < width
+	 * @param line line must be &gt;=0 and &lt; height
+	 * @param column column must be &gt;=0 and &lt; width
 	 * @param chars the new characters at this position
 	 * @param start the start index in the chars array
 	 * @param len the number of characters to insert. Characters beyond width are not inserted.
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/terminal/model/ITerminalTextDataReadOnly.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/terminal/model/ITerminalTextDataReadOnly.java
@@ -31,23 +31,23 @@ public interface ITerminalTextDataReadOnly {
 	int getHeight();
 
 	/**
-	 * @param line be >=0 and < height
-	 * @param startCol must be >=0 and < width
-	 * @param numberOfCols must be > 0
+	 * @param line be &gt;=0 and &lt; height
+	 * @param startCol must be &gt;=0 and &lt; width
+	 * @param numberOfCols must be &gt; 0
 	 * @return a the line segments of the specified range
 	 */
 	LineSegment[] getLineSegments(int line, int startCol, int numberOfCols);
 
 	/**
-	 * @param line must be >=0 and < height
-	 * @param column must be >=0 and < width
+	 * @param line must be &gt;=0 and &lt; height
+	 * @param column must be &gt;=0 and &lt; width
 	 * @return the character at column,line
 	 */
 	char getChar(int line, int column);
 
 	/**
-	 * @param line must be >=0 and < height
-	 * @param column must be >=0 and < width
+	 * @param line must be &gt;=0 and &lt; height
+	 * @param column must be &gt;=0 and &lt; width
 	 * @return style at column,line or null
 	 * @since 5.0
 	 */
diff --git a/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/terminal/model/ITerminalTextDataSnapshot.java b/terminal/plugins/org.eclipse.tm.terminal.control/src/org/eclipse/tm/terminal/model/ITerminalTextDataSnapshot.java
@@ -64,6 +64,7 @@
  * <code>detectScrolling</code> parameter. The object will keep track of
  * scrolling. The UI must <b>first</b> handle the scrolling and then use the
  * {@link #hasLineChanged(int)} method to determine scrolling:
+ * </p>
  *
  * <pre>
  * // scroll the visible region of the UI &lt;b&gt;before&lt;/b&gt; drawing the changed lines.
@@ -76,7 +77,6 @@
  * 			drawCharacter(column, line, snap.getChar(column, line), snap.getStyle(column, line));
  * </pre>
  *
- * </p>
  * <p>
  * <b>Threading Note</b>: This class is not thread safe! All methods have to be
  * called by the a same thread, that created the instance by calling

Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@`
`12`	`12`	`/**`
`13`	`13`	`* Terminal listener allowing to listen to terminal selection changes.`
`14`	`14`	`* The interface overrides the deprecated {@link #setTerminalTitle(String)} with`
`15`		`- * {@link #setTerminalTitle(String, String)} that should be called instead.`
	`15`	`+ * {@link #setTerminalTitle(String, TerminalTitleRequestor)} that should be called instead.`
`16`	`16`	`*`
`17`	`17`	`* @since 5.5`
`18`	`18`	`*/`