doc provider example
diff --git a/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/.classpath b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/.classpath
new file mode 100644
index 0000000..ad32c83
--- /dev/null
+++ b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/.classpath
@@ -0,0 +1,7 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<classpath>
+ <classpathentry kind="con" path="org.eclipse.jdt.launching.JRE_CONTAINER/org.eclipse.jdt.internal.debug.ui.launcher.StandardVMType/JavaSE-1.6"/>
+ <classpathentry kind="con" path="org.eclipse.pde.core.requiredPlugins"/>
+ <classpathentry kind="src" path="src"/>
+ <classpathentry kind="output" path="bin"/>
+</classpath>
diff --git a/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/.project b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/.project
new file mode 100644
index 0000000..8397a7d
--- /dev/null
+++ b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/.project
@@ -0,0 +1,28 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<projectDescription>
+ <name>org.eclipse.dltk.javascript.example.docprovider</name>
+ <comment></comment>
+ <projects>
+ </projects>
+ <buildSpec>
+ <buildCommand>
+ <name>org.eclipse.jdt.core.javabuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.pde.ManifestBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ <buildCommand>
+ <name>org.eclipse.pde.SchemaBuilder</name>
+ <arguments>
+ </arguments>
+ </buildCommand>
+ </buildSpec>
+ <natures>
+ <nature>org.eclipse.pde.PluginNature</nature>
+ <nature>org.eclipse.jdt.core.javanature</nature>
+ </natures>
+</projectDescription>
diff --git a/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/.settings/org.eclipse.jdt.core.prefs b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/.settings/org.eclipse.jdt.core.prefs
new file mode 100644
index 0000000..ae03cda
--- /dev/null
+++ b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/.settings/org.eclipse.jdt.core.prefs
@@ -0,0 +1,8 @@
+#Tue Jul 27 21:40:04 NOVST 2010
+eclipse.preferences.version=1
+org.eclipse.jdt.core.compiler.codegen.inlineJsrBytecode=enabled
+org.eclipse.jdt.core.compiler.codegen.targetPlatform=1.6
+org.eclipse.jdt.core.compiler.compliance=1.6
+org.eclipse.jdt.core.compiler.problem.assertIdentifier=error
+org.eclipse.jdt.core.compiler.problem.enumIdentifier=error
+org.eclipse.jdt.core.compiler.source=1.6
diff --git a/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/META-INF/MANIFEST.MF b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/META-INF/MANIFEST.MF
new file mode 100644
index 0000000..f5ded63
--- /dev/null
+++ b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/META-INF/MANIFEST.MF
@@ -0,0 +1,12 @@
+Manifest-Version: 1.0
+Bundle-ManifestVersion: 2
+Bundle-Name: Docprovider
+Bundle-SymbolicName: org.eclipse.dltk.javascript.example.docprovider;singleton:=true
+Bundle-Version: 1.0.0.qualifier
+Bundle-RequiredExecutionEnvironment: JavaSE-1.6
+Require-Bundle: org.eclipse.core.runtime;bundle-version="3.5.0",
+ org.eclipse.dltk.core;bundle-version="3.0.0",
+ org.eclipse.dltk.ui;bundle-version="3.0.0",
+ org.eclipse.dltk.javascript.core;bundle-version="3.0.0",
+ org.eclipse.core.resources;bundle-version="3.5.0",
+ org.eclipse.emf.ecore;bundle-version="2.5.0"
diff --git a/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/build.properties b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/build.properties
new file mode 100644
index 0000000..e9863e2
--- /dev/null
+++ b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/build.properties
@@ -0,0 +1,5 @@
+source.. = src/
+output.. = bin/
+bin.includes = META-INF/,\
+ .,\
+ plugin.xml
diff --git a/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/plugin.xml b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/plugin.xml
new file mode 100644
index 0000000..bb463c6
--- /dev/null
+++ b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/plugin.xml
@@ -0,0 +1,16 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<?eclipse version="3.4"?>
+<plugin>
+ <extension
+ point="org.eclipse.dltk.ui.scriptDocumentationProviders">
+ <provider
+ id="org.eclipse.dltk.javascript.example.docprovider1"
+ class="org.eclipse.dltk.javascript.example.docprovider.ExampleElementDocumentationProvider"
+ nature="org.eclipse.dltk.javascript.core.nature">
+ </provider>
+ </extension>
+ <extension point="org.eclipse.dltk.javascript.core.typeinfo">
+ <converter class="org.eclipse.dltk.javascript.example.docprovider.ExampleElementConverter"/>
+ </extension>
+
+</plugin>
diff --git a/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/src/org/eclipse/dltk/javascript/example/docprovider/ElementWrapper.java b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/src/org/eclipse/dltk/javascript/example/docprovider/ElementWrapper.java
new file mode 100644
index 0000000..d266696
--- /dev/null
+++ b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/src/org/eclipse/dltk/javascript/example/docprovider/ElementWrapper.java
@@ -0,0 +1,32 @@
+/*******************************************************************************
+ * Copyright (c) 2010 xored software, Inc.
+ *
+ * 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
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * xored software, Inc. - initial API and Implementation (Alex Panchenko)
+ *******************************************************************************/
+package org.eclipse.dltk.javascript.example.docprovider;
+
+import org.eclipse.dltk.core.IModelElement;
+import org.eclipse.dltk.core.model.ForeignElement;
+import org.eclipse.dltk.javascript.typeinfo.model.Element;
+
+public class ElementWrapper extends ForeignElement {
+
+ final Element element;
+
+ public ElementWrapper(IModelElement parent, Element element)
+ throws IllegalArgumentException {
+ super(parent);
+ this.element = element;
+ }
+
+ @Override
+ public void codeSelect() {
+ // TODO Auto-generated method stub
+ }
+}
diff --git a/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/src/org/eclipse/dltk/javascript/example/docprovider/ExampleElementConverter.java b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/src/org/eclipse/dltk/javascript/example/docprovider/ExampleElementConverter.java
new file mode 100644
index 0000000..4a8e312
--- /dev/null
+++ b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/src/org/eclipse/dltk/javascript/example/docprovider/ExampleElementConverter.java
@@ -0,0 +1,30 @@
+/*******************************************************************************
+ * Copyright (c) 2010 xored software, Inc.
+ *
+ * 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
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * xored software, Inc. - initial API and Implementation (Alex Panchenko)
+ *******************************************************************************/
+package org.eclipse.dltk.javascript.example.docprovider;
+
+import org.eclipse.dltk.core.IModelElement;
+import org.eclipse.dltk.core.ISourceModule;
+import org.eclipse.dltk.javascript.typeinfo.IElementConverter;
+import org.eclipse.dltk.javascript.typeinfo.model.Element;
+import org.eclipse.dltk.javascript.typeinfo.model.Property;
+
+public class ExampleElementConverter implements IElementConverter {
+
+ public IModelElement convert(ISourceModule module, Element element) {
+ if (element instanceof Property
+ && "exampleForms".equals(element.getName())) { //$NON-NLS-1$
+ return new ElementWrapper(module, element);
+ }
+ return null;
+ }
+
+}
diff --git a/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/src/org/eclipse/dltk/javascript/example/docprovider/ExampleElementDocumentationProvider.java b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/src/org/eclipse/dltk/javascript/example/docprovider/ExampleElementDocumentationProvider.java
new file mode 100644
index 0000000..ef0b84d
--- /dev/null
+++ b/javascript/examples/org.eclipse.dltk.javascript.example.docprovider/src/org/eclipse/dltk/javascript/example/docprovider/ExampleElementDocumentationProvider.java
@@ -0,0 +1,51 @@
+/*******************************************************************************
+ * Copyright (c) 2010 xored software, Inc.
+ *
+ * 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
+ * http://www.eclipse.org/legal/epl-v10.html
+ *
+ * Contributors:
+ * xored software, Inc. - initial API and Implementation (Alex Panchenko)
+ *******************************************************************************/
+package org.eclipse.dltk.javascript.example.docprovider;
+
+import java.io.Reader;
+
+import org.eclipse.dltk.core.IDocumentableElement;
+import org.eclipse.dltk.core.IMember;
+import org.eclipse.dltk.javascript.typeinfo.model.Element;
+import org.eclipse.dltk.ui.documentation.IDocumentationResponse;
+import org.eclipse.dltk.ui.documentation.IScriptDocumentationProvider;
+import org.eclipse.dltk.ui.documentation.IScriptDocumentationProviderExtension2;
+import org.eclipse.dltk.ui.documentation.TextDocumentationResponse;
+
+public class ExampleElementDocumentationProvider implements
+ IScriptDocumentationProvider, IScriptDocumentationProviderExtension2 {
+
+ @Override
+ public Reader getInfo(IMember element, boolean lookIntoParents,
+ boolean lookIntoExternal) {
+ return null;
+ }
+
+ @Override
+ public Reader getInfo(String content) {
+ return null;
+ }
+
+ @Override
+ public IDocumentationResponse describeElement(IDocumentableElement element) {
+ if (element instanceof ElementWrapper) {
+ final Element jsElement = ((ElementWrapper) element).element;
+ if (jsElement.getDescription() != null
+ && jsElement.getDescription().length() != 0) {
+ return new TextDocumentationResponse(element, jsElement
+ .getDescription());
+ }
+ }
+ return null;
+ }
+
+}
