case-study/jdt-after/schema/javadocCompletionProcessor.exsd

   1 <?xml version='1.0' encoding='UTF-8'?>
   2 <!-- Schema file written by PDE -->
   3 <schema targetNamespace="org.eclipse.jdt.ui">
   4 <annotation>
   5       <appInfo>
   6          <meta.schema plugin="org.eclipse.jdt.ui" id="javadocCompletionProcessor" name="Javadoc Completion Processor"/>
   7       </appInfo>
   8       <documentation>
   9          This extension point allows to add a Javadoc completion processor to e.g. offer new Javadoc tags.
  10 &lt;p&gt;
  11 Deprecated as of 3.2. Extenders should rather contribute to the &lt;tt&gt;org.eclipse.jdt.ui.javaCompletionProposalComputer&lt;/tt&gt; extension point, which allows to provide additional proposals not only for javadoc, but any part of a Java editor.
  12 &lt;/p&gt;
  13       </documentation>
  14    </annotation>
  15
  16    <element name="extension">
  17       <annotation>
  18          <appInfo>
  19             <meta.element deprecated="true" replacement="org.eclipse.jdt.ui.javaCompletionProposalComputer" />
  20          </appInfo>
  21       </annotation>
  22       <complexType>
  23          <sequence>
  24             <element ref="javadocCompletionProcessor" minOccurs="1" maxOccurs="unbounded"/>
  25          </sequence>
  26          <attribute name="point" type="string" use="required">
  27             <annotation>
  28                <documentation>
  29                   a fully qualified identifier of the target extension point
  30                </documentation>
  31             </annotation>
  32          </attribute>
  33          <attribute name="id" type="string">
  34             <annotation>
  35                <documentation>
  36                   an optional identifier of the extension instance
  37                </documentation>
  38             </annotation>
  39          </attribute>
  40          <attribute name="name" type="string">
  41             <annotation>
  42                <documentation>
  43                   an optional name of the extension instance
  44                </documentation>
  45                <appInfo>
  46                   <meta.attribute translatable="true"/>
  47                </appInfo>
  48             </annotation>
  49          </attribute>
  50       </complexType>
  51    </element>
  52
  53    <element name="javadocCompletionProcessor">
  54       <complexType>
  55          <attribute name="id" type="string" use="required">
  56             <annotation>
  57                <documentation>
  58                   a unique identifier for the Javadoc completion processor
  59                </documentation>
  60             </annotation>
  61          </attribute>
  62          <attribute name="name" type="string">
  63             <annotation>
  64                <documentation>
  65                   a localized name of the Javadoc completion processor
  66                </documentation>
  67                <appInfo>
  68                   <meta.attribute translatable="true"/>
  69                </appInfo>
  70             </annotation>
  71          </attribute>
  72          <attribute name="class" type="string">
  73             <annotation>
  74                <documentation>
  75                   the name of the class that implements this Javadoc completion processor. The
  76 class must be public and implement
  77 &lt;code&gt;org.eclipse.jdt.ui.text.java.IJavadocCompletionProcessor&lt;/code&gt;
  78 with a public 0-argument constructor.
  79                </documentation>
  80                <appInfo>
  81                   <meta.attribute kind="java" basedOn="org.eclipse.jdt.ui.text.java.IJavadocCompletionProcessor"/>
  82                </appInfo>
  83             </annotation>
  84          </attribute>
  85       </complexType>
  86    </element>
  87
  88    <annotation>
  89       <appInfo>
  90          <meta.section type="examples"/>
  91       </appInfo>
  92       <documentation>
  93          The following is an example of a Javadoc completion processor contribution:
  94
  95 &lt;p&gt;
  96 &lt;pre&gt;
  97  &lt;extension point=&quot;org.eclipse.jdt.ui.javadocCompletionProcessor&quot;&gt;
  98   &lt;javadocCompletionProcessor
  99    id=&quot;XDocletJavadocProcessor&quot;
 100    name=&quot;XDoclet Javadoc Processor&quot;
 101    class=&quot;com.example.XDocletJavadocProcessor&quot;&gt;
 102   &lt;/javadocCompletionProcessor&gt;
 103  &lt;/extension&gt;
 104 &lt;/pre&gt;
 105 &lt;/p&gt;
 106       </documentation>
 107    </annotation>
 108
 109    <annotation>
 110       <appInfo>
 111          <meta.section type="apiInfo"/>
 112       </appInfo>
 113       <documentation>
 114
 115       </documentation>
 116    </annotation>
 117
 118    <annotation>
 119       <appInfo>
 120          <meta.section type="implementation"/>
 121       </appInfo>
 122       <documentation>
 123
 124       </documentation>
 125    </annotation>
 126
 127    <annotation>
 128       <appInfo>
 129          <meta.section type="copyright"/>
 130       </appInfo>
 131       <documentation>
 132          Copyright (c) 2001, 2006 IBM Corporation and others.&lt;br&gt;
 133 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 &lt;a href=&quot;http://www.eclipse.org/legal/epl-v10.html&quot;&gt;http://www.eclipse.org/legal/epl-v10.html&lt;/a&gt;
 134       </documentation>
 135    </annotation>
 136
 137 </schema>