Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAndre Weinand2004-06-22 17:14:36 -0400
committerAndre Weinand2004-06-22 17:14:36 -0400
commite8ebe059e4098cdb60ca36cbfb19365dbfeb1cec (patch)
tree027b9e781e9a1cee5be6776acae78df8bee40694 /bundles/org.eclipse.compare/compare
parent3c0dcabb4889e13b2aff288c30616871997e681d (diff)
downloadeclipse.platform.team-e8ebe059e4098cdb60ca36cbfb19365dbfeb1cec.tar.gz
eclipse.platform.team-e8ebe059e4098cdb60ca36cbfb19365dbfeb1cec.tar.xz
eclipse.platform.team-e8ebe059e4098cdb60ca36cbfb19365dbfeb1cec.zip
Fixed and updated Java docv20040622
Diffstat (limited to 'bundles/org.eclipse.compare/compare')
-rw-r--r--bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareConfiguration.java6
-rw-r--r--bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareEditorInput.java4
-rw-r--r--bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareViewerPane.java4
-rw-r--r--bundles/org.eclipse.compare/compare/org/eclipse/compare/EditionSelectionDialog.java10
-rw-r--r--bundles/org.eclipse.compare/compare/org/eclipse/compare/IEncodedStreamContentAccessor.java11
-rw-r--r--bundles/org.eclipse.compare/compare/org/eclipse/compare/IStreamMerger.java2
-rw-r--r--bundles/org.eclipse.compare/compare/org/eclipse/compare/package.html16
-rw-r--r--bundles/org.eclipse.compare/compare/org/eclipse/compare/rangedifferencer/RangeDifferencer.java1
-rw-r--r--bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/DiffContainer.java1
9 files changed, 33 insertions, 22 deletions
diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareConfiguration.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareConfiguration.java
index 4894d833a..8a5e89b1f 100644
--- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareConfiguration.java
+++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareConfiguration.java
@@ -261,8 +261,8 @@ public class CompareConfiguration {
* If the new value differs from the old a <code>PropertyChangeEvent</code>
* is sent to registered listeners.
*
- * @param propertyName the name of the property to set
- * @param value the new value of the property
+ * @param key the name of the property to set
+ * @param newValue the new value of the property
*/
public void setProperty(String key, Object newValue) {
Object oldValue= fProperties.get(key);
@@ -275,7 +275,7 @@ public class CompareConfiguration {
* Returns the property with the given name, or <code>null</code>
* if no such property exists.
*
- * @param propertyName the name of the property to retrieve
+ * @param key the name of the property to retrieve
* @return the property with the given name, or <code>null</code> if not found
*/
public Object getProperty(String key) {
diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareEditorInput.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareEditorInput.java
index f13be381c..0e7d6ee04 100644
--- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareEditorInput.java
+++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareEditorInput.java
@@ -771,7 +771,7 @@ public abstract class CompareEditorInput implements IEditorInput, IPropertyChang
* Empty implementation.
* Subclasses must override to save any changes.
*
- * @param progressMonitor an <code>IProgressMonitor</code> that the implementation of save may use to show progress
+ * @param pm an <code>IProgressMonitor</code> that the implementation of save may use to show progress
* @deprecated Override method saveChanges instead.
*/
public void save(IProgressMonitor pm) {
@@ -783,7 +783,7 @@ public abstract class CompareEditorInput implements IEditorInput, IPropertyChang
* This implementation tries to flush changes in all viewers by
* calling <code>ISavable.save</code> on them.
*
- * @param progressMonitor an <code>IProgressMonitor</code> that the implementation of save may use to show progress
+ * @param pm an <code>IProgressMonitor</code> that the implementation of save may use to show progress
* @since 2.0
*/
public void saveChanges(IProgressMonitor pm) throws CoreException {
diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareViewerPane.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareViewerPane.java
index 43033a295..d8213f047 100644
--- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareViewerPane.java
+++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/CompareViewerPane.java
@@ -39,7 +39,7 @@ public class CompareViewerPane extends ViewForm {
* Constructs a new instance of this class given its parent
* and a style value describing its behavior and appearance.
*
- * @param parent a widget which will be the parent of the new instance (cannot be null)
+ * @param container a widget which will be the container of the new instance (cannot be null)
* @param style the style of widget to construct
*
* @exception IllegalArgumentException <ul>
@@ -81,7 +81,7 @@ public class CompareViewerPane extends ViewForm {
* Set the pane's title text.
* The value <code>null</code> clears it.
*
- * @param text the text to be displayed in the pane or null
+ * @param label the text to be displayed in the pane or null
*/
public void setText(String label) {
CLabel cl= (CLabel) getTopLeft();
diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/EditionSelectionDialog.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/EditionSelectionDialog.java
index 35920d115..70be55a02 100644
--- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/EditionSelectionDialog.java
+++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/EditionSelectionDialog.java
@@ -250,8 +250,8 @@ public class EditionSelectionDialog extends ResizableDialog {
* Select the previous edition (presenting a UI).
*
* @param target the input object against which the editions are compared; must not be <code>null</code>
- * @param editions the list of editions (element type: <code>ITypedElement</code>s)
- * @param path If <code>null</code> dialog shows full input; if non <code>null</code> it extracts a subsection
+ * @param inputEditions the list of editions (element type: <code>ITypedElement</code>s)
+ * @param ppath If <code>null</code> dialog shows full input; if non <code>null</code> it extracts a subsection
* @return returns the selected edition or <code>null</code> if error occurred.
* The returned <code>ITypedElement</code> is one of the original editions
* if <code>path</code> was <code>null</code>; otherwise
@@ -321,8 +321,8 @@ public class EditionSelectionDialog extends ResizableDialog {
* Presents this modal dialog with the functionality described in the class comment above.
*
* @param target the input object against which the editions are compared; must not be <code>null</code>
- * @param editions the list of editions (element type: <code>ITypedElement</code>s)
- * @param path If <code>null</code> dialog shows full input; if non <code>null</code> it extracts a subsection
+ * @param inputEditions the list of editions (element type: <code>ITypedElement</code>s)
+ * @param ppath If <code>null</code> dialog shows full input; if non <code>null</code> it extracts a subsection
* @return returns the selected edition or <code>null</code> if dialog was cancelled.
* The returned <code>ITypedElement</code> is one of the original editions
* if <code>path</code> was <code>null</code>; otherwise
@@ -507,7 +507,7 @@ public class EditionSelectionDialog extends ResizableDialog {
* Controls whether the <code>EditionSelectionDialog</code> is in 'compare' mode
* or 'add/replace' (the default) mode.
*
- * @param addMode if true dialog is in 'add' mode.
+ * @param compareMode if true dialog is in 'add' mode.
* @since 2.0
*/
public void setCompareMode(boolean compareMode) {
diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/IEncodedStreamContentAccessor.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/IEncodedStreamContentAccessor.java
index 1d0f3e261..95aa6f5c9 100644
--- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/IEncodedStreamContentAccessor.java
+++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/IEncodedStreamContentAccessor.java
@@ -15,10 +15,7 @@ import org.eclipse.core.runtime.CoreException;
/**
* Extension for <code>IStreamContentAccessor</code>. Extends the original
* concept of a <code>IStreamContentAccessor</code> to answer the Charset (encoding) used for the stream.
- * <p>
- * <b>Note</b>: This interface is part of early access API that may well
- * change in incompatible ways until reach their finished form.
- * </p>
+ *
* @since 3.0
*/
public interface IEncodedStreamContentAccessor extends IStreamContentAccessor {
@@ -27,7 +24,11 @@ public interface IEncodedStreamContentAccessor extends IStreamContentAccessor {
* Returns the name of a charset encoding to be used when decoding this
* stream accessor's contents into characters. Returns <code>null</code> if a proper
* encoding cannot be determined.
- *
+ * <p>
+ * <b>Note</b>: this method does not check whether the result is a supported
+ * charset name. Callers should be prepared to handle
+ * <code>UnsupportedEncodingException</code> where this charset is used.
+ * </p>
* @return the name of a charset, or <code>null</code>
* @exception CoreException if an error happens while determining
* the charset. See any refinements for more information.
diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/IStreamMerger.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/IStreamMerger.java
index a1715dba7..bf4c6b072 100644
--- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/IStreamMerger.java
+++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/IStreamMerger.java
@@ -24,8 +24,6 @@ import org.eclipse.core.runtime.IStatus;
* <code>org.eclipse.compare.streamMergers</code> extension point.
* </p>
*
- * @see org.eclipse.compare.internal.merge.TextStreamMerger
- *
* @since 3.0
*/
public interface IStreamMerger {
diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/package.html b/bundles/org.eclipse.compare/compare/org/eclipse/compare/package.html
index 1963dd462..96ffb6342 100644
--- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/package.html
+++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/package.html
@@ -43,7 +43,9 @@ This interface is used by the hierarchical differencing engine
(<b>org.eclipse.compare.structuremergeviewer.Differencer</b>) to walk the tree.
<br>
In addition every leaf of the tree must implement the <b>IStreamContentAccessor</b>
-interface in order to give the differencing engine access to its stream content.
+or <b>IEncodedStreamContentAccessor</b>
+interfaces in order to give the differencing engine access to its stream content
+and to its encoding (with IEncodedStreamContentAccessor).
<p>
The abstract class <b>BufferedContent</b> provides a default implementation
@@ -93,6 +95,18 @@ viewer switching</i>, that is the viewer installed in the pane is dynamically
determined by the pane's input object.
Both classes are useful if you want to use compare viewers outside the context of
a compare editor, for example in a dialog or wizard.
+<p>
+
+A <b>Splitter</b> is an extension of a SashForm that supports nesting, maximizing of panes,
+and propagating the visibility state of panes.
+<p>
+
+The interface <b>IStreamMerger</b> defines a single operation for performing a three-way merge on three
+input streams. The merged result is written to an output stream.
+<br>
+Clients must implement this interface when contributing new mergers to the
+<code>org.eclipse.compare.streamMergers</code> extension point.
+New <b>IStreamMerger</b>s can be created for registered types with the createStreamMerger methods of CompareUI.
</body>
diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/rangedifferencer/RangeDifferencer.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/rangedifferencer/RangeDifferencer.java
index 5c0b051b3..d3cb46313 100644
--- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/rangedifferencer/RangeDifferencer.java
+++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/rangedifferencer/RangeDifferencer.java
@@ -322,7 +322,6 @@ public final class RangeDifferencer {
* If the ancestor range comparator is <code>null</code>, a two-way
* comparison is performed.
*
- * @param pm if not <code>null</code> used to report progress
* @param ancestor the ancestor range comparator or <code>null</code>
* @param left the left range comparator
* @param right the right range comparator
diff --git a/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/DiffContainer.java b/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/DiffContainer.java
index 4a3d44c4c..b9066ec68 100644
--- a/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/DiffContainer.java
+++ b/bundles/org.eclipse.compare/compare/org/eclipse/compare/structuremergeviewer/DiffContainer.java
@@ -27,7 +27,6 @@ public abstract class DiffContainer extends DiffElement implements IDiffContaine
* Creates a new container with the specified kind under the given parent.
*
* @param parent under which the new container is added as a child or <code>null</code>.
- * @param name of the container
* @param kind of difference (defined in <code>Differencer</code>).
*/
public DiffContainer(IDiffContainer parent, int kind) {

Back to the top