diff options
author | Darin Wright | 2004-09-17 15:09:00 +0000 |
---|---|---|
committer | Darin Wright | 2004-09-17 15:09:00 +0000 |
commit | d4e5f902585c59a3b272133aa7d988822e0a6668 (patch) | |
tree | 5433076743a25515f3598d91e15db133eb6f2b24 /org.eclipse.ui.console/schema | |
parent | 4a493016351062a91bbf72b27190b4c90fb371a5 (diff) | |
download | eclipse.platform.debug-d4e5f902585c59a3b272133aa7d988822e0a6668.tar.gz eclipse.platform.debug-d4e5f902585c59a3b272133aa7d988822e0a6668.tar.xz eclipse.platform.debug-d4e5f902585c59a3b272133aa7d988822e0a6668.zip |
console javadoc updates/code review
Diffstat (limited to 'org.eclipse.ui.console/schema')
-rw-r--r-- | org.eclipse.ui.console/schema/consoleFactories.exsd | 36 |
1 files changed, 25 insertions, 11 deletions
diff --git a/org.eclipse.ui.console/schema/consoleFactories.exsd b/org.eclipse.ui.console/schema/consoleFactories.exsd index d2327b286..99ac06015 100644 --- a/org.eclipse.ui.console/schema/consoleFactories.exsd +++ b/org.eclipse.ui.console/schema/consoleFactories.exsd @@ -6,7 +6,7 @@ <meta.schema plugin="org.eclipse.ui.console" id="consoleFactories" name="Console Factories"/>
</appInfo>
<documentation>
- [Enter description of this extension point.]
+ An action to open a console in the console view.
</documentation>
</annotation>
@@ -44,26 +44,26 @@ <element name="consoleFactory">
<complexType>
<sequence>
- <element ref="enablement"/>
+ <element ref="enablement" minOccurs="0" maxOccurs="1"/>
</sequence>
<attribute name="label" type="string" use="required">
<annotation>
<documentation>
-
+ action label to appear in menu
</documentation>
</annotation>
</attribute>
- <attribute name="image" type="string">
+ <attribute name="icon" type="string">
<annotation>
<documentation>
-
+ optional plug-in relative path to an icon to appear with the action
</documentation>
</annotation>
</attribute>
<attribute name="class" type="string" use="required">
<annotation>
<documentation>
-
+ class implementing <code>org.eclipse.ui.console.IConsoleFactory</code> that will be called when the assocaited action is invoked
</documentation>
</annotation>
</attribute>
@@ -75,7 +75,7 @@ <meta.section type="since"/>
</appInfo>
<documentation>
- [Enter the first release in which this extension point appears.]
+ 3.1
</documentation>
</annotation>
@@ -84,7 +84,17 @@ <meta.section type="examples"/>
</appInfo>
<documentation>
- [Enter extension point usage example here.]
+ The following is an example of a console factory extension point:
+<pre>
+<extension point="org.eclipse.ui.console.consoleFactories">
+ <consoleFactory
+ label="Command Console"
+ class="com.example.CommandConsoleFactory"
+ icon="icons/cmd_console.gif">
+ </consoleFactory>
+</extension>
+</pre>
+This extension will cause an entry to appear in the console view's <b>Open Console</b> drop-down menu labelled <b>Command Console</b> with the specified icon. When the action is invoked by a user, the method <b>openConsole()</b> on the class <b>com.example.CommandConsoleFactory</b> will be called. The factory can the decide to create a new console or activate an existing console.
</documentation>
</annotation>
@@ -93,7 +103,7 @@ <meta.section type="apiInfo"/>
</appInfo>
<documentation>
- [Enter API information here.]
+ Value of the attribute <b>class</b> must be a fully qualified name of a Java class that implements the interface <b>org.eclipse.ui.console.IConsoleFactory</b>.
</documentation>
</annotation>
@@ -102,7 +112,7 @@ <meta.section type="implementation"/>
</appInfo>
<documentation>
- [Enter information about supplied implementation of this extension point.]
+ None.
</documentation>
</annotation>
@@ -111,7 +121,11 @@ <meta.section type="copyright"/>
</appInfo>
<documentation>
-
+ Copyright (c) 2004 IBM Corporation and others.<br>
+All rights reserved. This program and the accompanying materials are made
+available under the terms of the Common Public License v1.0 which
+accompanies this distribution, and is available at
+<a href="http://www.eclipse.org/legal/cpl-v10.html">http://www.eclipse.org/legal/cpl-v10.html</a>
</documentation>
</annotation>
|