Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDani Megert2004-06-23 13:37:51 +0000
committerDani Megert2004-06-23 13:37:51 +0000
commitbb6ef114c0ce93c4a75ffbf4f8e0b7dfa4cdf126 (patch)
treee12da0de160585812c237434da3330446490fc14
parentcab0475aa15fc739d1b600205c0efca2717633d0 (diff)
downloadeclipse.platform.text-bb6ef114c0ce93c4a75ffbf4f8e0b7dfa4cdf126.tar.gz
eclipse.platform.text-bb6ef114c0ce93c4a75ffbf4f8e0b7dfa4cdf126.tar.xz
eclipse.platform.text-bb6ef114c0ce93c4a75ffbf4f8e0b7dfa4cdf126.zip
Javadoc updates
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/DefaultEncodingSupport.java5
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/EditorsUI.java3
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/EncodingActionGroup.java9
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/FileDocumentProvider.java24
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ForwardingDocumentProvider.java24
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsConstants.java4
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsDefinitionIds.java5
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsHelpContextIds.java7
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingSupport.java4
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IFoldingCommandIds.java4
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ILocationProvider.java6
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IStorageDocumentProvider.java5
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ITextEditorHelpContextIds.java8
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/StorageDocumentProvider.java9
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditor.java13
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorActionContributor.java9
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.java17
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.properties2
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorPreferenceConstants.java61
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorPreferencePage.java11
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextSourceViewerConfiguration.java3
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionContextTypeRegistry.java8
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionTemplateMessages.java10
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionTemplateStore.java14
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditor.java48
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditorPreferenceConstants.java33
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractMarkerAnnotationModel.java17
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AddMarkerAction.java13
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AddTaskAction.java3
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AnnotationPreferenceLookup.java2
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AnnotationTypeLookup.java2
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/BasicMarkerUpdater.java6
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/BookmarkRulerAction.java8
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/ChainedPreferenceStore.java167
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/DefaultMarkerAnnotationAccess.java19
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/DocumentProviderRegistry.java36
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/IMarkerUpdater.java6
37 files changed, 315 insertions, 310 deletions
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/DefaultEncodingSupport.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/DefaultEncodingSupport.java
index 120fa6d9e..65fbeb337 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/DefaultEncodingSupport.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/DefaultEncodingSupport.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,10 +8,8 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.editors.text;
-
import java.io.CharConversionException;
import java.io.UnsupportedEncodingException;
import java.text.MessageFormat;
@@ -28,7 +26,6 @@ import org.eclipse.ui.texteditor.IDocumentProvider;
import org.eclipse.ui.texteditor.StatusTextEditor;
-
/**
* The standard implementation of <code>IEncodingSupport</code>.
* @since 2.0
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/EditorsUI.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/EditorsUI.java
index 76495af04..1cccacccd 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/EditorsUI.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/EditorsUI.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -134,7 +134,6 @@ public final class EditorsUI {
*
* @return the plug-in preferences
* @see org.eclipse.core.runtime.Plugin#getPluginPreferences()
- *
*/
public static Preferences getPluginPreferences() {
return EditorsPlugin.getDefault().getPluginPreferences();
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/EncodingActionGroup.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/EncodingActionGroup.java
index ad22d2de5..bb774194d 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/EncodingActionGroup.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/EncodingActionGroup.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,7 +8,6 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.editors.text;
import java.text.MessageFormat;
@@ -183,6 +182,9 @@ public class EncodingActionGroup extends ActionGroup {
}
+ /*
+ * @since 3.0
+ */
private static String getDefaultEncodingText(ITextEditor editor, String defaultText) {
IEditorInput input= (editor.getEditorInput());
if (!(input instanceof IFileEditorInput))
@@ -205,6 +207,9 @@ public class EncodingActionGroup extends ActionGroup {
return MessageFormat.format(format, new String[] { encoding });
}
+ /*
+ * @since 3.0
+ */
private static String getEncodingFromContent(IFile file) throws CoreException {
IContentDescription description = file.getContentDescription();
if (description != null) {
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/FileDocumentProvider.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/FileDocumentProvider.java
index 7cabcbc2b..3f0b177c2 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/FileDocumentProvider.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/FileDocumentProvider.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,10 +8,8 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.editors.text;
-
import java.io.BufferedReader;
import java.io.ByteArrayInputStream;
import java.io.IOException;
@@ -62,9 +60,8 @@ import org.eclipse.ui.texteditor.AbstractMarkerAnnotationModel;
import org.eclipse.ui.texteditor.ResourceMarkerAnnotationModel;
-
/**
- * Shareable document provider specialized for file resources (<code>IFile</code>).
+ * Shared document provider specialized for file resources (<code>IFile</code>).
* <p>
* This class may be instantiated or be subclassed.</p>
*/
@@ -171,7 +168,7 @@ public class FileDocumentProvider extends StorageDocumentProvider {
* Creates a new file synchronizer which is not yet installed on a resource.
*
* @param fileEditorInput the editor input to be synchronized
- * @deprecated use FileSynchronizer(IFileEditorInput)
+ * @deprecated use {@link FileSynchronizer#FileSynchronizer(IFileEditorInput)}
*/
public FileSynchronizer(FileEditorInput fileEditorInput) {
fFileEditorInput= fileEditorInput;
@@ -391,7 +388,7 @@ public class FileDocumentProvider extends StorageDocumentProvider {
*
* @param cachedModificationStamp the cached modification stamp
* @param resource the resource to check
- * @exception CoreException if resource has been changed on the file system
+ * @exception org.eclipse.core.runtime.CoreException if resource has been changed on the file system
*/
protected void checkSynchronizationState(long cachedModificationStamp, IResource resource) throws CoreException {
if (cachedModificationStamp != computeModificationStamp(resource)) {
@@ -573,6 +570,9 @@ public class FileDocumentProvider extends StorageDocumentProvider {
}
}
+ /*
+ * @since 3.0
+ */
private String getCharsetForNewFile(IFile targetFile, IDocument document, FileInfo info) {
// User-defined encoding has first priority
String encoding;
@@ -833,7 +833,7 @@ public class FileDocumentProvider extends StorageDocumentProvider {
*
* @param file the file to be refreshed
* @param monitor the progress monitor
- * @throws CoreException if the refresh fails
+ * @throws org.eclipse.core.runtime.CoreException if the refresh fails
* @since 3.0
*/
protected void refreshFile(IFile file, IProgressMonitor monitor) throws CoreException {
@@ -906,7 +906,7 @@ public class FileDocumentProvider extends StorageDocumentProvider {
*
* @param element the element for which to store the persisted encoding
* @param encoding the encoding
- * @throws CoreException if persisting the encoding fails
+ * @throws org.eclipse.core.runtime.CoreException if persisting the encoding fails
* @since 2.1
*/
protected void persistEncoding(Object element, String encoding) throws CoreException {
@@ -1017,8 +1017,10 @@ public class FileDocumentProvider extends StorageDocumentProvider {
* This is a workaround for a corresponding bug in Java readers and writer,
* see: http://developer.java.sun.com/developer/bugParade/bugs/4508058.html
* </p>
- *
- * @throws CoreException if reading the BOM fails
+ * @param file the file
+ * @param encoding the encoding
+ * @param element the element, or <code>null</code>
+ * @throws org.eclipse.core.runtime.CoreException if reading the BOM fails
* @since 3.0
* @deprecated as of 3.0 this method is no longer in use and does nothing
*/
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ForwardingDocumentProvider.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ForwardingDocumentProvider.java
index 436dfbd92..20db1b239 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ForwardingDocumentProvider.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ForwardingDocumentProvider.java
@@ -1,5 +1,5 @@
/**********************************************************************
-Copyright (c) 2000, 2003 IBM Corp. and others.
+Copyright (c) 2000, 2004 IBM Corporation and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Common Public License v1.0
which accompanies this distribution, and is available at
@@ -26,31 +26,33 @@ import org.eclipse.ui.texteditor.IDocumentProviderExtension2;
import org.eclipse.ui.texteditor.IDocumentProviderExtension3;
import org.eclipse.ui.texteditor.IElementStateListener;
+
/**
- * A forwarding document provider is document provider that forwards all request
+ * A forwarding document provider is a document provider that forwards all requests
* to a known parent document provider. The only functional addition of the
* forwarding document provider is that it ensures that all documents provided
* to clients are appropriately set up.
* <p>
* This document provider should be used by editors that directly or indirectly
- * work with a <code>TextFileDocumentProvider</code> and do not accept that
- * they may be provided with documents which do not contain the partitioning
+ * work with a {@link org.eclipse.ui.editors.text.TextFileDocumentProvider} and do not
+ * accept that they may be provided with documents which do not contain the partitioning
* they work on. This can happen either because of a plug-in configuration error
* or when a user associates a file name or file extension with an existing text
* editor and the file buffer infrastructure does not recognize that file name
* or file extension to be of the same file type the editor works on. Thus, the
* document provided for the files with that name or extension may not be set up
- * in the way the editor expects it. Thus, a
- * <code>ForwardingDocumentProvider</code> compensates for that situation.
+ * in the way the editor expects it. The <code>ForwardingDocumentProvider</code>
+ * compensates for that situation.
+ * </p>
* <p>
- * Editors that directly work with a <code>TextFileDocumentProvider</code> can
+ * Editors that directly work with a {@link org.eclipse.ui.editors.text.TextFileDocumentProvider} can
* now use a <code>ForwardingDocumentProvider</code> instead and configure a
- * <code>TextFileDocumentProvider</code> as its parent provider. Editors that
- * indirectly work with a <code>TextFileDocumentProvider</code>, e.g. never
+ * {@link org.eclipse.ui.editors.text.TextFileDocumentProvider} as its parent provider. Editors that
+ * indirectly work with a {@link org.eclipse.ui.editors.text.TextFileDocumentProvider}, e.g. never
* set a document provider explicitly, should explicitly set a
* <code>ForwardingDocumentProvider</code> as document provider. In this case
* the forwarding document provider may not be shared between editors.
- * <p>
+ * </p>
*
* @since 3.0
*/
@@ -64,7 +66,7 @@ public class ForwardingDocumentProvider implements IDocumentProvider, IDocumentP
/**
* Creates a new forwarding document provider with a fixed parent document provider. Calling
- * <code>setParentDocumentProvider</code> does not have any effect on this object.
+ * {@link #setParentProvider(IDocumentProvider)} does not have any effect on this object.
*
* @param partitioning the partitioning
* @param documentSetupParticipant the document setup participant
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsConstants.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsConstants.java
index b5a1d0e25..a0b687703 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsConstants.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsConstants.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,9 +8,9 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.editors.text;
+
/**
* Defines the names of the encoding actions.
* <p>
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsDefinitionIds.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsDefinitionIds.java
index e3b5d06dd..a83d5bd63 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsDefinitionIds.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsDefinitionIds.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,12 +8,11 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.editors.text;
/**
- * Defines the definition ids for the encoding actions.
+ * Defines the definition IDs for the encoding actions.
* <p>
* This interface contains constants only; it is not intended to be implemented.</p>
*
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsHelpContextIds.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsHelpContextIds.java
index 0607145e4..5eadf6f3f 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsHelpContextIds.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingActionsHelpContextIds.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,14 +8,13 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.editors.text;
-
import org.eclipse.ui.texteditor.IAbstractTextEditorHelpContextIds;
+
/**
- * Help context ids for the encoding actions.
+ * Help context IDs for the encoding actions.
* <p>
* This interface contains constants only; it is not intended to be implemented.</p>
*
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingSupport.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingSupport.java
index 741e0dad2..56e207be2 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingSupport.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IEncodingSupport.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,9 +8,9 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.editors.text;
+
/**
* Interface to be implemented by objects supporting character encodings.
*
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IFoldingCommandIds.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IFoldingCommandIds.java
index fed183ca3..c02bbad66 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IFoldingCommandIds.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IFoldingCommandIds.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -12,7 +12,7 @@ package org.eclipse.ui.editors.text;
/**
- * Command identifiers for folding commands.
+ * Command IDs for folding commands.
*
* @since 3.0
*/
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ILocationProvider.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ILocationProvider.java
index e6bbe5a2c..a1b397826 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ILocationProvider.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ILocationProvider.java
@@ -1,5 +1,5 @@
/**********************************************************************
-Copyright (c) 2000, 2003 IBM Corp. and others.
+Copyright (c) 2000, 2004 IBM Corporation and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Common Public License v1.0
which accompanies this distribution, and is available at
@@ -12,7 +12,11 @@ package org.eclipse.ui.editors.text;
import org.eclipse.core.runtime.IPath;
+
/**
+ * This class gets the location for a given
+ * object.
+ *
* @since 3.0
*/
public interface ILocationProvider {
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IStorageDocumentProvider.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IStorageDocumentProvider.java
index 0c0303905..f513dae2b 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IStorageDocumentProvider.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IStorageDocumentProvider.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,12 +8,11 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.editors.text;
/**
- * Document provider for <code>IStorage</code> based domain elements.
+ * Document provider for {@link org.eclipse.core.resources.IStorage} based domain elements.
* Basically incorporates the concept of character encoding.
*
* @since 2.0
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ITextEditorHelpContextIds.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ITextEditorHelpContextIds.java
index 09e477615..5bb985d3e 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ITextEditorHelpContextIds.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/ITextEditorHelpContextIds.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,14 +8,14 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.editors.text;
import org.eclipse.ui.ide.IDEActionFactory;
import org.eclipse.ui.texteditor.IAbstractTextEditorHelpContextIds;
+
/**
- * Help context ids for the text editor.
+ * Help context IDs for the text editor.
* <p>
* This interface contains constants only; it is not intended to be implemented.</p>
*/
@@ -34,7 +34,7 @@ public interface ITextEditorHelpContextIds extends IAbstractTextEditorHelpContex
public static final String TEXT_EDITOR= PREFIX + "text_editor_context"; //$NON-NLS-1$
/**
- * Help context id for the Add Bookmark action.
+ * Help context id for the "Add Bookmark" action.
* Value: <code>"org.eclipse.ui.bookmark_action_context"</code>
* @since 3.0
*/
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/StorageDocumentProvider.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/StorageDocumentProvider.java
index 53d16391e..4645b7c55 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/StorageDocumentProvider.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/StorageDocumentProvider.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,10 +8,8 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.editors.text;
-
import java.io.BufferedReader;
import java.io.IOException;
import java.io.InputStream;
@@ -41,8 +39,9 @@ import org.eclipse.ui.IStorageEditorInput;
import org.eclipse.ui.PlatformUI;
import org.eclipse.ui.texteditor.AbstractDocumentProvider;
+
/**
- * Shareable document provider specialized for <code>IStorage</code>s.
+ * Shared document provider specialized for {@link org.eclipse.core.resources.IStorage}s.
*/
public class StorageDocumentProvider extends AbstractDocumentProvider implements IStorageDocumentProvider {
@@ -55,7 +54,7 @@ public class StorageDocumentProvider extends AbstractDocumentProvider implements
/**
- * Bundle of all required information to allow <code>IStorage</code> as underlying document resources.
+ * Bundle of all required information to allow {@link org.eclipse.core.resources.IStorage} as underlying document resources.
* @since 2.0
*/
protected class StorageInfo extends ElementInfo {
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditor.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditor.java
index 852467b99..921080ca8 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditor.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditor.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,10 +8,8 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.editors.text;
-
import java.text.MessageFormat;
import org.eclipse.core.resources.IFile;
@@ -44,7 +42,6 @@ import org.eclipse.ui.texteditor.ResourceAction;
import org.eclipse.ui.internal.editors.text.EditorsPlugin;
-
/**
* The standard text editor for file resources (<code>IFile</code>).
* <p>
@@ -141,7 +138,7 @@ public class TextEditor extends AbstractDecoratedTextEditor {
IDocumentProvider provider= getDocumentProvider();
if (provider == null) {
- // editor has programatically been closed while the dialog was open
+ // editor has programmatically been closed while the dialog was open
return;
}
@@ -312,9 +309,9 @@ public class TextEditor extends AbstractDecoratedTextEditor {
fEncodingSupport.reset();
}
-
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.ui.texteditor.AbstractTextEditor#editorContextMenuAboutToShow(org.eclipse.jface.action.IMenuManager)
+ * @since 3.0
*/
protected void editorContextMenuAboutToShow(IMenuManager menu) {
super.editorContextMenuAboutToShow(menu);
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorActionContributor.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorActionContributor.java
index 8b2b6b312..a2119dc8a 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorActionContributor.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorActionContributor.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,10 +8,8 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.editors.text;
-
import org.eclipse.jface.action.IMenuManager;
import org.eclipse.jface.action.MenuManager;
@@ -24,8 +22,9 @@ import org.eclipse.ui.texteditor.ITextEditor;
import org.eclipse.ui.texteditor.ITextEditorActionConstants;
import org.eclipse.ui.texteditor.RetargetTextEditorAction;
+
/**
- * Manages the installation and deinstallation of global actions for the default text editor.
+ * Manages the installation and de-installation of global actions for the default text editor.
* <p>
* If instantiated and used as-is, this contributor connects global actions and adds actions
* for line delimiter conversion and encoding support.</p>
@@ -38,7 +37,7 @@ public class TextEditorActionContributor extends BasicTextEditorActionContributo
private RetargetTextEditorAction fConvertToWindows;
/** Convert to UNIX action. */
private RetargetTextEditorAction fConvertToUNIX;
- /** Convert to Mac action. */
+ /** Convert to MAC action. */
private RetargetTextEditorAction fConvertToMac;
/** Encoding action group */
private EncodingActionGroup fEncodingActionGroup;
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.java
index 40eff3830..cd4644891 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -14,6 +14,9 @@ import java.text.MessageFormat;
import java.util.MissingResourceException;
import java.util.ResourceBundle;
+/**
+ * Helper class to get NLSed messages.
+ */
class TextEditorMessages {
private static final String RESOURCE_BUNDLE= "org.eclipse.ui.editors.text.TextEditorMessages";//$NON-NLS-1$
@@ -23,6 +26,12 @@ class TextEditorMessages {
private TextEditorMessages() {
}
+ /**
+ * Gets a string from the resource bundle.
+ *
+ * @param key the string used to get the bundle value, must not be <code>null</code>
+ * @return the string from the resource bundle
+ */
public static String getString(String key) {
try {
return fgResourceBundle.getString(key);
@@ -37,6 +46,7 @@ class TextEditorMessages {
* @param key the string used to get the bundle value, must not be null
* @param arg the argument used to format the string
* @return the formatted string
+ * @since 3.0
*/
public static String getFormattedString(String key, Object arg) {
String format= null;
@@ -50,6 +60,11 @@ class TextEditorMessages {
return MessageFormat.format(format, new Object[] { arg });
}
+ /**
+ * Returns a resource bundle.
+ *
+ * @return the resource bundle
+ */
public static ResourceBundle getResourceBundle() {
return fgResourceBundle;
}
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.properties b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.properties
index 99442df93..f712fb987 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.properties
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorMessages.properties
@@ -1,5 +1,5 @@
###############################################################################
-# Copyright (c) 2000, 2003 IBM Corporation and others.
+# Copyright (c) 2000, 2004 IBM Corporation and others.
# All rights reserved. This program and the accompanying materials
# are made available under the terms of the Common Public License v1.0
# which accompanies this distribution, and is available at
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorPreferenceConstants.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorPreferenceConstants.java
index a02c0b67c..2aa451386 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorPreferenceConstants.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorPreferenceConstants.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -10,7 +10,6 @@
*******************************************************************************/
package org.eclipse.ui.editors.text;
-
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants;
@@ -34,7 +33,7 @@ public class TextEditorPreferenceConstants {
* <p>
* The preference value is of type <code>Boolean</code>.
* </p>
- * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
+ * @deprecated As of 3.0,, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
*/
public final static String EDITOR_CURRENT_LINE= "currentLine"; //$NON-NLS-1$
@@ -47,7 +46,7 @@ public class TextEditorPreferenceConstants {
* </p>
* @see org.eclipse.jface.resource.StringConverter
* @see org.eclipse.jface.preference.PreferenceConverter
- * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
+ * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
*/
public final static String EDITOR_CURRENT_LINE_COLOR= "currentLineColor"; //$NON-NLS-1$
@@ -57,7 +56,7 @@ public class TextEditorPreferenceConstants {
* <p>
* The preference value is of type <code>Boolean</code>.
* </p>
- * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
+ * @deprecated As of 3.0,, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
*/
public final static String EDITOR_PRINT_MARGIN= "printMargin"; //$NON-NLS-1$
@@ -70,7 +69,7 @@ public class TextEditorPreferenceConstants {
* </p>
* @see org.eclipse.jface.resource.StringConverter
* @see org.eclipse.jface.preference.PreferenceConverter
- * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
+ * @deprecated As of 3.0,, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
*/
public final static String EDITOR_PRINT_MARGIN_COLOR= "printMarginColor"; //$NON-NLS-1$
@@ -80,7 +79,7 @@ public class TextEditorPreferenceConstants {
* <p>
* The preference value is of type <code>int</code>.
* </p>
- * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
+ * @deprecated As of 3.0,, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
*/
public final static String EDITOR_PRINT_MARGIN_COLUMN= "printMarginColumn"; //$NON-NLS-1$
@@ -92,7 +91,7 @@ public class TextEditorPreferenceConstants {
* The preference value is of type <code>Boolean</code>.
* </p>
* @since 2.1
- * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
+ * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
*/
public final static String EDITOR_UNKNOWN_INDICATION= "othersIndication"; //$NON-NLS-1$
@@ -107,7 +106,7 @@ public class TextEditorPreferenceConstants {
* @see org.eclipse.jface.resource.StringConverter
* @see org.eclipse.jface.preference.PreferenceConverter
* @since 2.1
- * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
+ * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
*/
public final static String EDITOR_UNKNOWN_INDICATION_COLOR= "othersIndicationColor"; //$NON-NLS-1$
@@ -118,7 +117,7 @@ public class TextEditorPreferenceConstants {
* The preference value is of type <code>Boolean</code>.
* </p>
* @since 2.1
- * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
+ * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
*/
public final static String EDITOR_UNKNOWN_INDICATION_IN_OVERVIEW_RULER= "othersIndicationInOverviewRuler"; //$NON-NLS-1$
@@ -128,7 +127,7 @@ public class TextEditorPreferenceConstants {
* <p>
* The preference value is of type <code>Boolean</code>.
* </p>
- * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
+ * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
*/
public final static String EDITOR_OVERVIEW_RULER= "overviewRuler"; //$NON-NLS-1$
@@ -138,7 +137,7 @@ public class TextEditorPreferenceConstants {
* <p>
* The preference value is of type <code>Boolean</code>.
* </p>
- * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
+ * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
*/
public final static String EDITOR_LINE_NUMBER_RULER= "lineNumberRuler"; //$NON-NLS-1$
@@ -152,97 +151,97 @@ public class TextEditorPreferenceConstants {
* @see org.eclipse.jface.resource.StringConverter
* @see org.eclipse.jface.preference.PreferenceConverter
* @see #EDITOR_LINE_NUMBER_RULER
- * @deprecated as of 3.0 replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
+ * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants}
*/
public final static String EDITOR_LINE_NUMBER_RULER_COLOR= "lineNumberColor"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_PROBLEM_INDICATION= "problemIndication"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_PROBLEM_INDICATION_COLOR= "problemIndicationColor"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_WARNING_INDICATION= "warningIndication"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_WARNING_INDICATION_COLOR= "warningIndicationColor"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_INFO_INDICATION= "infoIndication"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_INFO_INDICATION_COLOR= "infoIndicationColor"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_TASK_INDICATION= "taskIndication"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_TASK_INDICATION_COLOR= "taskIndicationColor"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_BOOKMARK_INDICATION= "bookmarkIndication"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_BOOKMARK_INDICATION_COLOR= "bookmarkIndicationColor"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_SEARCH_RESULT_INDICATION= "searchResultIndication"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_SEARCH_RESULT_INDICATION_COLOR= "searchResultIndicationColor"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_ERROR_INDICATION_IN_OVERVIEW_RULER= "errorIndicationInOverviewRuler"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_WARNING_INDICATION_IN_OVERVIEW_RULER= "warningIndicationInOverviewRuler"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_INFO_INDICATION_IN_OVERVIEW_RULER= "infoIndicationInOverviewRuler"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_TASK_INDICATION_IN_OVERVIEW_RULER= "taskIndicationInOverviewRuler"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_BOOKMARK_INDICATION_IN_OVERVIEW_RULER= "bookmarkIndicationInOverviewRuler"; //$NON-NLS-1$
/**
- * @deprecated
+ * @deprecated As of 2.1, provided by <code>org.eclipse.ui.editors.markerAnnotationSpecification</code> extension point
*/
public final static String EDITOR_SEARCH_RESULT_INDICATION_IN_OVERVIEW_RULER= "searchResultIndicationInOverviewRuler"; //$NON-NLS-1$
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorPreferencePage.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorPreferencePage.java
index 2215dcb90..fd0dd1821 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorPreferencePage.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditorPreferencePage.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,10 +8,8 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.editors.text;
-
import org.eclipse.core.runtime.Platform;
import org.eclipse.core.runtime.Plugin;
@@ -34,6 +32,7 @@ import org.eclipse.ui.help.WorkbenchHelp;
import org.eclipse.ui.plugin.AbstractUIPlugin;
import org.eclipse.ui.texteditor.AbstractTextEditor;
+
/**
* A preference page to set the font used in the default text editor.
* <p>
@@ -42,12 +41,12 @@ import org.eclipse.ui.texteditor.AbstractTextEditor;
* the page description. In addition, it uses <code>"PreferencePage.fontEditor"</code>
* for the editor description.
* </p>
- * @deprecated As of 2.1 fonts are managed by the workbench, no longer supported
+ * @deprecated As of 2.1, fonts are managed by the workbench, no longer supported
*/
public class TextEditorPreferencePage extends FieldEditorPreferencePage implements IWorkbenchPreferencePage {
/**
- * Indicates whether the preferences that this page maniulates have been initialized.
+ * Indicates whether the preferences that this page manipulates have been initialized.
*
* @since 2.0
*/
@@ -89,7 +88,7 @@ public class TextEditorPreferencePage extends FieldEditorPreferencePage implemen
}
/**
- * Initialzes the defaults for the given store.
+ * Initializes the defaults for the given store.
*
* @param store the preference store
* @since 2.0
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextSourceViewerConfiguration.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextSourceViewerConfiguration.java
index d6f7fa4c2..74389e98e 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextSourceViewerConfiguration.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextSourceViewerConfiguration.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -18,6 +18,7 @@ import org.eclipse.jface.text.source.SourceViewerConfiguration;
import org.eclipse.ui.texteditor.AbstractDecoratedTextEditorPreferenceConstants;
+
/**
* Source viewer configuration for the text editor.
*
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionContextTypeRegistry.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionContextTypeRegistry.java
index 3f64115fd..7db74167b 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionContextTypeRegistry.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionContextTypeRegistry.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -55,7 +55,7 @@ public class ContributionContextTypeRegistry extends ContextTypeRegistry {
/**
* Tries to create a context type given an id. If there is already a context
- * type registered under <code>id</code>, nothing happens. Otherwise,
+ * type registered under the given id, nothing happens. Otherwise,
* contributions to the <code>org.eclipse.ui.editors.templates</code>
* extension point are searched for the given identifier and the specified
* context type instantiated if it is found.
@@ -78,8 +78,8 @@ public class ContributionContextTypeRegistry extends ContextTypeRegistry {
* <code>org.eclipse.ui.editors.templates</code> extension point are
* searched for the given identifier and the specified context type
* instantiated if it is found. Any contributed
- * <code>TemplateVariableResolver</code> s are also instantiated and added
- * to the context type.
+ * {@link org.eclipse.jface.text.templates.TemplateVariableResolver}s
+ * are also instantiated and added to the context type.
*
* @param id the id for the context type as specified in XML
* @return the instantiated and configured context type, or
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionTemplateMessages.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionTemplateMessages.java
index 7676de991..19054f249 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionTemplateMessages.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionTemplateMessages.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -14,6 +14,8 @@ import java.util.MissingResourceException;
import java.util.ResourceBundle;
/**
+ * Helper class to get NLSed messages.
+ *
* @since 3.0
*/
class ContributionTemplateMessages {
@@ -24,6 +26,12 @@ class ContributionTemplateMessages {
private ContributionTemplateMessages() {}
+ /**
+ * Gets a string from the resource bundle.
+ *
+ * @param key the string used to get the bundle value, must not be <code>null<code>
+ * @return the string from the resource bundle
+ */
public static String getString(String key) {
try {
return RESOURCE_BUNDLE.getString(key);
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionTemplateStore.java b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionTemplateStore.java
index 811f1af98..c80f22363 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionTemplateStore.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/templates/ContributionTemplateStore.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -37,12 +37,13 @@ import org.eclipse.jface.text.templates.persistence.TemplateStore;
import org.eclipse.ui.internal.editors.text.EditorsPlugin;
+
/**
* Manages templates. Handles reading default templates contributed via XML and
- * user-defined (or overridden) templates stored in the preferences. Clients may
- * instantiate this class.
- *
- * <p>This class will become final.</p>
+ * user-defined (or overridden) templates stored in the preferences.
+ * <p>
+ * Clients may instantiate but not subclass this class.
+ * </p>
*
* @since 3.0
*/
@@ -197,8 +198,7 @@ public class ContributionTemplateStore extends TemplateStore {
private void createTemplate(Collection map, IConfigurationElement element) {
String contextTypeId= element.getAttributeAsIs(CONTEXT_TYPE_ID);
- // no need to log failures since id and name are guaranteed by the exsd
- // specification
+ // log failures since extension point id and name are mandatory
if (contextExists(contextTypeId)) {
String id= element.getAttributeAsIs(ID);
if (isValidTemplateId(id)) {
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditor.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditor.java
index 903fd3560..438cb864f 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditor.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditor.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -87,7 +87,7 @@ public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {
*/
private final static String CURRENT_LINE_COLOR= AbstractDecoratedTextEditorPreferenceConstants.EDITOR_CURRENT_LINE_COLOR;
/**
- * Preference key for showing print marging ruler.
+ * Preference key for showing print margin ruler.
*/
private final static String PRINT_MARGIN= AbstractDecoratedTextEditorPreferenceConstants.EDITOR_PRINT_MARGIN;
/**
@@ -154,17 +154,14 @@ public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {
private boolean fIsChangeInformationShown;
/**
* The annotation ruler column used in the vertical ruler.
- * @since 3.0
*/
private AnnotationRulerColumn fAnnotationRulerColumn;
/**
* The editor's implicit document provider.
- * @since 3.0
*/
private IDocumentProvider fImplicitDocumentProvider;
/**
* The editor's goto marker adapter.
- * @since 3.0
*/
private Object fGotoMarkerAdapter= new GotoMarkerAdapter();
@@ -302,7 +299,7 @@ public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {
if (fIsChangeInformationShown) {
uninstallChangeRulerModel();
- showChangeRuler(false); // hide change ruler if its displayed - if the line number ruler is showing, only the colors get removed by deinstalling the model
+ showChangeRuler(false); // hide change ruler if its displayed - if the line number ruler is showing, only the colors get removed by de-installing the model
} else {
ensureChangeInfoCanBeDisplayed();
installChangeRulerModel();
@@ -376,7 +373,7 @@ public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {
* Extracts the line differ from the displayed document's annotation model. If none can be found,
* a new differ is created and attached to the annotation model.
*
- * @return the linediffer, or <code>null</code> if none could be found or created.
+ * @return the line differ, or <code>null</code> if none could be found or created
*/
private IAnnotationModel getOrCreateDiffer() {
IAnnotationModel differ= getDiffer();
@@ -410,7 +407,7 @@ public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {
* Extracts the line differ from the displayed document's annotation model. If none can be found,
* <code>null</code> is returned.
*
- * @return the linediffer, or <code>null</code> if none could be found
+ * @return the line differ, or <code>null</code> if none could be found
*/
private IAnnotationModel getDiffer() {
// get annotation model extension
@@ -608,15 +605,18 @@ public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {
}
/**
- * Extracts the color preference for <code>pref</code> from <code>store</code>. If <code>store</code>
- * indicates that the default value is to be used, or the value stored in the preferences store is <code>null</code>,
- * the value is taken from the <code>AnnotationPreference</code>'s default color value.
- *
- * <p>The return value is never <code>null</code></p>
+ * Extracts the color preference for the given preference from the given store.
+ * If the given store indicates that the default value is to be used, or
+ * the value stored in the preferences store is <code>null</code>,
+ * the value is taken from the <code>AnnotationPreference</code>'s default
+ * color value.
+ * <p>
+ * The return value is
+ * </p>
*
- * @param store
- * @param pref
- * @return
+ * @param store the preference store
+ * @param pref the annotation preference
+ * @return the RGB color preference, not <code>null</code>
*/
private RGB getColorPreference(IPreferenceStore store, AnnotationPreference pref) {
RGB rgb= null;
@@ -831,7 +831,6 @@ public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {
*
* @param preferenceKey the preference key string
* @return the annotation preference or <code>null</code> if none
- * @since 3.0
*/
private AnnotationPreference getVerticalRulerAnnotationPreference(String preferenceKey) {
if (preferenceKey == null)
@@ -988,7 +987,6 @@ public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {
/*
* @see org.eclipse.ui.texteditor.StatusTextEditor#isErrorStatus(org.eclipse.core.runtime.IStatus)
- * @since 3.0
*/
protected boolean isErrorStatus(IStatus status) {
// see bug 42230
@@ -1014,7 +1012,6 @@ public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {
/*
* @see IAdaptable#getAdapter(java.lang.Class)
- * @since 3.0
*/
public Object getAdapter(Class adapter) {
if (IGotoMarker.class.equals(adapter))
@@ -1029,7 +1026,6 @@ public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {
* re-initialized based on the given editor input.
*
* @see org.eclipse.ui.texteditor.AbstractTextEditor#setDocumentProvider(org.eclipse.ui.IEditorInput)
- * @since 3.0
*/
protected void setDocumentProvider(IEditorInput input) {
fImplicitDocumentProvider= DocumentProviderRegistry.getDefault().getDocumentProvider(input);
@@ -1042,7 +1038,6 @@ public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {
/*
* @see org.eclipse.ui.texteditor.ITextEditor#getDocumentProvider()
- * @since 3.0
*/
public IDocumentProvider getDocumentProvider() {
IDocumentProvider provider= super.getDocumentProvider();
@@ -1053,20 +1048,17 @@ public abstract class AbstractDecoratedTextEditor extends StatusTextEditor {
/*
* @see org.eclipse.ui.texteditor.AbstractTextEditor#disposeDocumentProvider()
- * @since 3.0
*/
protected void disposeDocumentProvider() {
super.disposeDocumentProvider();
fImplicitDocumentProvider= null;
}
- /**
- * {@inheritDoc}
- * <p>
- * This implementation also updates change information in the quick diff
- * ruler.</p>
+ /*
+ * @see AbstractTextEditor#doSetInput(IEditorInput)
*
- * @param input {@inheritDoc}
+ * This implementation also updates change information in the quick diff
+ * ruler.
*/
protected void doSetInput(IEditorInput input) throws CoreException {
if (fIsChangeInformationShown) {
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditorPreferenceConstants.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditorPreferenceConstants.java
index 1db239e89..73d271603 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditorPreferenceConstants.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractDecoratedTextEditorPreferenceConstants.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -10,14 +10,12 @@
*******************************************************************************/
package org.eclipse.ui.texteditor;
-
import org.eclipse.swt.graphics.RGB;
import org.eclipse.jface.preference.IPreferenceStore;
import org.eclipse.jface.preference.PreferenceConverter;
-
/**
* Preference constants used in the extended text editor preference store.
*
@@ -59,8 +57,6 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
* Value is of type <code>int</code>: positive int value specifying the number of
* spaces per tab.
* </p>
- *
- * @since 3.0
*/
public final static String EDITOR_TAB_WIDTH= "tabWidth"; //$NON-NLS-1$
@@ -101,7 +97,6 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
* <p>
* The preference value is of type <code>Boolean</code>.
* </p>
- * @since 2.1
* @deprecated as of 3.0 there are no UNKNOWN annotations any more
*/
public final static String EDITOR_UNKNOWN_INDICATION= "othersIndication"; //$NON-NLS-1$
@@ -116,8 +111,7 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
* @see #EDITOR_UNKNOWN_INDICATION
* @see org.eclipse.jface.resource.StringConverter
* @see org.eclipse.jface.preference.PreferenceConverter
- * @since 2.1
- * @deprecated as of 3.0 there are no UNKNOWN annotations any more
+ * @deprecated As of 3.0, there are no UNKNOWN annotations any more
*/
public final static String EDITOR_UNKNOWN_INDICATION_COLOR= "othersIndicationColor"; //$NON-NLS-1$
@@ -127,8 +121,7 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
* <p>
* The preference value is of type <code>Boolean</code>.
* </p>
- * @since 2.1
- * @deprecated as of 3.0 there are no UNKNOWN annotations any more
+ * @deprecated As of 3.0, there are no UNKNOWN annotations any more
*/
public final static String EDITOR_UNKNOWN_INDICATION_IN_OVERVIEW_RULER= "othersIndicationInOverviewRuler"; //$NON-NLS-1$
@@ -168,7 +161,7 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
* Annotations preference page is used to configure annotations.
* <p>
* Value is of type <code>boolean</code>.
- * @since 3.0
+ * </p>
*/
public static final String USE_ANNOTATIONS_PREFERENCE_PAGE= "useAnnotationsPrefPage"; //$NON-NLS-1$
@@ -177,7 +170,7 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
* Quick Diff preference page is used to configure Quick Diff.
* <p>
* Value is of type <code>boolean</code>.
- * @since 3.0
+ * </p>
*/
public static final String USE_QUICK_DIFF_PREFERENCE_PAGE= "useQuickDiffPrefPage"; //$NON-NLS-1$
@@ -185,7 +178,7 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
* A named preference that controls whether quick diff colors are shown on the line number bar.
* <p>
* Value is of type <code>boolean</code>.
- * @since 3.0
+ * </p>
*/
public static final String QUICK_DIFF_ALWAYS_ON= "quickdiff.quickDiff"; //$NON-NLS-1$
@@ -193,7 +186,7 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
* A named preference that controls the default quick diff reference provider.
* <p>
* Value is of type <code>String</code>.
- * @since 3.0
+ * </p>
*/
public static final String QUICK_DIFF_DEFAULT_PROVIDER= "quickdiff.defaultProvider"; //$NON-NLS-1$
@@ -201,7 +194,7 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
* A named preference that controls the default quick diff reference provider.
* <p>
* Value is of type <code>String</code>.
- * @since 3.0
+ * </p>
*/
public static final String QUICK_DIFF_CHARACTER_MODE= "quickdiff.characterMode"; //$NON-NLS-1$
@@ -212,8 +205,6 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
* Value is of type <code>Boolean</code>. If <code>false</code>, only
* the default caret is used in the editor.
* </p>
- *
- * @since 3.0
*/
public static final String EDITOR_USE_CUSTOM_CARETS= AbstractTextEditor.PREFERENCE_USE_CUSTOM_CARETS;
@@ -223,8 +214,6 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
* Value is of type <code>Boolean</code>. If <code>true</code>, the caret is
* twice as wide as the default caret.
* </p>
- *
- * @since 3.0
*/
public static final String EDITOR_WIDE_CARET= AbstractTextEditor.PREFERENCE_WIDE_CARET;
@@ -238,7 +227,6 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
*
* @see org.eclipse.jface.resource.StringConverter
* @see org.eclipse.jface.preference.PreferenceConverter
- * @since 3.0
*/
public final static String EDITOR_SELECTION_FOREGROUND_COLOR= AbstractTextEditor.PREFERENCE_COLOR_SELECTION_FOREGROUND;
@@ -248,8 +236,6 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
* <p>
* Value is of type <code>Boolean</code>.
* </p>
- *
- * @since 3.0
*/
public final static String EDITOR_SELECTION_FOREGROUND_DEFAULT_COLOR= AbstractTextEditor.PREFERENCE_COLOR_SELECTION_FOREGROUND_SYSTEM_DEFAULT;
@@ -263,7 +249,6 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
*
* @see org.eclipse.jface.resource.StringConverter
* @see org.eclipse.jface.preference.PreferenceConverter
- * @since 3.0
*/
public final static String EDITOR_SELECTION_BACKGROUND_COLOR= AbstractTextEditor.PREFERENCE_COLOR_SELECTION_BACKGROUND;
@@ -273,8 +258,6 @@ public class AbstractDecoratedTextEditorPreferenceConstants {
* <p>
* Value is of type <code>Boolean</code>.
* </p>
- *
- * @since 3.0
*/
public final static String EDITOR_SELECTION_BACKGROUND_DEFAULT_COLOR= AbstractTextEditor.PREFERENCE_COLOR_SELECTION_BACKGROUND_SYSTEM_DEFAULT;
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractMarkerAnnotationModel.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractMarkerAnnotationModel.java
index bd8d73168..c1ce83df4 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractMarkerAnnotationModel.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AbstractMarkerAnnotationModel.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,10 +8,8 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.texteditor;
-
import java.util.ArrayList;
import java.util.Iterator;
import java.util.List;
@@ -48,11 +46,12 @@ import org.eclipse.ui.PlatformUI;
* <p>
* Markers are provided by an underlying source (a subclass responsibility).
* Markers whose textual range gets deleted during text editing are removed
- * from the model on save. The <code>updateMarkers</code> method can be used
+ * from the model on save. The {@link #updateMarkers(IDocument)} method can be used
* to force the model to update the source's markers with any changes to their
- * locations due to edits. Clients can register <code>IMarkerUpdater</code>
+ * locations due to edits. Clients can register a {@link org.eclipse.ui.texteditor.IMarkerUpdater}
* objects in order to define the process of marker updating. Registration can be done
- * using the <code>"org.eclipse.ui.markerUpdaters"</code> extension point.</p>
+ * using the <code>"org.eclipse.ui.markerUpdaters"</code> extension point.
+ * </p>
* <p>
* Subclasses must implement the following methods:
* <ul>
@@ -62,8 +61,6 @@ import org.eclipse.ui.PlatformUI;
* <li><code>listenToMarkerChanges</code></li>
* </ul>
* </p>
- *
- * @since 3.0
*/
public abstract class AbstractMarkerAnnotationModel extends AnnotationModel implements IPersistableAnnotationModel {
@@ -522,7 +519,7 @@ public abstract class AbstractMarkerAnnotationModel extends AnnotationModel impl
* @param document the document into which the given position points
* @param position the current position of the marker inside the given document
* @return <code>false</code> if the marker is invalid
- * @exception CoreException if there is a problem updating the marker
+ * @throws CoreException if there is a problem updating the marker
* @since 3.0
*/
public boolean updateMarker(IDocument document, IMarker marker, Position position) throws CoreException {
@@ -539,7 +536,7 @@ public abstract class AbstractMarkerAnnotationModel extends AnnotationModel impl
* all registered marker updaters (<code>IMarkerUpdater</code>).
*
* @param document the document to which this model is currently connected
- * @exception CoreException if there is a problem updating the markers
+ * @throws CoreException if there is a problem updating the markers
*/
public void updateMarkers(IDocument document) throws CoreException {
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AddMarkerAction.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AddMarkerAction.java
index f6b1ec58c..50c3454f1 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AddMarkerAction.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AddMarkerAction.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -10,8 +10,6 @@
*******************************************************************************/
package org.eclipse.ui.texteditor;
-
-
import java.util.HashMap;
import java.util.Map;
import java.util.ResourceBundle;
@@ -39,7 +37,6 @@ import org.eclipse.ui.IEditorInput;
import org.eclipse.ui.PlatformUI;
-
/**
* Action for creating a marker of a specified type for the editor's
* input element based on the editor's selection. If required, the
@@ -55,7 +52,7 @@ import org.eclipse.ui.PlatformUI;
* <li><code>"error.dialog.title"</code> - the error dialog's title</li>
* <li><code>"error.dialog.message"</code> - the error dialog's message</li>
* </ul>
- * This class may be instantiated but is not intended for subclassing.
+ * This class may be instantiated but is not intended to be subclassed.
* </p>
*/
public class AddMarkerAction extends TextEditorAction {
@@ -63,13 +60,13 @@ public class AddMarkerAction extends TextEditorAction {
/** The maximum length of an proposed label. */
private static final int MAX_LABEL_LENGTH= 80;
- /** The type for newly created markers */
+ /** The type for newly created markers. */
private String fMarkerType;
/** Should the user be asked for a label? */
private boolean fAskForLabel;
- /** The action's resource bundle */
+ /** The action's resource bundle. */
private ResourceBundle fBundle;
- /** The prefix used for resource bundle lookup */
+ /** The prefix used for resource bundle lookup. */
private String fPrefix;
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AddTaskAction.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AddTaskAction.java
index 499c2316e..4b4417d6f 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AddTaskAction.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AddTaskAction.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -37,6 +37,7 @@ public class AddTaskAction extends AddMarkerAction {
* <code>null</code> if none
* @param editor the text editor
* @see AddMarkerAction#AddMarkerAction(ResourceBundle, String, ITextEditor, String, boolean)
+ * @since 3.0
*/
public AddTaskAction(ResourceBundle bundle, String prefix, ITextEditor editor) {
super(bundle, prefix, editor, IMarker.TASK, false);
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AnnotationPreferenceLookup.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AnnotationPreferenceLookup.java
index 69e250eee..e45495db4 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AnnotationPreferenceLookup.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AnnotationPreferenceLookup.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AnnotationTypeLookup.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AnnotationTypeLookup.java
index cde425b86..c56b0d6bc 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AnnotationTypeLookup.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/AnnotationTypeLookup.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/BasicMarkerUpdater.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/BasicMarkerUpdater.java
index a144ba00e..98e46eac5 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/BasicMarkerUpdater.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/BasicMarkerUpdater.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -10,8 +10,6 @@
*******************************************************************************/
package org.eclipse.ui.texteditor;
-
-
import org.eclipse.jface.text.BadLocationException;
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.Position;
@@ -22,8 +20,6 @@ import org.eclipse.core.resources.IMarker;
/**
* Updates a marker's positional attributes which are
* start position, end position, and line number.
- *
- * @since 3.0
*/
public final class BasicMarkerUpdater implements IMarkerUpdater {
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/BookmarkRulerAction.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/BookmarkRulerAction.java
index 1ff5846f9..c9604ea4e 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/BookmarkRulerAction.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/BookmarkRulerAction.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -8,21 +8,21 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.texteditor;
-
import org.eclipse.core.resources.IMarker;
import org.eclipse.jface.action.IAction;
import org.eclipse.jface.text.source.IVerticalRulerInfo;
+
/**
* Adapter for the managing bookmark action.
+ *
* @since 2.0
*/
public class BookmarkRulerAction extends AbstractRulerActionDelegate {
- /**
+ /*
* @see AbstractRulerActionDelegate#createAction(ITextEditor, IVerticalRulerInfo)
*/
protected IAction createAction(ITextEditor editor, IVerticalRulerInfo rulerInfo) {
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/ChainedPreferenceStore.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/ChainedPreferenceStore.java
index 7c9bab62e..50f57beed 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/ChainedPreferenceStore.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/ChainedPreferenceStore.java
@@ -8,7 +8,6 @@
* Contributors:
* IBM Corporation - initial API and implementation
*******************************************************************************/
-
package org.eclipse.ui.texteditor;
import java.util.ArrayList;
@@ -21,6 +20,7 @@ import org.eclipse.jface.util.IPropertyChangeListener;
import org.eclipse.jface.util.ListenerList;
import org.eclipse.jface.util.PropertyChangeEvent;
+
/**
* Preference store that composes multiple preference stores in a
* chain and serves a preference value from the first preference store in the
@@ -33,13 +33,13 @@ import org.eclipse.jface.util.PropertyChangeEvent;
*/
public class ChainedPreferenceStore implements IPreferenceStore {
- /** Child preference stores */
+ /** Child preference stores. */
private IPreferenceStore[] fPreferenceStores;
- /** Listeners on this chained preference store */
+ /** Listeners on this chained preference store. */
private ListenerList fClientListeners= new ListenerList();
- /** Listeners on the child preference stores */
+ /** Listeners on the child preference stores. */
private List fChildListeners= new ArrayList();
/**
@@ -84,7 +84,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
/**
* Returns the preference store.
- * @return The preference store
+ *
+ * @return the preference store
*/
public IPreferenceStore getPreferenceStore() {
return fPreferenceStore;
@@ -92,7 +93,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
/**
* Sets the preference store.
- * @param preferenceStore The new preference store to set.
+ *
+ * @param preferenceStore the preference store to set
*/
public void setPreferenceStore(IPreferenceStore preferenceStore) {
fPreferenceStore= preferenceStore;
@@ -103,7 +105,7 @@ public class ChainedPreferenceStore implements IPreferenceStore {
/**
* Sets the chained preference stores.
*
- * @param preferenceStores The chained preference stores to set.
+ * @param preferenceStores the chained preference stores to set
*/
public ChainedPreferenceStore(IPreferenceStore[] preferenceStores) {
Assert.isTrue(preferenceStores != null && preferenceStores.length > 0);
@@ -115,8 +117,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
}
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#addPropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener)
*/
public void addPropertyChangeListener(IPropertyChangeListener listener) {
if (fClientListeners.size() == 0) {
@@ -125,8 +127,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
fClientListeners.add(listener);
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#removePropertyChangeListener(org.eclipse.jface.util.IPropertyChangeListener)
*/
public void removePropertyChangeListener(IPropertyChangeListener listener) {
fClientListeners.remove(listener);
@@ -135,15 +137,15 @@ public class ChainedPreferenceStore implements IPreferenceStore {
}
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#contains(java.lang.String)
*/
public boolean contains(String name) {
return getVisibleStore(name) != null;
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#firePropertyChangeEvent(java.lang.String, java.lang.Object, java.lang.Object)
*/
public void firePropertyChangeEvent(String name, Object oldValue, Object newValue) {
firePropertyChangeEvent(new PropertyChangeEvent(this, name, oldValue, newValue));
@@ -151,7 +153,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
/**
* Fire the given property change event.
- * @param event The property change event
+ *
+ * @param event the property change event
*/
private void firePropertyChangeEvent(PropertyChangeEvent event) {
Object[] listeners= fClientListeners.getListeners();
@@ -169,8 +172,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
return BOOLEAN_DEFAULT_DEFAULT;
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#getDefaultBoolean(java.lang.String)
*/
public boolean getDefaultBoolean(String name) {
IPreferenceStore visibleStore= getVisibleStore(name);
@@ -179,8 +182,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
return BOOLEAN_DEFAULT_DEFAULT;
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#getDefaultDouble(java.lang.String)
*/
public double getDefaultDouble(String name) {
IPreferenceStore visibleStore= getVisibleStore(name);
@@ -189,8 +192,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
return DOUBLE_DEFAULT_DEFAULT;
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#getDefaultFloat(java.lang.String)
*/
public float getDefaultFloat(String name) {
IPreferenceStore visibleStore= getVisibleStore(name);
@@ -199,8 +202,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
return FLOAT_DEFAULT_DEFAULT;
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#getDefaultInt(java.lang.String)
*/
public int getDefaultInt(String name) {
IPreferenceStore visibleStore= getVisibleStore(name);
@@ -209,8 +212,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
return INT_DEFAULT_DEFAULT;
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#getDefaultLong(java.lang.String)
*/
public long getDefaultLong(String name) {
IPreferenceStore visibleStore= getVisibleStore(name);
@@ -219,8 +222,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
return LONG_DEFAULT_DEFAULT;
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#getDefaultString(java.lang.String)
*/
public String getDefaultString(String name) {
IPreferenceStore visibleStore= getVisibleStore(name);
@@ -229,8 +232,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
return STRING_DEFAULT_DEFAULT;
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#getDouble(java.lang.String)
*/
public double getDouble(String name) {
IPreferenceStore visibleStore= getVisibleStore(name);
@@ -239,8 +242,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
return DOUBLE_DEFAULT_DEFAULT;
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#getFloat(java.lang.String)
*/
public float getFloat(String name) {
IPreferenceStore visibleStore= getVisibleStore(name);
@@ -249,8 +252,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
return FLOAT_DEFAULT_DEFAULT;
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#getInt(java.lang.String)
*/
public int getInt(String name) {
IPreferenceStore visibleStore= getVisibleStore(name);
@@ -259,8 +262,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
return INT_DEFAULT_DEFAULT;
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#getLong(java.lang.String)
*/
public long getLong(String name) {
IPreferenceStore visibleStore= getVisibleStore(name);
@@ -269,8 +272,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
return LONG_DEFAULT_DEFAULT;
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#getString(java.lang.String)
*/
public String getString(String name) {
IPreferenceStore visibleStore= getVisibleStore(name);
@@ -279,8 +282,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
return STRING_DEFAULT_DEFAULT;
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#isDefault(java.lang.String)
*/
public boolean isDefault(String name) {
IPreferenceStore visibleStore= getVisibleStore(name);
@@ -289,106 +292,106 @@ public class ChainedPreferenceStore implements IPreferenceStore {
return false;
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#needsSaving()
*/
public boolean needsSaving() {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#putValue(java.lang.String, java.lang.String)
*/
public void putValue(String name, String value) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#setDefault(java.lang.String, double)
*/
public void setDefault(String name, double value) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#setDefault(java.lang.String, float)
*/
public void setDefault(String name, float value) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#setDefault(java.lang.String, int)
*/
public void setDefault(String name, int value) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#setDefault(java.lang.String, long)
*/
public void setDefault(String name, long value) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#setDefault(java.lang.String, java.lang.String)
*/
public void setDefault(String name, String defaultObject) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#setDefault(java.lang.String, boolean)
*/
public void setDefault(String name, boolean value) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#setToDefault(java.lang.String)
*/
public void setToDefault(String name) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#setValue(java.lang.String, double)
*/
public void setValue(String name, double value) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#setValue(java.lang.String, float)
*/
public void setValue(String name, float value) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#setValue(java.lang.String, int)
*/
public void setValue(String name, int value) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#setValue(java.lang.String, long)
*/
public void setValue(String name, long value) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#setValue(java.lang.String, java.lang.String)
*/
public void setValue(String name, String value) {
throw new UnsupportedOperationException();
}
- /**
- * {@inheritDoc}
+ /*
+ * @see org.eclipse.jface.preference.IPreferenceStore#setValue(java.lang.String, boolean)
*/
public void setValue(String name, boolean value) {
throw new UnsupportedOperationException();
@@ -397,8 +400,8 @@ public class ChainedPreferenceStore implements IPreferenceStore {
/**
* Handle property change event from the child listener with the given child preference store.
*
- * @param childPreferenceStore The child preference store
- * @param event The event
+ * @param childPreferenceStore the child preference store
+ * @param event the event
*/
private void handlePropertyChangeEvent(IPreferenceStore childPreferenceStore, PropertyChangeEvent event) {
String property= event.getProperty();
@@ -481,14 +484,14 @@ public class ChainedPreferenceStore implements IPreferenceStore {
/**
* Returns an object of the same dynamic type as <code>thisValue</code>, the returned object
* encapsulates the value of the <code>property</code> from the preference <code>store</code>.
- * Allowed dynamic types for <code>thisValue</code> are <code>Boolean</code>, <code>Double</code>,
- * <code>Float</code>, <code>Integer</code>, <code>Long</code> and <code>String</code>. If
- * <code>thisValue</code> has a different type a {@link java.lang.IllegalArgumentException} is thrown.
*
- * @param property The name of the considered property
- * @param store The preference store
- * @param thisValue The given value
- * @return The other value
+ * @param property the name of the considered property
+ * @param store the preference store
+ * @param thisValue the given value
+ * @return the other value
+ * @throws java.lang.IllegalArgumentException if <code>thisValue</code> has a different type than
+ * <code>Boolean</code>, <code>Double</code>, <code>Float</code>, <code>Integer</code>,
+ * <code>Long</code> or <code>String</code>
*/
private Object getOtherValue(String property, IPreferenceStore store, Object thisValue) {
Object otherValue;
@@ -513,9 +516,9 @@ public class ChainedPreferenceStore implements IPreferenceStore {
* Returns the preference store from which the given property's value
* is visible.
*
- * @param property Name of the property.
- * @return Preference store from which the property's value is visible,
- * <code>null</code> if the property is unknown.
+ * @param property the name of the property
+ * @return the preference store from which the property's value is visible,
+ * <code>null</code> if the property is unknown
*/
private IPreferenceStore getVisibleStore(String property) {
IPreferenceStore visibleStore= null;
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/DefaultMarkerAnnotationAccess.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/DefaultMarkerAnnotationAccess.java
index 8e2b57607..2c8d97dd3 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/DefaultMarkerAnnotationAccess.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/DefaultMarkerAnnotationAccess.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -38,13 +38,16 @@ import org.eclipse.ui.internal.texteditor.*;
/**
+ * Default class for accessing marker annotation properties.
+ *
* @since 2.1
*/
public class DefaultMarkerAnnotationAccess implements IAnnotationAccess, IAnnotationAccessExtension {
/**
- * Constant for the unknown marker type
- * @deprecated use Annotation.TYPE_UNKNOWN instead
+ * Constant for the unknown marker type.
+ *
+ * @deprecated As of 3.0, replaced by Annotation.TYPE_UNKNOWN
*/
public static final String UNKNOWN= Annotation.TYPE_UNKNOWN;
@@ -86,6 +89,7 @@ public class DefaultMarkerAnnotationAccess implements IAnnotationAccess, IAnnota
/**
* The mapping between external and internal symbolic system image names.
+ *
* @since 3.0
*/
private final static Map MAPPING;
@@ -101,8 +105,9 @@ public class DefaultMarkerAnnotationAccess implements IAnnotationAccess, IAnnota
/**
- * The marker annotation preferences
- * @deprecated since 3.0
+ * The marker annotation preferences.
+ *
+ * @deprecated As of 3.0, no replacement
*/
protected MarkerAnnotationPreferences fMarkerAnnotationPreferences;
@@ -110,7 +115,7 @@ public class DefaultMarkerAnnotationAccess implements IAnnotationAccess, IAnnota
* Returns a new default marker annotation access with the given preferences.
*
* @param markerAnnotationPreferences
- * @deprecated use <code>DefaultMarkerAnnotationAccess()</code> instead
+ * @deprecated As of 3.0, replaced by {@link org.eclipse.ui.texteditor.DefaultMarkerAnnotationAccess#DefaultMarkerAnnotationAccess()}
*/
public DefaultMarkerAnnotationAccess(MarkerAnnotationPreferences markerAnnotationPreferences) {
fMarkerAnnotationPreferences= markerAnnotationPreferences;
@@ -294,7 +299,7 @@ public class DefaultMarkerAnnotationAccess implements IAnnotationAccess, IAnnota
/**
* Translates the given symbolic image name into the according symbolic image name
- * the <code>ISharedImages</code> understands.
+ * the {@link org.eclipse.ui.ISharedImages} understands.
*
* @param symbolicImageName the symbolic system image name to be translated
* @return the shared image name
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/DocumentProviderRegistry.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/DocumentProviderRegistry.java
index 3f8ac8903..773584ff9 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/DocumentProviderRegistry.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/DocumentProviderRegistry.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -10,8 +10,6 @@
*******************************************************************************/
package org.eclipse.ui.texteditor;
-
-
import java.text.MessageFormat;
import java.util.ArrayList;
import java.util.HashMap;
@@ -41,7 +39,7 @@ import org.eclipse.ui.PlatformUI;
/**
- * This registry manages shareable document provider. Document
+ * This registry manages shared document providers. Document
* providers are specified in <code>plugin.xml</code> either
* per name extension or per editor input type. A name extension
* rule always overrules an editor input type rule. Editor input
@@ -49,7 +47,6 @@ import org.eclipse.ui.PlatformUI;
* used to find object adapters.
*
* @see org.eclipse.core.runtime.IAdapterManager
- * @since 3.0
*/
public class DocumentProviderRegistry {
@@ -88,6 +85,10 @@ public class DocumentProviderRegistry {
* Reads the comma-separated value of the given configuration element
* for the given attribute name and remembers the configuration element
* in the given map under the individual tokens of the attribute value.
+ *
+ * @param map the map
+ * @param element the configuration element
+ * @param attributeName the attribute name
*/
private void read(Map map, IConfigurationElement element, String attributeName) {
String value= element.getAttribute(attributeName);
@@ -153,6 +154,9 @@ public class DocumentProviderRegistry {
/**
* Returns the first enumerated element of the given set.
+ *
+ * @param set the set
+ * @return the first configuration element in the set or <code>null</code> if none
*/
private IConfigurationElement selectConfigurationElement(Set set) {
if (set != null && !set.isEmpty()) {
@@ -163,10 +167,10 @@ public class DocumentProviderRegistry {
}
/**
- * Returns a shareable document provider for the given name extension.
+ * Returns a shared document provider for the given name extension.
*
* @param extension the name extension to be used for lookup
- * @return the shareable document provider or <code>null</code>
+ * @return the shared document provider or <code>null</code>
*/
public IDocumentProvider getDocumentProvider(String extension) {
@@ -182,7 +186,8 @@ public class DocumentProviderRegistry {
* Computes the class hierarchy of the given type. The type is
* part of the computed hierarchy.
*
- * @return a list with elements of type <code>Class</code>
+ * @param type the type
+ * @return a list containing the super class hierarchy
*/
private List computeClassList(Class type) {
@@ -202,6 +207,7 @@ public class DocumentProviderRegistry {
* classes. The interface lists of the given classes are
* concatenated.
*
+ * @param classes a list of {@link java.lang.Class} objects
* @return a list with elements of type <code>Class</code>
*/
private List computeInterfaceList(List classes) {
@@ -221,6 +227,10 @@ public class DocumentProviderRegistry {
/**
* Computes the list of all interfaces of the given list of interfaces,
* taking a depth-first approach.
+ *
+ * @param interfaces an array of {@link java.lang.Class} objects denoting interfaces
+ * @param result the result list
+ * @param visited map of visited interfaces
*/
private void computeInterfaceList(Class[] interfaces, List result, Hashtable visited) {
@@ -246,7 +256,8 @@ public class DocumentProviderRegistry {
* Returns the configuration elements for the first class in the list
* of given classes for which configuration elements have been remembered.
*
- * returns an input type mapping or <code>null</code>
+ * @param classes a list of {@link java.lang.Class} objects
+ * @return an input type mapping or <code>null</code>
*/
private Object getFirstInputTypeMapping(List classes) {
Iterator e= classes.iterator();
@@ -264,7 +275,8 @@ public class DocumentProviderRegistry {
* there is no configuration element for the type's name, first the list of
* super classes is searched, and if not successful the list of all interfaces.
*
- * returns an input type mapping or <code>null</code>
+ * @param type a {@link java.lang.Class} object
+ * @return an input type mapping or <code>null</code>
*/
private Object findInputTypeMapping(Class type) {
@@ -284,10 +296,10 @@ public class DocumentProviderRegistry {
}
/**
- * Returns the shareable document for the type of the given editor input.
+ * Returns the shared document for the type of the given editor input.
*
* @param editorInput the input for whose type the provider is looked up
- * @return the shareable document provider
+ * @return the shared document provider
*/
public IDocumentProvider getDocumentProvider(IEditorInput editorInput) {
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/IMarkerUpdater.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/IMarkerUpdater.java
index f3ce66f24..19d8a4869 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/IMarkerUpdater.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/IMarkerUpdater.java
@@ -1,5 +1,5 @@
/*******************************************************************************
- * Copyright (c) 2000, 2003 IBM Corporation and others.
+ * Copyright (c) 2000, 2004 IBM Corporation and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Common Public License v1.0
* which accompanies this distribution, and is available at
@@ -10,8 +10,6 @@
*******************************************************************************/
package org.eclipse.ui.texteditor;
-
-
import org.eclipse.jface.text.IDocument;
import org.eclipse.jface.text.Position;
@@ -24,8 +22,6 @@ import org.eclipse.core.resources.IMarker;
* any type. Also they either assume update responsibility for a
* specific set of marker attributes or any marker attribute.
* Marker updater must be registered with an <code>AbstractMarkerAnnotationModel</code>.
- *
- * @since 3.0
*/
public interface IMarkerUpdater {

Back to the top