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 /org.eclipse.ui.editors/src/org/eclipse/ui/editors
parentcab0475aa15fc739d1b600205c0efca2717633d0 (diff)
downloadeclipse.platform.text-bb6ef114c0ce93c4a75ffbf4f8e0b7dfa4cdf126.tar.gz
eclipse.platform.text-bb6ef114c0ce93c4a75ffbf4f8e0b7dfa4cdf126.tar.xz
eclipse.platform.text-bb6ef114c0ce93c4a75ffbf4f8e0b7dfa4cdf126.zip
Javadoc updates
Diffstat (limited to 'org.eclipse.ui.editors/src/org/eclipse/ui/editors')
-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
24 files changed, 144 insertions, 121 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 120fa6d9e09..65fbeb33778 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 76495af04ac..1cccacccdfc 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 ad22d2de5a9..bb774194d4b 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 7cabcbc2b47..3f0b177c2d1 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 436dfbd9210..20db1b239e6 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 b5a1d0e25c7..a0b687703c2 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 e3b5d06dd6e..a83d5bd638d 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 0607145e496..5eadf6f3fdd 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 741e0dad272..56e207be26f 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 fed183ca3d8..c02bbad66e7 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 e6bbe5a2c72..a1b39782662 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 0c0303905a0..f513dae2b34 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 09e47761553..5bb985d3e29 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 53d16391e11..4645b7c55ad 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 852467b99bb..921080ca876 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 8b2b6b3123b..a2119dc8a21 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 40eff3830d7..cd4644891d8 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 99442df93dd..f712fb98724 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 a02c0b67c8a..2aa45138612 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 2215dcb90b1..fd0dd1821e3 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 d6f7fa4c24f..74389e98e46 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 3f64115fd6c..7db74167b8e 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 7676de9914b..19054f249ac 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 811f1af9892..c80f22363ae 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)) {

Back to the top