Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorDani Megert2004-06-21 17:42:33 +0000
committerDani Megert2004-06-21 17:42:33 +0000
commitfca241b96722f4a2948ef0285a3ccff3ea6e0b9d (patch)
tree4640d5d8792cc2b75e366abbeda1b1d5468c7103
parent78b22c3306aedd81b7f806f7a347576be509f01c (diff)
downloadeclipse.platform.text-fca241b96722f4a2948ef0285a3ccff3ea6e0b9d.tar.gz
eclipse.platform.text-fca241b96722f4a2948ef0285a3ccff3ea6e0b9d.tar.xz
eclipse.platform.text-fca241b96722f4a2948ef0285a3ccff3ea6e0b9d.zip
Javadoc fixes
-rw-r--r--org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/FileBuffers.java2
-rw-r--r--org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IFileBufferListener.java2
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/text/TextViewer.java5
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/ContextBasedFormattingStrategy.java2
-rw-r--r--org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/FormattingContextProperties.java4
-rw-r--r--org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationMap.java6
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/IFoldingCommandIds.java8
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/editors/text/TextEditor.java2
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/MarkerAnnotation.java2
-rw-r--r--org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/MarkerAnnotationPreferences.java4
-rw-r--r--org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorActionConstants.java22
11 files changed, 29 insertions, 30 deletions
diff --git a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/FileBuffers.java b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/FileBuffers.java
index 54e9ebe89..33f15ed33 100644
--- a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/FileBuffers.java
+++ b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/FileBuffers.java
@@ -93,7 +93,7 @@ public final class FileBuffers {
* </p>
*
* @param location
- * @return
+ * @return the {@link File} in the local file system for the given location
*/
public static File getSystemFileAtLocation(IPath location) {
if (location == null)
diff --git a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IFileBufferListener.java b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IFileBufferListener.java
index 06f8e244f..01a115495 100644
--- a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IFileBufferListener.java
+++ b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IFileBufferListener.java
@@ -77,7 +77,7 @@ public interface IFileBufferListener {
* given location.
*
* @param buffer the effected file buffer
- * @param target the new location (not just the container)
+ * @param path the new location (not just the container)
*/
void underlyingFileMoved(IFileBuffer buffer, IPath path);
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/TextViewer.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/TextViewer.java
index a3c40a260..e214bafb8 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/TextViewer.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/TextViewer.java
@@ -1545,10 +1545,11 @@ public class TextViewer extends Viewer implements
* Note: The return value is used to initialize the cursor
* listener. To return a non-constant value has no effect.
* <p>
- * The same value (<code>500</code>) is used in the <code>OpenStrategy</code>.
+ * The same value (<code>500</code>) is used in <code>OpenStrategy.TIME</code>.
* </p>
+ * @return delay in milliseconds
* @see CursorListener
- * @see org.eclipse.jface.util.OpenStrategy#TIME
+ * @see org.eclipse.jface.util.OpenStrategy
* @since 3.0
*/
protected int getEmptySelectionChangedEventDelay() {
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/ContextBasedFormattingStrategy.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/ContextBasedFormattingStrategy.java
index 0f2bec61a..7cd7a0756 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/ContextBasedFormattingStrategy.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/ContextBasedFormattingStrategy.java
@@ -18,8 +18,6 @@ import java.util.Map;
* Formatting strategy for context based content formatting.
* <p>
*
- * @see IContentFormatterExtension2
- * @see IFormattingStrategyExtension
* @since 3.0
*/
public abstract class ContextBasedFormattingStrategy implements IFormattingStrategy, IFormattingStrategyExtension {
diff --git a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/FormattingContextProperties.java b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/FormattingContextProperties.java
index 716583df7..7d4afb1c3 100644
--- a/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/FormattingContextProperties.java
+++ b/org.eclipse.jface.text/src/org/eclipse/jface/text/formatter/FormattingContextProperties.java
@@ -14,11 +14,11 @@ package org.eclipse.jface.text.formatter;
/**
* Keys used by <code>IFormattingContext</code> objects to register specific
* properties needed during the formatting process of a content formatter
- * implementing <code>IContentFormatterExtension2</code>.
+ * implementing <code>IContentFormatterExtension</code>.
*
* @see IFormattingContext
* @see IFormattingStrategyExtension
- * @see IContentFormatterExtension2
+ * @see IContentFormatterExtension
* @since 3.0
*/
public class FormattingContextProperties {
diff --git a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationMap.java b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationMap.java
index b16b753a7..5860e0b61 100644
--- a/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationMap.java
+++ b/org.eclipse.text/src/org/eclipse/jface/text/source/IAnnotationMap.java
@@ -49,21 +49,21 @@ public interface IAnnotationMap extends Map, ISynchronizable {
Iterator keySetIterator();
/**
- * @inheritDoc
+ * {@inheritDoc}
*
* The returned set is not synchronized on this annotation map's lock object.
*/
Set entrySet();
/**
- * @inheritDoc
+ * {@inheritDoc}
*
* The returned set is not synchronized on this annotation map's lock object.
*/
Set keySet();
/**
- * @inheritDoc
+ * {@inheritDoc}
*
* The returned collection is not synchronized on this annotation map's lock object.
*/
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 3814a3655..fed183ca3 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
@@ -21,28 +21,28 @@ public interface IFoldingCommandIds {
/**
* Identifier of the "collapse folded region" command.
* <p>
- * Value: {@value).</p>
+ * Value: {@value}.</p>
*/
String FOLDING_COLLAPSE= "org.eclipse.ui.edit.text.folding.collapse"; //$NON-NLS-1$
/**
* Identifier of the "expand folded region" command.
* <p>
- * Value: {@value).</p>
+ * Value: {@value}.</p>
*/
String FOLDING_EXPAND= "org.eclipse.ui.edit.text.folding.expand"; //$NON-NLS-1$
/**
* Identifier of the "expand all folded regions" command.
* <p>
- * Value: {@value).</p>
+ * Value: {@value}.</p>
*/
String FOLDING_EXPAND_ALL= "org.eclipse.ui.edit.text.folding.expand_all"; //$NON-NLS-1$
/**
* Identifier of the "toggle folding" command.
* <p>
- * Value: {@value).</p>
+ * Value: {@value}.</p>
*/
String FOLDING_TOGGLE= "org.eclipse.ui.edit.text.folding.toggle"; //$NON-NLS-1$
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 c09d6fece..852467b99 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
@@ -79,7 +79,7 @@ public class TextEditor extends AbstractDecoratedTextEditor {
}
/**
- * @inheritDoc
+ * {@inheritDoc}
*
* This method configures the editor but does not define a
* <code>SourceViewerConfiguration</code>. When only interested in
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/MarkerAnnotation.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/MarkerAnnotation.java
index a93ffb236..c30d632f5 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/MarkerAnnotation.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/MarkerAnnotation.java
@@ -229,7 +229,7 @@ public class MarkerAnnotation extends SimpleMarkerAnnotation {
*
* @param gc the drawing GC
* @param canvas the canvas to draw on
- * @param bounds the bounds inside the canvas to draw on
+ * @param r the bounds inside the canvas to draw on
* @deprecated since 3.0 use
* <code>IAnnotationAccessExtension.paint(Annotation, GC, Canvas, Rectangle)</code>
* @since 3.0
diff --git a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/MarkerAnnotationPreferences.java b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/MarkerAnnotationPreferences.java
index 75a3dd275..8c1211011 100644
--- a/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/MarkerAnnotationPreferences.java
+++ b/org.eclipse.ui.editors/src/org/eclipse/ui/texteditor/MarkerAnnotationPreferences.java
@@ -97,7 +97,7 @@ public class MarkerAnnotationPreferences {
* setting the default values in the future.
* <p>
* Note: In order to work this method must be called before any
- * call to {@link #initializeDefaultValues(IPreferenceStore)
+ * call to {@link #initializeDefaultValues(IPreferenceStore)}
* </p>
* <p>
* This method is not part of the API and must only be called
@@ -146,7 +146,7 @@ public class MarkerAnnotationPreferences {
* setting the default values in the future.
* <p>
* Note: In order to work this method must be called before any
- * call to {@link #initializeDefaultValues(IPreferenceStore)
+ * call to {@link #initializeDefaultValues(IPreferenceStore)}
* </p>
* <p>
* This method is not part of the API and must only be called
diff --git a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorActionConstants.java b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorActionConstants.java
index 591ca0fd2..4ebbdbf48 100644
--- a/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorActionConstants.java
+++ b/org.eclipse.ui.workbench.texteditor/src/org/eclipse/ui/texteditor/ITextEditorActionConstants.java
@@ -320,7 +320,7 @@ public interface ITextEditorActionConstants extends IWorkbenchActionConstants {
* Name of standard Copy global action in the Edit menu.
* Value <code>"copy"</code>
* @since 3.0
- * @see org.eclipse.ui.actions.ActionFactory#COPY#getId()
+ * @see org.eclipse.ui.actions.ActionFactory#COPY
*/
static final String COPY= ActionFactory.COPY.getId();
@@ -328,7 +328,7 @@ public interface ITextEditorActionConstants extends IWorkbenchActionConstants {
* Name of standard Cut global action in the Edit menu.
* Value <code>"cut"</code>
* @since 3.0
- * @see org.eclipse.ui.actions.ActionFactory#CUT#getId()
+ * @see org.eclipse.ui.actions.ActionFactory#CUT
*/
static final String CUT= ActionFactory.CUT.getId();
@@ -336,7 +336,7 @@ public interface ITextEditorActionConstants extends IWorkbenchActionConstants {
* Name of standard Delete global action in the Edit menu.
* Value <code>"delete"</code>
* @since 3.0
- * @see org.eclipse.ui.actions.ActionFactory#DELETE#getId()
+ * @see org.eclipse.ui.actions.ActionFactory#DELETE
*/
static final String DELETE= ActionFactory.DELETE.getId();
@@ -344,7 +344,7 @@ public interface ITextEditorActionConstants extends IWorkbenchActionConstants {
* Name of standard Find global action in the Edit menu.
* Value <code>"find"</code>
* @since 3.0
- * @see org.eclipse.ui.actions.ActionFactory#FIND#getId()
+ * @see org.eclipse.ui.actions.ActionFactory#FIND
*/
static final String FIND= ActionFactory.FIND.getId();
@@ -352,7 +352,7 @@ public interface ITextEditorActionConstants extends IWorkbenchActionConstants {
* Name of standard Paste global action in the Edit menu.
* Value <code>"paste"</code>
* @since 3.0
- * @see org.eclipse.ui.actions.ActionFactory#PASTE#getId()
+ * @see org.eclipse.ui.actions.ActionFactory#PASTE
*/
static final String PASTE= ActionFactory.PASTE.getId();
@@ -360,7 +360,7 @@ public interface ITextEditorActionConstants extends IWorkbenchActionConstants {
* Name of standard Print global action in the File menu.
* Value <code>"print"</code>
* @since 3.0
- * @see org.eclipse.ui.actions.ActionFactory#PRINT#getId()
+ * @see org.eclipse.ui.actions.ActionFactory#PRINT
*/
static final String PRINT= ActionFactory.PRINT.getId();
@@ -368,7 +368,7 @@ public interface ITextEditorActionConstants extends IWorkbenchActionConstants {
* Name of standard Redo global action in the Edit menu.
* Value <code>"redo"</code>
* @since 3.0
- * @see org.eclipse.ui.actions.ActionFactory#REDO#getId()
+ * @see org.eclipse.ui.actions.ActionFactory#REDO
*/
static final String REDO= ActionFactory.REDO.getId();
@@ -376,7 +376,7 @@ public interface ITextEditorActionConstants extends IWorkbenchActionConstants {
* Name of standard Undo global action in the Edit menu.
* Value <code>"undo"</code>
* @since 3.0
- * @see org.eclipse.ui.actions.ActionFactory#UNDO#getId()
+ * @see org.eclipse.ui.actions.ActionFactory#UNDO
*/
static final String UNDO= ActionFactory.UNDO.getId();
@@ -384,7 +384,7 @@ public interface ITextEditorActionConstants extends IWorkbenchActionConstants {
* Name of standard Save global action in the File menu.
* Value <code>"save"</code>
* @since 3.0
- * @see org.eclipse.ui.actions.ActionFactory#SAVE#getId()
+ * @see org.eclipse.ui.actions.ActionFactory#SAVE
*/
static final String SAVE= ActionFactory.SAVE.getId();
@@ -392,7 +392,7 @@ public interface ITextEditorActionConstants extends IWorkbenchActionConstants {
* Name of standard Select All global action in the Edit menu.
* Value <code>"selectAll"</code>
* @since 3.0
- * @see org.eclipse.ui.actions.ActionFactory#SELECT_ALL#getId()
+ * @see org.eclipse.ui.actions.ActionFactory#SELECT_ALL
*/
static final String SELECT_ALL= ActionFactory.SELECT_ALL.getId();
@@ -400,7 +400,7 @@ public interface ITextEditorActionConstants extends IWorkbenchActionConstants {
* Name of standard Revert global action in the File menu.
* Value <code>"revert"</code>
* @since 3.0
- * @see org.eclipse.ui.actions.ActionFactory#REVERT#getId()
+ * @see org.eclipse.ui.actions.ActionFactory#REVERT
*/
static final String REVERT= ActionFactory.REVERT.getId();

Back to the top