Follow Techotopia on Twitter

On-line Guides
All Guides
eBook Store
iOS / Android
Linux for Beginners
Office Productivity
Linux Installation
Linux Security
Linux Utilities
Linux Virtualization
Linux Kernel
System/Network Admin
Programming
Scripting Languages
Development Tools
Web Development
GUI Toolkits/Desktop
Databases
Mail Systems
openSolaris
Eclipse Documentation
Techotopia.com
Virtuatopia.com

How To Guides
Virtualization
General System Admin
Linux Security
Linux Filesystems
Web Servers
Graphics & Desktop
PC Hardware
Windows
Problem Solutions
Privacy Policy

  




 

 

Eclipse Platform Plug-in Development Environment Guide
Previous Page Home Next Page

Javadoc Attachments

Identifier:
org.eclipse.pde.core.javadoc

Since:
3.2

Description:
This extension point associates plug-ins with the javadoc location of the code they contain. PDE uses these mappings to automatically attach javadoc to plug-in libraries when it computes a plug-in's classpath.

Configuration Markup:

<!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"

>

  • path - The path is a URL or a path that is relative to the plug-in declaring the extension.
  • archive - an optional attribute indicating if the javadoc is located inside an archive. If not specified, the default is false. This attribute should be used only if the path attribute specifies a relative path. This attribute has no effect if the path attribute specifies a URL.

<!ELEMENT plugin EMPTY>

<!ATTLIST plugin

id CDATA #REQUIRED

>

  • id - the id of the plug-in whose javadoc location is specified by the path attribute

Examples:
The following is an example of the javadoc extension:

 <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=
"https://www.sample-url.org/doc/"
>
        <plugin id=
"com.example.ghi"
/>
     </javadoc>
     
     <javadoc path=
"doc/"
>
        <plugin id=
"com.example.jkl"
/>
     </javadoc>     
  </extension>

In this example, the javadoc for two plug-ins: com.example.abc and com.example.def have their javadoc located in a references/api/ directory inside a doc.zip ZIP file in the plug-in declaring this extension. The javadoc for plug-in com.example.ghi is located at https://www.sample-url.org/doc/. The javadoc for plug-in com.example.jkl is located in directory doc relative to the location of the plug-in declaring this extension.

Supplied Implementation:
Eclipse SDK comes with ISV documentation plug-ins that use this extension point.


Copyright (c) 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 https://www.eclipse.org/legal/epl-v10.html.


 
 
  Published under the terms of the Eclipse Public License Version 1.0 ("EPL") Design by Interspire