From 507dee05cac43e62d429e0a45a56b5aae6b1ba15 Mon Sep 17 00:00:00 2001 From: Kai Maetzel Date: Wed, 23 Jun 2004 13:40:01 +0000 Subject: updated Javadoc --- .../schema/annotationModelCreation.exsd | 29 ++++++++++----- .../schema/documentCreation.exsd | 41 +++++++++++++++------- .../schema/documentSetup.exsd | 41 +++++++++++++++------- 3 files changed, 77 insertions(+), 34 deletions(-) (limited to 'org.eclipse.core.filebuffers/schema') 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 @@ - 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'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. @@ -40,11 +40,16 @@ + + + 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. + + - + The fully qualified name of the factory implementation class. This class must implement the org.eclipse.core.filebuffers.IAnnotationModelFactory interface. @@ -54,21 +59,21 @@ - + A comma separated list of file extensions for which this factory should be used. - + A comma separated list of file names for which this factory should be used. - + The id of a content type as defined by the org.eclipse.core.runtime.contentTypes extension point for which this factory should be used. @@ -89,7 +94,15 @@ - [Enter extension point usage example here.] + <pre> + <extension + point="org.eclipse.core.filebuffers.annotationModelCreation"> + <factory + extensions="xzy" + class="org.eclipse.ui.texteditor.ResourceMarkerAnnotationModelFactory"> + </factory> + </extension> +</pre> @@ -98,7 +111,7 @@ - [Enter API information here.] + Annotation model factories have to implement org.eclipse.core.filebuffers.IAnnotationModelFactory. @@ -107,7 +120,7 @@ - [Enter information about supplied implementation of this extension point.] + 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 @@ - 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'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. @@ -40,11 +40,16 @@ + + + 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. + + - + The fully qualified name of the factory implementation class. This class must implement the org.eclipse.core.filebuffers.IDocumentFactory interface. @@ -54,21 +59,21 @@ - + A comma separated list of file extensions for which this factory should be used. - + A comma separated list of file names for which this factory should be used. - + The id of a content type as defined by the org.eclipse.core.runtime.contentTypes extension point for which this factory should be used. @@ -89,7 +94,17 @@ - [Enter extension point usage example here.] + <pre> +<extension + id="org.eclipse.jdt.debug.ui.SnippetDocumentFactory" + name="%snippetDocumentFactory.name" + point="org.eclipse.core.filebuffers.documentCreation"> + <factory + extensions="jpage" + class="org.eclipse.jdt.internal.debug.ui.snippeteditor.SnippetDocumentFactory"> + </factory> +</extension> +</pre> @@ -98,7 +113,7 @@ - [Enter API information here.] + Document factories have to implement org.eclipse.core.filebuffers.IDocumentFactory. @@ -107,7 +122,7 @@ - [Enter information about supplied implementation of this extension point.] + @@ -116,11 +131,11 @@ - <p> -<a href="hglegal.htm"> - <img SRC="ngibmcpy.gif" - ALT="Copyright (c) 2000, 2003 IBM Corporation and others. All Rights Reserved." - BORDER="0" height="14" width="324"></a> + <p> +<a href="hglegal.htm"> + <img SRC="ngibmcpy.gif" + ALT="Copyright (c) 2000, 2003 IBM Corporation and others. All Rights Reserved." + BORDER="0" height="14" width="324"></a> </p> 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 @@ - 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'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. @@ -40,11 +40,16 @@ + + + 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. + + - + The fully qualified name of the participant implementation class. This class must implement the org.eclipse.core.filebuffers.IDocumentSetupParticipant interface. @@ -54,21 +59,21 @@ - + A comma separated list of file extensions for which this participant should be used. - + A comma separated list of file names for which this participant should be used. - + The id of a content type as defined by the org.eclipse.core.runtime.contentTypes extension point for which this participant should be used. @@ -89,7 +94,17 @@ - [Enter extension point usage example here.] + <pre> + <extension + id="JavaDocumentSetupParticipant" + name="%javaDocumentSetupParticipant" + point="org.eclipse.core.filebuffers.documentSetup"> + <participant + extensions="java" + class="org.eclipse.jdt.internal.ui.javaeditor.JavaDocumentSetupParticipant"> + </participant> + </extension> +</pre> @@ -98,7 +113,7 @@ - [Enter API information here.] + Document setup participants have to implement org.eclipse.core.filebuffers.IDocumentSetupParticipant. @@ -107,7 +122,7 @@ - [Enter information about supplied implementation of this extension point.] + @@ -116,11 +131,11 @@ - <p> -<a href="hglegal.htm"> - <img SRC="ngibmcpy.gif" - ALT="Copyright (c) 2000, 2003 IBM Corporation and others. All Rights Reserved." - BORDER="0" height="14" width="324"></a> + <p> +<a href="hglegal.htm"> + <img SRC="ngibmcpy.gif" + ALT="Copyright (c) 2000, 2003 IBM Corporation and others. All Rights Reserved." + BORDER="0" height="14" width="324"></a> </p> -- cgit v1.2.1