Eclipse

 
 
The Eclipse Workbench is an open source platform, designed by IBM and released to the open source community. It is an open, portable, universal tooling platform that provides frameworks, services and tools for building tools.

In essence the workbench provides the tool infrastructure. With this infrastructure in place, the tool builders are able to focus on the actual building of their tools. The workbench has been designed for maximum flexibility to support the development of tools for new technologies that may merge in the future.

Industry leaders Borland, IBM, Merchant, QNX Software Systems, Rational Software, RedHat, SuSE, TogetherSoft, and WebGain formed the initial eclipse.org board of directors and began work on the Eclipse open source project.

More information about The Eclipse Workbench can be found at:
http://www.eclipse.org

Eclipse FAQ can be found at:
http://wiki.eclipse.org/index.php/Eclipse_FAQs

The latest Eclipse version can be downloaded from: http://www.eclipse.org/downloads/

There are hundreds of plugins which you can add to Eclipse, for example plugins for testing, code management, uml, xml, etc. The Eclipse plugins can be found at: http://www.eclipseplugincentral.com/

rss feed






Generate documentation from Javadoc comments in the source code.



Information
none

Operating system used
Windows XP Home Edition Version 5.1 SP 2

Software prerequisites
Eclipse version 3.0 or higher


Procedure
  1. Start Eclipse

  2. The project(s) to generate documentation from Javadoc comments in the source code must be in your workspace.

  3. Select menu: File | Export

  4. Select Javadoc and press Next button.

    Select Javadoc

  5. Select the project(s) to generate documentation from Javadoc comments and choose "Use Standard Doclet".
    If needed change the destination where the documentation should be placed.

    Select types for Javadoc generation.

    Press Next button.



  6. Enable "Document title" and enter your title.
    Enable all "Basic Options".
    Disable all "Document these tags".

    Configure Javadoc arguments.

    Press Next button.

  7. Leave all settings unchanged and press Finish button.

    Configure Javadoc arguments 2.

  8. A warning message is shown. Press Yes.

    Update Javadoc location warning.

  9. The document generation process can be followed in the Console view.

    Javadoc generation.

  10. After the process is finished, go to the doc directory.
    In this example C:\workspace\JavaDocDemo\doc and double click index.html to display the generated documentation from Javadoc comments.

    Document title.