Javadoc 连接

标识:
org.eclipse.pde.core.javadoc

起始版本:
3.2

描述:
此扩展点使插件与它们所包含的代码的 Javadoc 位置相关联。当 PDE 计算插件的类路径时,它将使用这些映射来自动地将 Javadoc 连接到插件库。

配置标记:

<!ELEMENT extension (javadoc+)>

<!ATTLIST extension

point CDATA #REQUIRED

id    CDATA #IMPLIED

name  CDATA #IMPLIED

>


<!ELEMENT javadoc (plugin+)>

<!ATTLIST javadoc

path    CDATA #REQUIRED

archive (true | false) "false"

>


<!ELEMENT plugin EMPTY>

<!ATTLIST plugin

id CDATA #REQUIRED

>


示例:
以下是 javadoc 扩展的一个示例:

 <extension point="org.eclipse.pde.core.javadoc">
     <javadoc path="doc.zip!/references/api/" archive="true">
        <plugin id="com.example.abc"/>
        <plugin id="com.example.def"/>
     </javadoc>     
     
     <javadoc path="http://www.sample-url.org/doc/">
        <plugin id="com.example.ghi"/>
     </javadoc>
     
     <javadoc path="doc/">
        <plugin id="com.example.jkl"/>
     </javadoc>     
</extension>
在此示例中,两个插件 com.example.abc 和 com.example.def 的 Javadoc 在声明了此扩展的插件中 doc.zip ZIP 文件中的 references/api/ 目录中。 插件 com.example.ghi 的 Javadoc 在 http://www.sample-url.org/doc/ 中。插件 com.example.jkl 的 Javadoc 在相对于声明了此扩展的插件所在位置的 doc 目录中。

API 信息:
此扩展点不需要任何 Java 代码。

提供的实现:
Eclipse SDK 附带提供了使用此扩展点的 ISV 文档插件。


Copyright © 2005 IBM Corporation 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 http://www.eclipse.org/legal/epl-v10.html.