Skip to content

Commit

Permalink
More javadoc fixes
Browse files Browse the repository at this point in the history
Mostly wrong @params removal to let javadoc tool at least generate the
proper list.
  • Loading branch information
akurtakov committed Jul 1, 2023
1 parent 0f03ddf commit 8d945e9
Show file tree
Hide file tree
Showing 18 changed files with 7 additions and 131 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -126,8 +126,6 @@ public static CSS2FontProperties getCSS2FontProperties(Font font) {
/**
* Get CSS2FontProperties from Font of JComponent and store
* CSS2FontProperties instance into ClientProperty of JComponent.
*
* @param component
*/
public static Font getFont(CSS2FontProperties fontProperties,
Control control) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,6 @@ public class MozillaBrowser extends AbstractWebBrowser {
* Constructor
*
* @param executable executable filename to launch
* @param executableName name of the program to display when error occurs
*/
public MozillaBrowser(String id, String executable, String parameters) {
super(id);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,6 @@ public ReconcilerRegistry() {
*
* @param sourceViewer the source viewer we're hooking completion to.
* @param editor the text editor
* @param textViewerLifecycles the list of text viewer lifecycle to fill
* @param contentTypes the content types of the document we're editing.
* @return the list of {@link IReconciler} contributed for at least one of the
* content types, sorted by most generic content type to most specific.
Expand All @@ -92,7 +91,6 @@ public List<IReconciler> getReconcilers(ISourceViewer sourceViewer, ITextEditor
*
* @param sourceViewer the source viewer we're hooking completion to.
* @param editor the text editor
* @param textViewerLifecycles the list of text viewer lifecycle to fill
* @param contentTypes the content types of the document we're editing.
* @return the list of highlight {@link IReconciler}s contributed for at least
* one of the content types, sorted by most generic content type to most
Expand All @@ -113,7 +111,6 @@ public List<IReconciler> getHighlightReconcilers(ISourceViewer sourceViewer, ITe
*
* @param sourceViewer the source viewer we're hooking completion to.
* @param editor the text editor
* @param textViewerLifecycles the list of text viewer lifecycle to fill
* @param contentTypes the content types of the document we're editing.
* @return the list of folding {@link IReconciler}s contributed for at least one
* of the content types, sorted by most generic content type to most
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,6 @@ public static final void registerContextMenu(final String menuId, final MenuMana
*
* @param ref the part reference
* @param part the part
* @param page the page it belongs to
*/
public PartSite(MPart model, IWorkbenchPart part, IWorkbenchPartReference ref, IConfigurationElement element) {
this.model = model;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -102,9 +102,6 @@ public class EditMask {
/**
* Creates an instance that wraps around a text widget and manages its<br>
* formatting.
*
* @param text
* @param editMask
*/
public EditMask(Text text) {
this.text = text;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -55,91 +55,6 @@
*/
public class ErrorMessagesPage extends FormPage {

/*
private RichMessageToolTipManager richToolTipMessageManager;
class RichToolTip extends ToolTip {
private IManagedForm mform;
private FormText text;
private String content;
public RichToolTip(IManagedForm mform, Control control) {
super(control);
this.mform = mform;
setShift(new Point(10, 10));
}
protected Composite createToolTipContentArea(Event event,
Composite parent) {
this.text = mform.getToolkit().createFormText(parent, true);
configureFormText(mform.getForm().getForm(), text);
update();
return text;
}
public void update(String content) {
if (content == null) {
// hide
deactivate();
} else {
activate();
this.content = content;
update();
}
}
private void update() {
if (text != null && text.isDisposed())
text = null;
if (text != null) {
if (content != null)
text.setText(content, true, false);
else
text.setText("", false, false);
}
}
}
class RichMessageToolTipManager implements IMessageToolTipManager {
private ArrayList toolTips = new ArrayList();
private IManagedForm mform;
public RichMessageToolTipManager(IManagedForm mform) {
this.mform = mform;
}
public void createToolTip(Control control, boolean imageLabel) {
ToolTip toolTip = new RichToolTip(mform, control);
toolTips.add(toolTip);
}
public void setActive(boolean active) {
for (int i = 0; i < toolTips.size(); i++) {
RichToolTip toolTip = (RichToolTip) toolTips.get(i);
if (active)
toolTip.activate();
else
toolTip.deactivate();
}
}
public void update() {
IMessage[] messages = mform.getForm().getForm()
.getChildrenMessages();
String content = mform.getForm().getMessage() == null ? null
: createFormTextContent(messages);
for (int i = 0; i < toolTips.size(); i++) {
RichToolTip toolTip = (RichToolTip) toolTips.get(i);
toolTip.update(content);
}
}
}
*/

/**
* @param id
* @param title
*/
public ErrorMessagesPage(FormEditor editor) {
super(editor, "messageManager", "Message Manager");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,7 @@
* Preferences - Java - Code Generation - Code and Comments
*/
public class FreeFormPage extends FormPage {
/**
* @param id
* @param title
*/

public FreeFormPage(FormEditor editor) {
super(editor, "first", "First Page");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,10 +69,6 @@ public class NewStylePage extends FormPage {
private static final String[] MESSAGE_NAMES = { "text", "info", "warning",
"error" };

/**
* @param id
* @param title
*/
public NewStylePage(FormEditor editor) {
super(editor, "newStyle", "New Style");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,10 +33,8 @@ static class TextSection {
String text;
public TextSection(String text) {this.text = text;}
}
/**
* @param id
* @param title
*/


public PageWithSubPages(FormEditor editor) {
super(editor, "composite", "Composite Page");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,10 +32,7 @@
* Preferences - Java - Code Generation - Code and Comments
*/
public class SecondPage extends FormPage {
/**
* @param id
* @param title
*/

public SecondPage(FormEditor editor) {
super(editor, "second", "Section Page");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -26,10 +26,7 @@
* Preferences - Java - Code Generation - Code and Comments
*/
public class ThirdPage extends FormPage {
/**
* @param id
* @param title
*/

public ThirdPage(FormEditor editor) {
super(editor, "third", "Flow Page");
}
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,6 @@ public static void runActionWithLabel(TestCase test, IWorkbenchWindow win,
*
* @param test the current test case
* @param mgr the containing menu manager
* @param label the action label
*/
public static void runActionUsingPath(TestCase test, IMenuManager mgr,
String idPath) {
Expand All @@ -103,7 +102,6 @@ public static void runActionUsingPath(TestCase test, IMenuManager mgr,
*
* @param test the current test case
* @param win the containing window
* @param label the action label
*/
public static void runActionUsingPath(TestCase test, IWorkbenchWindow win,
String idPath) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -77,9 +77,6 @@ public static void assertDialog(Dialog dialog) {
*
* @param dialog
* the test dialog to be verified.
* @param assertion
* this is the test case object, assertions will be executed on this
* object.
*/
public static void assertDialogTexts(Dialog dialog) {
assertNotNull(dialog);
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -261,7 +261,7 @@ protected boolean condition() {
* happened.
*
* @param display the display
* @param timeout timeout in milliseconds
* @param timeoutMs timeout in milliseconds
* @param condition condition to check, must not be null
* @since 1.6
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -70,8 +70,6 @@ public EmptyPerspective() {
* This method is only called when a new perspective is created. If
* an old perspective is restored from a persistence file then
* this method is not called.
*
* @param factory the factory used to add views to the perspective
*/
@Override
public void createInitialLayout(IPageLayout layout) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -72,11 +72,7 @@ public RCPTestWorkbenchAdvisor(int idleBeforeExit) {
}

/**
*
* Enables the RCP application to runwithout a workbench window
*
* @param runWithoutWindow
*
*/
public RCPTestWorkbenchAdvisor(boolean windowlessApp) {
this.windowlessApp = windowlessApp;
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ public void setFocus() {
/**
* Sets the message to the given string.
*
* @param message
* @param msg
* the message text
*/
public void setMessage(String msg) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,6 @@ public class WorkbenchOperationHistoryTests extends UITestCase {

IUndoableOperation op1, op2, op3, op4, op5, op6;

/**
* @param testName
*/
public WorkbenchOperationHistoryTests() {
super(WorkbenchOperationHistoryTests.class.getSimpleName());
}
Expand Down

0 comments on commit 8d945e9

Please sign in to comment.