Skip to content

Commit 7a4c3ac

Browse files
akurtakovakurtakov
committed
Fix javadoc problems
1 parent e4b15d7 commit 7a4c3ac

File tree

8 files changed

+25
-35
lines changed

8 files changed

+25
-35
lines changed

‎debug/org.eclipse.debug.tests/src/org/eclipse/debug/tests/launching/LaunchConfigurationTests.java‎

Lines changed: 3 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -953,9 +953,6 @@ public void testPersistIndex() throws CoreException {
953953
}
954954

955955

956-
/**
957-
* @see org.eclipse.debug.core.ILaunchConfigurationListener#launchConfigurationAdded(org.eclipse.debug.core.ILaunchConfiguration)
958-
*/
959956
@Override
960957
public void launchConfigurationAdded(ILaunchConfiguration configuration) {
961958
fFrom = getLaunchManager().getMovedFrom(configuration);
@@ -965,16 +962,10 @@ public void launchConfigurationAdded(ILaunchConfiguration configuration) {
965962
}
966963
}
967964

968-
/**
969-
* @see org.eclipse.debug.core.ILaunchConfigurationListener#launchConfigurationChanged(org.eclipse.debug.core.ILaunchConfiguration)
970-
*/
971965
@Override
972966
public void launchConfigurationChanged(ILaunchConfiguration configuration) {
973967
}
974968

975-
/**
976-
* @see org.eclipse.debug.core.ILaunchConfigurationListener#launchConfigurationRemoved(org.eclipse.debug.core.ILaunchConfiguration)
977-
*/
978969
@Override
979970
public void launchConfigurationRemoved(ILaunchConfiguration configuration) {
980971
fTo = getLaunchManager().getMovedTo(configuration);
@@ -1337,7 +1328,9 @@ public void launchesTerminated(ILaunch[] launches) {
13371328
/**
13381329
* Do not return null or throw on cancel
13391330
*
1340-
* @see https://github.com/eclipse-platform/eclipse.platform/issues/2009
1331+
* @see <a href=
1332+
* "https://github.com/eclipse-platform/eclipse.platform/issues/2009">Issue
1333+
* 2009</a>
13411334
* @see org.eclipse.debug.core.ILaunchConfiguration#launch(String,
13421335
* IProgressMonitor)
13431336
*/

‎terminal/bundles/org.eclipse.terminal.view.core/src/org/eclipse/terminal/view/core/ITerminalsConnectorConstants.java‎

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright (c) 2011, 2018 Wind River Systems, Inc. and others. All rights reserved.
2+
* Copyright (c) 2011, 2025 Wind River Systems, Inc. and others. All rights reserved.
33
* This program and the accompanying materials are made available under the terms
44
* of the Eclipse Public License 2.0 which accompanies this distribution, and is
55
* available at https://www.eclipse.org/legal/epl-2.0/
@@ -27,13 +27,15 @@ public interface ITerminalsConnectorConstants {
2727
* Property: The unique id of the terminals view to open.
2828
* <p>
2929
* Property Type: {@link String}
30+
* </p>
3031
*/
3132
public static final String PROP_ID = "id"; //$NON-NLS-1$
3233

3334
/**
3435
* Property: The unique secondary id of the terminals view to open.
3536
* <p>
3637
* Special values:
38+
* </p>
3739
* <ul>
3840
* <li>
3941
* not present in properties table or {@link #LAST_ACTIVE_SECONDARY_ID} means open on most recent terminal view
@@ -44,9 +46,10 @@ public interface ITerminalsConnectorConstants {
4446
* <li>
4547
* <code>null</code> means open on the first primary terminal (the one with no secondary id)
4648
* </li>
47-
* <ul>
49+
* </ul>
4850
* <p>
4951
* Property Type: {@link String}
52+
* </p>
5053
*/
5154
public static final String PROP_SECONDARY_ID = "secondaryId"; //$NON-NLS-1$
5255

@@ -94,7 +97,7 @@ public interface ITerminalsConnectorConstants {
9497
/**
9598
* Property: External selection to associate with the terminal tab.
9699
* <p>
97-
* Property Type: {@link org.eclipse.jface.viewers.ISelection}
100+
* Property Type: org.eclipse.jface.viewers.ISelection
98101
*/
99102
public static final String PROP_SELECTION = "selection"; //$NON-NLS-1$
100103

@@ -261,7 +264,7 @@ public interface ITerminalsConnectorConstants {
261264
* Property: Runtime process PTY instance.
262265
* <p>Typical for process terminals.
263266
* <p>
264-
* Property Type: {@link org.eclipse.cdt.utils.pty.PTY}
267+
* Property Type: org.eclipse.cdt.utils.pty.PTY
265268
*/
266269
public static final String PROP_PTY_OBJ = "pty"; //$NON-NLS-1$
267270

‎terminal/bundles/org.eclipse.terminal.view.ui/src/org/eclipse/terminal/view/ui/internal/LauncherDelegateManager.java‎

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright (c) 2011 - 2025 Wind River Systems, Inc. and others. All rights reserved.
2+
* Copyright (c) 2011, 2025 Wind River Systems, Inc. and others. All rights reserved.
33
* This program and the accompanying materials are made available under the terms
44
* of the Eclipse Public License 2.0 which accompanies this distribution, and is
55
* available at https://www.eclipse.org/legal/epl-2.0/
@@ -39,8 +39,8 @@
3939
import org.eclipse.core.runtime.Status;
4040
import org.eclipse.jface.viewers.ISelection;
4141
import org.eclipse.osgi.util.NLS;
42-
import org.eclipse.terminal.view.ui.launcher.ILauncherDelegateManager;
4342
import org.eclipse.terminal.view.ui.launcher.ILauncherDelegate;
43+
import org.eclipse.terminal.view.ui.launcher.ILauncherDelegateManager;
4444
import org.eclipse.ui.ISources;
4545
import org.eclipse.ui.PlatformUI;
4646
import org.eclipse.ui.handlers.IHandlerService;
@@ -317,10 +317,9 @@ protected Map<String, Proxy> getExtensions() {
317317
}
318318

319319
/**
320-
* Returns the extension point comparator instance. If not available,
321-
* {@link #doCreateExtensionPointComparator()} is called to create a new instance.
320+
* Returns the extension point comparator instance.
322321
*
323-
* @return The extension point comparator or <code>null</code> if the instance creation fails.
322+
* @return The extension point comparator.
324323
*/
325324
protected final ExtensionPointComparator getExtensionPointComparator() {
326325
if (comparator == null) {

‎terminal/bundles/org.eclipse.terminal.view.ui/src/org/eclipse/terminal/view/ui/internal/preferences/NoteCompositeHelper.java‎

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright (c) 2011, 2018 Wind River Systems, Inc. and others. All rights reserved.
2+
* Copyright (c) 2011, 2025 Wind River Systems, Inc. and others. All rights reserved.
33
* This program and the accompanying materials are made available under the terms
44
* of the Eclipse Public License 2.0 which accompanies this distribution, and is
55
* available at https://www.eclipse.org/legal/epl-2.0/
@@ -54,7 +54,8 @@ public void setEnabled(boolean enabled) {
5454
* Creates a composite with a highlighted Note entry and a message text.
5555
* This is designed to take up the full width of the page.
5656
*
57-
* @see PreferencePage#createNoteComposite, this is a plain copy of that!
57+
* @see PreferencePage#createNoteComposite
58+
*
5859
* @param font
5960
* the font to use
6061
* @param composite
@@ -74,7 +75,7 @@ public static Composite createNoteComposite(Font font, Composite composite, Stri
7475
* Creates a composite with a highlighted Note entry and a message text.
7576
* This is designed to take up the full width of the page.
7677
*
77-
* @see PreferencePage#createNoteComposite, this is a plain copy of that!
78+
* @see PreferencePage#createNoteComposite
7879
* @param font
7980
* the font to use
8081
* @param composite

‎terminal/bundles/org.eclipse.terminal.view.ui/src/org/eclipse/terminal/view/ui/internal/tabs/TabTerminalListener.java‎

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright (c) 2011, 2018 Wind River Systems, Inc. and others. All rights reserved.
2+
* Copyright (c) 2011, 2025 Wind River Systems, Inc. and others. All rights reserved.
33
* This program and the accompanying materials are made available under the terms
44
* of the Eclipse Public License 2.0 which accompanies this distribution, and is
55
* available at https://www.eclipse.org/legal/epl-2.0/
@@ -201,10 +201,6 @@ public void setTerminalTitle(final String title, final TerminalTitleRequestor re
201201
updateTitle(title, requestor);
202202
}
203203

204-
/**
205-
* @see org.eclipse.internal.terminal.control.ITerminalListener2#setTerminalSelectionChanged()
206-
* @since 4.1
207-
*/
208204
@Override
209205
public void setTerminalSelectionChanged() {
210206
tabFolderManager.fireTerminalSelectionChanged();

‎terminal/bundles/org.eclipse.terminal.view.ui/src/org/eclipse/terminal/view/ui/launcher/ITerminalConsoleViewManager.java‎

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,7 @@ public interface ITerminalConsoleViewManager {
3131
* Returns the console view if available within the active workbench window page.
3232
* <p>
3333
* <b>Note:</b> The method must be called within the UI thread.
34+
* </p>
3435
*
3536
* @param tvid The terminals console view id. To specify reuse of most recent terminal view use special value of
3637
* {@link ITerminalsConnectorConstants#LAST_ACTIVE_SECONDARY_ID} for its secondary part.
@@ -79,7 +80,7 @@ Widget openConsole(TerminalViewId tvid, String title, String encoding, ITerminal
7980
* @param connector The terminal connector. Must not be <code>null</code>.
8081
* @param data The custom terminal data node or <code>null</code>.
8182
*
82-
* @return An {@link Optional} describing the corresponding console tab item or <an empty optional if not found.
83+
* @return An {@link Optional} describing the corresponding console tab item or an empty optional if not found.
8384
*/
8485
Optional<Widget> findConsole(TerminalViewId tvid, String title, ITerminalConnector connector, Object data);
8586

@@ -89,7 +90,7 @@ Widget openConsole(TerminalViewId tvid, String title, String encoding, ITerminal
8990
* <b>Note:</b> The method must be called within the UI thread.
9091
*
9192
* @param control The terminal control. Must not be <code>null</code>.
92-
* @return An {@link Optional} describing the corresponding console tab item or <an empty optional if not found.
93+
* @return An {@link Optional} describing the corresponding console tab item or an empty optional if not found.
9394
*/
9495
Optional<Widget> findConsole(ITerminalControl control);
9596

‎terminal/tests/org.eclipse.terminal.test/src/org/eclipse/terminal/internal/test/terminalcanvas/VirtualCanvas.java‎

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright (c) 2007, 2018 Wind River Systems, Inc. and others.
2+
* Copyright (c) 2007, 2025 Wind River Systems, Inc. and others.
33
* All rights reserved. This program and the accompanying materials
44
* are made available under the terms of the Eclipse Public License 2.0
55
* which accompanies this distribution, and is available at
@@ -180,9 +180,6 @@ protected void paintUnoccupiedSpace(GC gc, Rectangle clipping) {
180180
}
181181
}
182182

183-
/**
184-
* @private
185-
*/
186183
protected boolean inClipping(Rectangle clipping, Rectangle r) {
187184
// TODO check if this is OK in all cases (the <=!)
188185
//

‎terminal/tests/org.eclipse.terminal.test/src/org/eclipse/terminal/model/TerminalColorUITest.java‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*******************************************************************************
2-
* Copyright (c) 2020 Kichwa Coders Canada Inc. and others.
2+
* Copyright (c) 2020, 2025 Kichwa Coders Canada Inc. and others.
33
* All rights reserved. This program and the accompanying materials
44
* are made available under the terms of the Eclipse Public License 2.0
55
* which accompanies this distribution, and is available at
@@ -25,7 +25,7 @@
2525
import org.junit.Test;
2626

2727
/**
28-
* This is a UI test because {@link TerminalColor#convertColor(boolean, boolean)
28+
* This is a UI test because {@link TerminalColor#convertColor(boolean, boolean)}
2929
* requires a Display to operate the ColorRegistry.
3030
*/
3131
public class TerminalColorUITest {

0 commit comments

Comments
 (0)