Skip to main content
aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorKai Maetzel2004-06-23 13:40:01 +0000
committerKai Maetzel2004-06-23 13:40:01 +0000
commit507dee05cac43e62d429e0a45a56b5aae6b1ba15 (patch)
tree4deb42557215242d8e5bc7445ebc876c946d81c1
parentbb6ef114c0ce93c4a75ffbf4f8e0b7dfa4cdf126 (diff)
downloadeclipse.platform.text-507dee05cac43e62d429e0a45a56b5aae6b1ba15.tar.gz
eclipse.platform.text-507dee05cac43e62d429e0a45a56b5aae6b1ba15.tar.xz
eclipse.platform.text-507dee05cac43e62d429e0a45a56b5aae6b1ba15.zip
updated Javadoc
-rw-r--r--org.eclipse.core.filebuffers/schema/annotationModelCreation.exsd29
-rw-r--r--org.eclipse.core.filebuffers/schema/documentCreation.exsd41
-rw-r--r--org.eclipse.core.filebuffers/schema/documentSetup.exsd41
3 files changed, 77 insertions, 34 deletions
diff --git a/org.eclipse.core.filebuffers/schema/annotationModelCreation.exsd b/org.eclipse.core.filebuffers/schema/annotationModelCreation.exsd
index 47e2ef989..aae20f474 100644
--- a/org.eclipse.core.filebuffers/schema/annotationModelCreation.exsd
+++ b/org.eclipse.core.filebuffers/schema/annotationModelCreation.exsd
@@ -6,7 +6,7 @@
<meta.schema plugin="org.eclipse.core.filebuffers" id="annotationModelCreation" name="Annotation Model Creation"/>
</appInfo>
<documentation>
- This extension point is interesting for your if you want the file buffer manager to instantiate a specific annotation models for certain file content types, file extensions, or file names.
+ This extension point is used to customize the annotation model creation behavior of this plug-in&apos;s default text file buffer manager. It allows to specify which annotation model factory should be used in order to create the annotation model instance of a text file buffer created for a certain file content type, file extension, or file name.
</documentation>
</annotation>
@@ -40,11 +40,16 @@
</element>
<element name="factory">
+ <annotation>
+ <documentation>
+ The specification of a annotation model factory. In order to find a factory for a given file the attributes of each factory specification are consulted in the following sequence: contentTypeId, fileNames, extensions. If multiple, equally specific factory specifications are found for a given file it is not specified which factory is used.
+ </documentation>
+ </annotation>
<complexType>
<attribute name="class" type="string" use="required">
<annotation>
<documentation>
-
+ The fully qualified name of the factory implementation class. This class must implement the org.eclipse.core.filebuffers.IAnnotationModelFactory interface.
</documentation>
<appInfo>
<meta.attribute kind="java" basedOn="org.eclipse.core.filebuffers.IAnnotationModelFactory"/>
@@ -54,21 +59,21 @@
<attribute name="extensions" type="string">
<annotation>
<documentation>
-
+ A comma separated list of file extensions for which this factory should be used.
</documentation>
</annotation>
</attribute>
<attribute name="fileNames" type="string">
<annotation>
<documentation>
-
+ A comma separated list of file names for which this factory should be used.
</documentation>
</annotation>
</attribute>
<attribute name="contentTypeId" type="string">
<annotation>
<documentation>
-
+ The id of a content type as defined by the org.eclipse.core.runtime.contentTypes extension point for which this factory should be used.
</documentation>
</annotation>
</attribute>
@@ -89,7 +94,15 @@
<meta.section type="examples"/>
</appInfo>
<documentation>
- [Enter extension point usage example here.]
+ &lt;pre&gt;
+ &lt;extension
+ point=&quot;org.eclipse.core.filebuffers.annotationModelCreation&quot;&gt;
+ &lt;factory
+ extensions=&quot;xzy&quot;
+ class=&quot;org.eclipse.ui.texteditor.ResourceMarkerAnnotationModelFactory&quot;&gt;
+ &lt;/factory&gt;
+ &lt;/extension&gt;
+&lt;/pre&gt;
</documentation>
</annotation>
@@ -98,7 +111,7 @@
<meta.section type="apiInfo"/>
</appInfo>
<documentation>
- [Enter API information here.]
+ Annotation model factories have to implement org.eclipse.core.filebuffers.IAnnotationModelFactory.
</documentation>
</annotation>
@@ -107,7 +120,7 @@
<meta.section type="implementation"/>
</appInfo>
<documentation>
- [Enter information about supplied implementation of this extension point.]
+
</documentation>
</annotation>
diff --git a/org.eclipse.core.filebuffers/schema/documentCreation.exsd b/org.eclipse.core.filebuffers/schema/documentCreation.exsd
index 850b026aa..2bdca3617 100644
--- a/org.eclipse.core.filebuffers/schema/documentCreation.exsd
+++ b/org.eclipse.core.filebuffers/schema/documentCreation.exsd
@@ -6,7 +6,7 @@
<meta.schema plugin="org.eclipse.core.filebuffers" id="documentCreation" name="Document Creation"/>
</appInfo>
<documentation>
- This extension point is interesting for your if you want the file buffer manager to instantiate a specific document implementation for certain file content types, file extensions, or file names.
+ This extension point is used to customize the document creation behavior of this plug-in&apos;s default text file buffer manager. It allows to specify which document factory should be used in order to create the document instance of a text file buffer created for a certain file content type, file extension, or file name.
</documentation>
</annotation>
@@ -40,11 +40,16 @@
</element>
<element name="factory">
+ <annotation>
+ <documentation>
+ The specification of a document factory. In order to find a factory for a given file the attributes of each factory specification are consulted in the following sequence: contentTypeId, fileNames, extensions. If multiple, equally specific factory specifications are found for a given file it is not specified which factory is used.
+ </documentation>
+ </annotation>
<complexType>
<attribute name="class" type="string" use="required">
<annotation>
<documentation>
-
+ The fully qualified name of the factory implementation class. This class must implement the org.eclipse.core.filebuffers.IDocumentFactory interface.
</documentation>
<appInfo>
<meta.attribute kind="java" basedOn="org.eclipse.core.filebuffers.IDocumentFactory"/>
@@ -54,21 +59,21 @@
<attribute name="extensions" type="string">
<annotation>
<documentation>
-
+ A comma separated list of file extensions for which this factory should be used.
</documentation>
</annotation>
</attribute>
<attribute name="fileNames" type="string">
<annotation>
<documentation>
-
+ A comma separated list of file names for which this factory should be used.
</documentation>
</annotation>
</attribute>
<attribute name="contentTypeId" type="string">
<annotation>
<documentation>
-
+ The id of a content type as defined by the org.eclipse.core.runtime.contentTypes extension point for which this factory should be used.
</documentation>
</annotation>
</attribute>
@@ -89,7 +94,17 @@
<meta.section type="examples"/>
</appInfo>
<documentation>
- [Enter extension point usage example here.]
+ &lt;pre&gt;
+&lt;extension
+ id=&quot;org.eclipse.jdt.debug.ui.SnippetDocumentFactory&quot;
+ name=&quot;%snippetDocumentFactory.name&quot;
+ point=&quot;org.eclipse.core.filebuffers.documentCreation&quot;&gt;
+ &lt;factory
+ extensions=&quot;jpage&quot;
+ class=&quot;org.eclipse.jdt.internal.debug.ui.snippeteditor.SnippetDocumentFactory&quot;&gt;
+ &lt;/factory&gt;
+&lt;/extension&gt;
+&lt;/pre&gt;
</documentation>
</annotation>
@@ -98,7 +113,7 @@
<meta.section type="apiInfo"/>
</appInfo>
<documentation>
- [Enter API information here.]
+ Document factories have to implement org.eclipse.core.filebuffers.IDocumentFactory.
</documentation>
</annotation>
@@ -107,7 +122,7 @@
<meta.section type="implementation"/>
</appInfo>
<documentation>
- [Enter information about supplied implementation of this extension point.]
+
</documentation>
</annotation>
@@ -116,11 +131,11 @@
<meta.section type="copyright"/>
</appInfo>
<documentation>
- &lt;p&gt;
-&lt;a href=&quot;hglegal.htm&quot;&gt;
- &lt;img SRC=&quot;ngibmcpy.gif&quot;
- ALT=&quot;Copyright (c) 2000, 2003 IBM Corporation and others. All Rights Reserved.&quot;
- BORDER=&quot;0&quot; height=&quot;14&quot; width=&quot;324&quot;&gt;&lt;/a&gt;
+ &lt;p&gt;
+&lt;a href=&quot;hglegal.htm&quot;&gt;
+ &lt;img SRC=&quot;ngibmcpy.gif&quot;
+ ALT=&quot;Copyright (c) 2000, 2003 IBM Corporation and others. All Rights Reserved.&quot;
+ BORDER=&quot;0&quot; height=&quot;14&quot; width=&quot;324&quot;&gt;&lt;/a&gt;
&lt;/p&gt;
</documentation>
</annotation>
diff --git a/org.eclipse.core.filebuffers/schema/documentSetup.exsd b/org.eclipse.core.filebuffers/schema/documentSetup.exsd
index a43584392..c15fc1b2e 100644
--- a/org.eclipse.core.filebuffers/schema/documentSetup.exsd
+++ b/org.eclipse.core.filebuffers/schema/documentSetup.exsd
@@ -6,7 +6,7 @@
<meta.schema plugin="org.eclipse.core.filebuffers" id="documentSetup" name="Document Setup"/>
</appInfo>
<documentation>
- This extension point is interesting if you want to install specific partitioners etc. on documents created by the file buffer manager for certain file content types, file extensions, or file names.
+ This extension point is used to customize the initialization process of a document for a text file buffer manager by this plug-in&apos;s default text file buffer manager. It allows to specify which document setup participant should be involved in the initialization process for a text file buffer created for a certain file content type, file extension, or file name.
</documentation>
</annotation>
@@ -40,11 +40,16 @@
</element>
<element name="participant">
+ <annotation>
+ <documentation>
+ The specification of a document setup participant. In order find all participants for a given file the attributes of each participant specification are consulted in the following sequence: contentTypeId, fileNames, extensions. If multiple participants are found, the sequence in which they are called is not specified.
+ </documentation>
+ </annotation>
<complexType>
<attribute name="class" type="string" use="required">
<annotation>
<documentation>
-
+ The fully qualified name of the participant implementation class. This class must implement the org.eclipse.core.filebuffers.IDocumentSetupParticipant interface.
</documentation>
<appInfo>
<meta.attribute kind="java" basedOn="org.eclipse.core.filebuffers.IDocumentSetupParticipant"/>
@@ -54,21 +59,21 @@
<attribute name="extensions" type="string">
<annotation>
<documentation>
-
+ A comma separated list of file extensions for which this participant should be used.
</documentation>
</annotation>
</attribute>
<attribute name="fileNames" type="string">
<annotation>
<documentation>
-
+ A comma separated list of file names for which this participant should be used.
</documentation>
</annotation>
</attribute>
<attribute name="contentTypeId" type="string">
<annotation>
<documentation>
-
+ The id of a content type as defined by the org.eclipse.core.runtime.contentTypes extension point for which this participant should be used.
</documentation>
</annotation>
</attribute>
@@ -89,7 +94,17 @@
<meta.section type="examples"/>
</appInfo>
<documentation>
- [Enter extension point usage example here.]
+ &lt;pre&gt;
+ &lt;extension
+ id=&quot;JavaDocumentSetupParticipant&quot;
+ name=&quot;%javaDocumentSetupParticipant&quot;
+ point=&quot;org.eclipse.core.filebuffers.documentSetup&quot;&gt;
+ &lt;participant
+ extensions=&quot;java&quot;
+ class=&quot;org.eclipse.jdt.internal.ui.javaeditor.JavaDocumentSetupParticipant&quot;&gt;
+ &lt;/participant&gt;
+ &lt;/extension&gt;
+&lt;/pre&gt;
</documentation>
</annotation>
@@ -98,7 +113,7 @@
<meta.section type="apiInfo"/>
</appInfo>
<documentation>
- [Enter API information here.]
+ Document setup participants have to implement org.eclipse.core.filebuffers.IDocumentSetupParticipant.
</documentation>
</annotation>
@@ -107,7 +122,7 @@
<meta.section type="implementation"/>
</appInfo>
<documentation>
- [Enter information about supplied implementation of this extension point.]
+
</documentation>
</annotation>
@@ -116,11 +131,11 @@
<meta.section type="copyright"/>
</appInfo>
<documentation>
- &lt;p&gt;
-&lt;a href=&quot;hglegal.htm&quot;&gt;
- &lt;img SRC=&quot;ngibmcpy.gif&quot;
- ALT=&quot;Copyright (c) 2000, 2003 IBM Corporation and others. All Rights Reserved.&quot;
- BORDER=&quot;0&quot; height=&quot;14&quot; width=&quot;324&quot;&gt;&lt;/a&gt;
+ &lt;p&gt;
+&lt;a href=&quot;hglegal.htm&quot;&gt;
+ &lt;img SRC=&quot;ngibmcpy.gif&quot;
+ ALT=&quot;Copyright (c) 2000, 2003 IBM Corporation and others. All Rights Reserved.&quot;
+ BORDER=&quot;0&quot; height=&quot;14&quot; width=&quot;324&quot;&gt;&lt;/a&gt;
&lt;/p&gt;
</documentation>
</annotation>

Back to the top