Source Locations

Identifier:

org.eclipse.pde.core.source

Since:

2.0

Description:

This extension point allows PDE to find source archives for libraries in Eclipse plug-ins found in an Eclipse-based product. It is used to contribute locations that contain source archives. These locations are expected to contain the same layout as the 'plugins' directory.

For each plug-in or fragment, a directory in the form {id}_{version} should exist. The content of the directory corresponds to the plug-in/fragment location. It should contain source code zip file in the form {library name}src.zip where library name is the name of the Java library that matches the source code. For JAR'd plug-ins and libraries named '.', the source zip file must be named simply src.zip.

In addition, it should contain any file or directory specified in the build.properties using src.includes variable.

Configuration Markup:

<!ELEMENT extension (location+)>

<!ATTLIST extension

point CDATA #REQUIRED

id CDATA #IMPLIED

name CDATA #IMPLIED>

<!ELEMENT location EMPTY>

<!ATTLIST location

path CDATA #REQUIRED>

path - the relative path of the directory in the contributing plug-in where source content is stored. The folder must contain one or more directories in the form {id}_{version} where id is a matching plug-in or fragment identifier and version is the matching plugin/fragment version. These directories in turn should contain source archives and any other file or folder specified using src.includes variable in build.properties file of the corresponding plug-in/fragment.

Examples:

The following is an example of the source extension:


 <extension point = "org.eclipse.pde.core.source">
     <location path="src"/>
  </extension>

In the example above, the source location src in the contributing plug-in has been registered.

API Information:

No Java code is required for this extension point.

Supplied Implementation:

Eclipse SDK comes with source plug-ins that contain source information for all the plug-ins and fragments in Eclipse SDK.

Copyright (c) 2004 IBM Corporation and others.
This program and the accompanying materials are made available under the terms of the Eclipse Public License 2.0 which accompanies this distribution, and is available at https://www.eclipse.org/legal/epl-v20.html/ SPDX-License-Identifier: EPL-2.0.