From f1e36acecbad8a0c3dd0c75ed901bd97ed3fed53 Mon Sep 17 00:00:00 2001
From: Thomas Maeder
Date: Tue, 22 Jun 2004 10:12:43 +0000
Subject: Javadoc (missing tags & spelling)
---
.../new search/org/eclipse/search/ui/NewSearchUI.java | 6 ++++--
.../org/eclipse/search/ui/text/AbstractTextSearchViewPage.java | 7 ++++++-
.../new search/org/eclipse/search/ui/text/IEditorMatchAdapter.java | 1 +
.../new search/org/eclipse/search/ui/text/RemoveAllEvent.java | 4 ++++
.../search/org/eclipse/search/ui/ISearchPageContainer.java | 2 +-
5 files changed, 16 insertions(+), 4 deletions(-)
diff --git a/org.eclipse.search/new search/org/eclipse/search/ui/NewSearchUI.java b/org.eclipse.search/new search/org/eclipse/search/ui/NewSearchUI.java
index 78b772a6902..e71fb3fa86a 100644
--- a/org.eclipse.search/new search/org/eclipse/search/ui/NewSearchUI.java
+++ b/org.eclipse.search/new search/org/eclipse/search/ui/NewSearchUI.java
@@ -25,7 +25,7 @@ public class NewSearchUI {
/**
* Activates a search result view in the current workbench window page. If a
* search view is already open in the current workbench window page, it is
- * acivated. Otherwise a new search view is opened and activated.
+ * activated. Otherwise a new search view is opened and activated.
*
* @return the activate search result view or null if the
* search result view couldn't be activated
@@ -76,6 +76,7 @@ public class NewSearchUI {
* the runnable context to run the query in
* @param query
* the query to execute
+ * @return a status indicating whether the query ran correctly
*/
public static IStatus runQueryInForeground(IRunnableContext context, ISearchQuery query) {
return InternalSearchUI.getInstance().runSearchInForeground(context, query);
@@ -103,7 +104,7 @@ public class NewSearchUI {
InternalSearchUI.getInstance().removeQueryListener(l);
}
/**
- * Returns all search queries know to the search ui (i.e. registered via
+ * Returns all search queries know to the search UI (i.e. registered via
* runQuery() or runQueryInForeground()).
*
* @return all search results
@@ -156,6 +157,7 @@ public class NewSearchUI {
* Opens the search dialog.
* If pageId is specified and a corresponding page
* is found then it is brought to top.
+ * @param window the parent window
*
* @param pageId the page to select or null
* if the best fitting page should be selected
diff --git a/org.eclipse.search/new search/org/eclipse/search/ui/text/AbstractTextSearchViewPage.java b/org.eclipse.search/new search/org/eclipse/search/ui/text/AbstractTextSearchViewPage.java
index 9ca8163d355..54377ae5a23 100644
--- a/org.eclipse.search/new search/org/eclipse/search/ui/text/AbstractTextSearchViewPage.java
+++ b/org.eclipse.search/new search/org/eclipse/search/ui/text/AbstractTextSearchViewPage.java
@@ -173,6 +173,9 @@ public abstract class AbstractTextSearchViewPage extends Page implements ISearch
private transient boolean fIsUIUpdateScheduled= false;
private static final String KEY_LAYOUT = "org.eclipse.search.resultpage.layout"; //$NON-NLS-1$
+ /**
+ * An empty array.
+ */
protected static final Match[] EMPTY_MATCH_ARRAY= new Match[0];
private StructuredViewer fViewer;
@@ -552,6 +555,7 @@ public abstract class AbstractTextSearchViewPage extends Page implements ISearch
* FLAG_LAYOUT_FLAT or FLAG_LAYOUT_TREE and
* it must be one of the values passed during construction of this search
* result page.
+ * @param layout the new layout
*
* @see AbstractTextSearchViewPage#isLayoutSupported(int)
*/
@@ -1057,7 +1061,8 @@ public abstract class AbstractTextSearchViewPage extends Page implements ISearch
}
/**
- * {@inheritDoc}Subclasses may exend this method.
+ * {@inheritDoc}
+ * Subclasses may extend this method.
*/
public void restoreState(IMemento memento) {
if (countBits(fSupportedLayouts) > 1) {
diff --git a/org.eclipse.search/new search/org/eclipse/search/ui/text/IEditorMatchAdapter.java b/org.eclipse.search/new search/org/eclipse/search/ui/text/IEditorMatchAdapter.java
index 21b76651ac2..5ea5401f1aa 100644
--- a/org.eclipse.search/new search/org/eclipse/search/ui/text/IEditorMatchAdapter.java
+++ b/org.eclipse.search/new search/org/eclipse/search/ui/text/IEditorMatchAdapter.java
@@ -42,6 +42,7 @@ public interface IEditorMatchAdapter {
* editor.
* For example, if the editor shows a particular file, all matches in that file should
* be returned.
+ * @param result the result to search for matches
*
* @param editor The editor.
* @return All matches that are contained in the element that is shown in
diff --git a/org.eclipse.search/new search/org/eclipse/search/ui/text/RemoveAllEvent.java b/org.eclipse.search/new search/org/eclipse/search/ui/text/RemoveAllEvent.java
index 255031716df..f6376e56e40 100644
--- a/org.eclipse.search/new search/org/eclipse/search/ui/text/RemoveAllEvent.java
+++ b/org.eclipse.search/new search/org/eclipse/search/ui/text/RemoveAllEvent.java
@@ -15,6 +15,10 @@ import org.eclipse.search.ui.SearchResultEvent;
* @since 3.0
*/
public class RemoveAllEvent extends SearchResultEvent {
+ /**
+ * A constructor
+ * @param searchResult the search result this event is about
+ */
public RemoveAllEvent(ISearchResult searchResult) {
super(searchResult);
}
diff --git a/org.eclipse.search/search/org/eclipse/search/ui/ISearchPageContainer.java b/org.eclipse.search/search/org/eclipse/search/ui/ISearchPageContainer.java
index 27f6f4cdec9..1fa2083b678 100644
--- a/org.eclipse.search/search/org/eclipse/search/ui/ISearchPageContainer.java
+++ b/org.eclipse.search/search/org/eclipse/search/ui/ISearchPageContainer.java
@@ -89,8 +89,8 @@ public interface ISearchPageContainer {
/**
* Sets the selected scope of this search page container.
* The scope is WORKSPACE_SCOPE, SELECTED_PROJECTS_SCOPE, SELECTION_SCOPE or WORKING_SET_SCOPE.
+ * @param scope the newly selected scope
*
- * @return the selected scope
* @since 2.0
*/
public void setSelectedScope(int scope);
--
cgit v1.2.3