Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKai Maetzel2004-06-23 12:53:41 +0000
committerKai Maetzel2004-06-23 12:53:41 +0000
commit74181f9bae83384cd6207d81542f1a22a8c53ab8 (patch)
tree3d19a89c5e8bb870813854be0511228dca751eb2
parent7453932111bb6d1fe31b4d88bb5c41d7d39f1334 (diff)
downloadeclipse.platform.text-74181f9bae83384cd6207d81542f1a22a8c53ab8.tar.gz
eclipse.platform.text-74181f9bae83384cd6207d81542f1a22a8c53ab8.tar.xz
eclipse.platform.text-74181f9bae83384cd6207d81542f1a22a8c53ab8.zip
updated Javadoc
-rw-r--r--org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/FileBuffers.java6
-rw-r--r--org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IAnnotationModelFactory.java2
-rw-r--r--org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IDocumentFactory.java2
-rw-r--r--org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IDocumentSetupParticipant.java2
-rw-r--r--org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IFileBufferManager.java2
-rw-r--r--org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/ISynchronizationContext.java20
6 files changed, 23 insertions, 11 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 f682d9e06..1458c5770 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
@@ -22,9 +22,9 @@ import org.eclipse.core.runtime.IPath;
/**
- * Facade for the file buffers plug-in. Provides access to the
- * text file buffer manager and helper methods for location
- * handling.
+ * Facade for the file buffers plug-in. Provides access to the text file buffer
+ * manager and helper methods for location handling. This facade is available
+ * independent from the activation status of the file buffers plug-in.
*
* @since 3.0
*/
diff --git a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IAnnotationModelFactory.java b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IAnnotationModelFactory.java
index bc091855d..9d822637b 100644
--- a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IAnnotationModelFactory.java
+++ b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IAnnotationModelFactory.java
@@ -20,7 +20,7 @@ import org.eclipse.jface.text.source.IAnnotationModel;
* Factory for text file buffer annotation models. Used by the text file buffer
* manager to create the annotation model for a new text file buffer.
* <p>
- * The expected interface for extension provided for the
+ * This interface is the expected interface for extensions provided for the
* <code>"org.eclipse.core.filebuffers.annotationModelCreation"</code>
* extension point.
*
diff --git a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IDocumentFactory.java b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IDocumentFactory.java
index bd27c2819..2a8e1177f 100644
--- a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IDocumentFactory.java
+++ b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IDocumentFactory.java
@@ -16,7 +16,7 @@ import org.eclipse.jface.text.IDocument;
* Factory for text file buffer documents. Used by the text file buffer manager
* to create the document for a new text file buffer.
* <p>
- * The expected interface of extensions provided for the
+ * This interface is the expected interface of extensions provided for the
* <code>"org.eclipse.core.filebuffers.documentCreation"</code> extension
* point.
*
diff --git a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IDocumentSetupParticipant.java b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IDocumentSetupParticipant.java
index ab0cfb60d..4cc6d82ac 100644
--- a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IDocumentSetupParticipant.java
+++ b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IDocumentSetupParticipant.java
@@ -17,7 +17,7 @@ import org.eclipse.jface.text.IDocument;
/**
* Participates in the setup of a text file buffer document.
* <p>
- * The expected interface for extensions provided for the
+ * This interface is the expected interface for extensions provided for the
* <code>"org.eclipse.core.filebuffers.documentSetup"</code> extension point.
* <p>
* Participants have to be aware of the existence of other participants. I.e.
diff --git a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IFileBufferManager.java b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IFileBufferManager.java
index 9def6296f..bbdcb835e 100644
--- a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IFileBufferManager.java
+++ b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/IFileBufferManager.java
@@ -21,7 +21,7 @@ import org.eclipse.core.runtime.IProgressMonitor;
* connected to the file buffer manager. In order to connect a file to a file
* buffer manager call <code>connect</code>. After that call has
* successfully completed the file buffer can be obtained by <code>getFileBuffer</code>.
- * The file buffer is created on the first connect and diposed on the last
+ * The file buffer is created on the first connect and disposed on the last
* disconnect. I.e. the file buffer manager keeps track of how often a file is
* connected and returns the same file buffer to each client as long as the
* file is connected.
diff --git a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/ISynchronizationContext.java b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/ISynchronizationContext.java
index 78932ce66..332ee33c9 100644
--- a/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/ISynchronizationContext.java
+++ b/org.eclipse.core.filebuffers/src/org/eclipse/core/filebuffers/ISynchronizationContext.java
@@ -11,16 +11,28 @@ Contributors:
package org.eclipse.core.filebuffers;
/**
- * Executes <code>Runnables</code> according to a certain synchronization
- * policy. This could be that all given <code>Runnables</code> are executed in
- * a specific thread or environment.
+ * A file buffer manager (see
+ * {@link org.eclipse.core.filebuffers.IFileBufferManager}uses a
+ * <code>ISynchronizationContext</code> in order to execute commands
+ * encapsulated as {@link java.lang.Runnable}. The synchronization context
+ * executes the <code>Runnables</code> according to a specific
+ * synchronization/execution policy. This could be that the given
+ * <code>Runnable</code> is executed in a specific thread or environment or
+ * adhere to specific timing constraints. The concrete characteristics of the
+ * policy is to be specified by the context implementer.
+ * <p>
+ * This interface can be implemented by clients. Clients use
+ * {@link org.eclipse.core.filebuffers.IFileBufferManager#setSynchronizationContext(ISynchronizationContext)}
+ * to install a particular synchronization context with a file buffer manager.
*
* @since 3.0
*/
public interface ISynchronizationContext {
/**
- * Executes the given runnable.
+ * Executes the given runnable according to the specified
+ * synchronization/execution policy.
+ *
*
* @param runnable the runnable to be executed
*/

Back to the top