Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlexander Kurtakov2019-02-18 21:15:30 +0000
committerAlexander Kurtakov2019-02-18 21:26:51 +0000
commit1fb70c44cdadcbdff87a191e446fc4a071a31cd7 (patch)
tree03f04facd01f68847d77c3b1fd7a54651be17b5d /org.eclipse.search
parentd8465927bb45d638e37ad9a107dee5c4ee44399b (diff)
downloadeclipse.platform.text-I20190224-1800.tar.gz
eclipse.platform.text-I20190224-1800.tar.xz
eclipse.platform.text-I20190224-1800.zip
After fixing majority of Xdoclint:html issues there are warnings even with Xdoclint:none. Change-Id: I9be510daa74198061f829b73116c38c19dfd400f Signed-off-by: Alexander Kurtakov <akurtako@redhat.com>
Diffstat (limited to 'org.eclipse.search')
-rw-r--r--org.eclipse.search/search/org/eclipse/search/ui/ISearchResultView.java103
1 files changed, 61 insertions, 42 deletions
diff --git a/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultView.java b/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultView.java
index 09ed5fad8eb..19696cbc6d0 100644
--- a/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultView.java
+++ b/org.eclipse.search/search/org/eclipse/search/ui/ISearchResultView.java
@@ -94,25 +94,34 @@ public interface ISearchResultView extends IViewPart {
public ISelection getSelection();
/**
- * Informs the view that a search has started.
- * Provides all necessary information to create an entry in the search result
- * view.
- * If every match should show up in the search result view then the match
- * itself can be used as key.
+ * Informs the view that a search has started. Provides all necessary
+ * information to create an entry in the search result view. If every match
+ * should show up in the search result view then the match itself can be
+ * used as key.
*
- * @param pageId the id of the search page which started the search
- * @param label the label to be used for this search occurrence
- * @param imageDescriptor the image descriptor to be used for this search occurrence,
- * or <code>null</code> if this search should not have an image
- * @param contributor the context menu contributor
- * or <code>null</code> if no context menu is contributed
- * @param labelProvider the label provider used by this search result view
- * or <code>null</code> if the default provider should be used.
- * The default label provider shows the resource name and the corresponding image.
- * @param gotoAction the action used by the view to go to a marker
- * @param groupByKeyComputer the computer used by the view to compute the key for a marker
- * @param operation the runnable used by the view to repeat the search
- * @deprecated As of build > 20011107, replaced by the new version with additional parameter
+ * @param pageId
+ * the id of the search page which started the search
+ * @param label
+ * the label to be used for this search occurrence
+ * @param imageDescriptor
+ * the image descriptor to be used for this search occurrence, or
+ * <code>null</code> if this search should not have an image
+ * @param contributor
+ * the context menu contributor or <code>null</code> if no
+ * context menu is contributed
+ * @param labelProvider
+ * the label provider used by this search result view or
+ * <code>null</code> if the default provider should be used. The
+ * default label provider shows the resource name and the
+ * corresponding image.
+ * @param gotoAction
+ * the action used by the view to go to a marker
+ * @param groupByKeyComputer
+ * the computer used by the view to compute the key for a marker
+ * @param operation
+ * the runnable used by the view to repeat the search
+ * @deprecated As of build &gt; 20011107, replaced by the new version with
+ * additional parameter
*/
@Deprecated
public void searchStarted(
@@ -126,31 +135,41 @@ public interface ISearchResultView extends IViewPart {
IRunnableWithProgress operation);
/**
- * Informs the view that a search has started.
- * Provides all necessary information to create an entry in the search result
- * view.
- * If every match should show up in the search result view then the match
- * itself can be used as key.
+ * Informs the view that a search has started. Provides all necessary
+ * information to create an entry in the search result view. If every match
+ * should show up in the search result view then the match itself can be
+ * used as key.
*
- * @param pageId the id of the search page which started the search
- * @param singularLabel the label to be used for this search occurrence
- * if there is one match
- * or <code>null</code> if the pluralLabelPattern should be used
- * @param pluralLabelPattern the label pattern to be used for this search occurrence
- * if there are more than one matches or none.
- * This string may contain {0} which will be replace by the match count
- * @param imageDescriptor the image descriptor to be used for this search occurrence,
- * or <code>null</code> if this search should not have an image
- * @param contributor the context menu contributor
- * or <code>null</code> if no context menu is contributed
- * @param labelProvider the label provider used by this search result view
- * or <code>null</code> if the default provider should be used.
- * The default label provider shows the resource name and the corresponding image.
- * @param gotoAction the action used by the view to go to a marker
- * @param groupByKeyComputer the computer used by the view to compute the key for a marker
- * @param operation the runnable used by the view to repeat the search
- * @since 2.0
- * @deprecated As of build > 20020514, replaced by the new version which provides an action group factory
+ * @param pageId
+ * the id of the search page which started the search
+ * @param singularLabel
+ * the label to be used for this search occurrence if there is
+ * one match or <code>null</code> if the pluralLabelPattern
+ * should be used
+ * @param pluralLabelPattern
+ * the label pattern to be used for this search occurrence if
+ * there are more than one matches or none. This string may
+ * contain {0} which will be replace by the match count
+ * @param imageDescriptor
+ * the image descriptor to be used for this search occurrence, or
+ * <code>null</code> if this search should not have an image
+ * @param contributor
+ * the context menu contributor or <code>null</code> if no
+ * context menu is contributed
+ * @param labelProvider
+ * the label provider used by this search result view or
+ * <code>null</code> if the default provider should be used. The
+ * default label provider shows the resource name and the
+ * corresponding image.
+ * @param gotoAction
+ * the action used by the view to go to a marker
+ * @param groupByKeyComputer
+ * the computer used by the view to compute the key for a marker
+ * @param operation
+ * the runnable used by the view to repeat the search
+ * @since 2.0
+ * @deprecated As of build &gt; 20020514, replaced by the new version which
+ * provides an action group factory
*/
@Deprecated
public void searchStarted(

Back to the top