1
0
Fork 0
mirror of https://github.com/eclipse-cdt/cdt synced 2025-08-19 06:05:56 +02:00

[196942][apidoc] SubSystemConfiguration.getSystemTypes(), getName(), getId() etc. should be marked not to be overridden

This commit is contained in:
Martin Oberhuber 2008-04-09 22:11:58 +00:00
parent a05bf8c8f8
commit beda642b75

View file

@ -458,11 +458,13 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
// --------------------------------- // ---------------------------------
/** /**
* Return vendor of this subsystem configuration. * Return vendor of this subsystem configuration. This comes from the xml
* This comes from the xml "vendor" attribute of the extension point. * "vendor" attribute of the extension point.
* *
* <b>Do not override this method</b>, it will likely be declared * @noextend This method is not intended to be extended by clients. It will
* <tt>final</tt> in the next release. * likely be declared <tt>final</tt> in the next release in
* order to ensure consistency with static xml markup in the
* extension.
*/ */
public String getVendor() public String getVendor()
{ {
@ -470,11 +472,13 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
} }
/** /**
* Return name of this subsystem configuration. * Return name of this subsystem configuration. This comes from the xml
* This comes from the xml "name" attribute of the extension point. * "name" attribute of the extension point.
* *
* <b>Do not override this method</b>, it will likely be declared * @noextend This method is not intended to be extended by clients. It will
* <tt>final</tt> in the next release. * likely be declared <tt>final</tt> in the next release in
* order to ensure consistency with static xml markup in the
* extension.
*/ */
public String getName() public String getName()
{ {
@ -482,11 +486,13 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
} }
/** /**
* Return name of this subsystem configuration. * Return name of this subsystem configuration. This comes from the xml
* This comes from the xml "description" attribute of the extension point. * "description" attribute of the extension point.
* *
* <b>Do not override this method</b>, it will likely be declared * @noextend This method is not intended to be extended by clients. It will
* <tt>final</tt> in the next release. * likely be declared <tt>final</tt> in the next release in
* order to ensure consistency with static xml markup in the
* extension.
*/ */
public String getDescription() public String getDescription()
{ {
@ -494,11 +500,13 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
} }
/** /**
* Return unique id of this subsystem configuration. * Return unique id of this subsystem configuration. This comes from the xml
* This comes from the xml "id" attribute of the extension point. * "id" attribute of the extension point.
* *
* <b>Do not override this method</b>, it will likely be declared * @noextend This method is not intended to be extended by clients. It will
* <tt>final</tt> in the next release. * likely be declared <tt>final</tt> in the next release in
* order to ensure consistency with static xml markup in the
* extension.
*/ */
public String getId() public String getId()
{ {
@ -506,12 +514,15 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
} }
/** /**
* Return the category this subsystem configuration subscribes to. * Return the category this subsystem configuration subscribes to. This
* This comes from the xml "category" attribute of the extension point. * comes from the xml "category" attribute of the extension point.
*
* @see org.eclipse.rse.core.model.ISubSystemConfigurationCategories * @see org.eclipse.rse.core.model.ISubSystemConfigurationCategories
* *
* <b>Do not override this method</b>, it will likely be declared * @noextend This method is not intended to be extended by clients. It will
* <tt>final</tt> in the next release. * likely be declared <tt>final</tt> in the next release in
* order to ensure consistency with static xml markup in the
* extension.
*/ */
public String getCategory() public String getCategory()
{ {
@ -519,13 +530,15 @@ public abstract class SubSystemConfiguration implements ISubSystemConfiguration
} }
/** /**
* Return the system types this subsystem configuration supports. * Return the system types this subsystem configuration supports. These come
* These come from static declaration in the * from static declaration in the
* <tt>org.eclipse.rse.core.subsystemConfigurations</tt> and * <tt>org.eclipse.rse.core.subsystemConfigurations</tt> and
* <tt>org.eclipse.rse.core.systemTypes</tt> extension points. * <tt>org.eclipse.rse.core.systemTypes</tt> extension points.
* *
* <b>Do not override this method</b>, it will likely be declared * @noextend This method is not intended to be extended by clients. It will
* <tt>final</tt> in the next release. * likely be declared <tt>final</tt> in the next release in
* order to ensure consistency with static xml markup in the
* extension.
*/ */
public IRSESystemType[] getSystemTypes() public IRSESystemType[] getSystemTypes()
{ {