mirrors/cdt
1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-04 06:45:43 +02:00
Code Issues Wiki Activity

Clarified JavaDoc for LanguageSettingsSerializableProvider.

Browse source
This commit is contained in:
Andrew Gvozdev 2013-06-18 10:46:32 -04:00
parent 2f98cac092
commit ff5cecb5f8
2 changed files with 10 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
core/org.eclipse.cdt.core/model/org/eclipse/cdt/core/language/settings/providers/LanguageSettingsSerializableProvider.java
View file

@ -1,5 +1,5 @@
/*******************************************************************************
* Copyright (c) 2009, 2011 Andrew Gvozdev and others.
* Copyright (c) 2009, 2013 Andrew Gvozdev and others.
* All rights reserved. This program and the accompanying materials
* are made available under the terms of the Eclipse Public License v1.0
* which accompanies this distribution, and is available at
@ -34,8 +34,11 @@ import org.w3c.dom.NodeList;
/**
* This class is the base class for language settings providers able to serialize
* into XML storage.
* Although this class has setter methods, its instances are not editable in UI by
* design. Implement {@link ILanguageSettingsEditableProvider} interface for that.
* Although this class has setter methods, by design its instances are not editable in UI
* nor instances can be assigned to a configuration (cannot be global or non-shared).
* Implement {@link ILanguageSettingsEditableProvider} interface for that. There is a generic
* implementation of this interface available to be used, see {@link LanguageSettingsGenericProvider}.
*
* For more on the suggested way of extending this class see the description of
* {@link ILanguageSettingsProvider}.
*

7
core/org.eclipse.cdt.core/schema/LanguageSettingsProvider.exsd
View file

@ -64,8 +64,9 @@
<attribute name="class" type="string">
<annotation>
<documentation>
A fully qualified name of the Java class that implements &lt;samp&gt;org.eclipse.cdt.core.settings.model.ILanguageSettingsProvider&lt;/samp&gt; interface. If empty, &lt;samp&gt;org.eclipse.cdt.core.language.settings.providers.LanguageSettingsBaseProvider&lt;/samp&gt; is used by default which provides basic functionality defined by this extension point.
If there is a need to configure a provider in more deliberate way, attribute &lt;samp&gt;parameter&lt;/samp&gt; could be used in a class extending &lt;samp&gt;LanguageSettingsBaseProvider&lt;/samp&gt;.
A fully qualified name of the Java class that implements &lt;samp&gt;org.eclipse.cdt.core.language.settings.providers&lt;/samp&gt; interface. If empty, &lt;samp&gt;org.eclipse.cdt.core.language.settings.providers.LanguageSettingsBaseProvider&lt;/samp&gt; is used by default which provides basic functionality defined by this extension point.&lt;br&gt;
In case the provider ever needs to be non-shared, set per project/configuration, or editable in UI - the provider must implement &lt;samp&gt;org.eclipse.cdt.core.language.settings.providers.ILanguageSettingsEditableProvider&lt;/samp&gt;. There is a generic implementation &lt;samp&gt;org.eclipse.cdt.core.language.settings.providers.LanguageSettingsGenericProvider&lt;/samp&gt; that can be used in most cases.&lt;br&gt;
If there is a need to configure a provider in more deliberate way, attribute &lt;samp&gt;parameter&lt;/samp&gt; could be used in a class extending &lt;samp&gt;LanguageSettingsBaseProvider&lt;/samp&gt;.&lt;br&gt;
Default constructor (constructor without arguments) of this class must be public and the package be exported in order to be able to instantiate via extension point.
</documentation>
<appInfo>
@ -265,7 +266,7 @@ For those cases where contributed settings entries (representing the compiler op
<meta.section type="copyright"/>
</appInfo>
<documentation>
Copyright (c) 2009, 2011 Andrew Gvozdev and others.
Copyright (c) 2009, 2013 Andrew Gvozdev and others.
All rights reserved. This program and the accompanying materials
are made available under the terms of the Eclipse Public License v1.0
which accompanies this distribution, and is available at