Chapter 4. Developer Documentation

Table of Contents

At first, there's a comprehensive documentation included with the source distribution in Javadoc format. Just download the source from the jEdit CVS and create the documentation by executing the "javadoc" Ant task in the Project Viewer directory. Documentation will be created under the directory "build/docs/javadoc". Or access the bundled documentation.

The Project Viewer source also contains a second plugin that is used for debugging purposes. This plugin uses all the extension APIs provided by ProjectViewer to add extra functionality. The source for this plugin is available in the "pvdebug" directory in the source tree; you can use that source as an example of how to code your extensions.

External plugins can interact with the Project Viewer plugin in various ways:

During the next sub chapters we will describe some common task for interacting with projectviewer.



[1] For details on how to do this, check the package summary for projectviewer.Event in the javadocs.