Getting Javadoc for EC Utilities

In the standard Eclipse Java editor you get Javadoc for standard Java classes, for example String.

These EC Utilility classes includes Javadoc:

  • BundesbankCountryCode (for financial mappings)

  • CATToolbox (for Caterpillar mappings)

  • DataTranslator (for M3 BE mappings)

  • EDIDateConverter (for M3 BE EDI mappings)

  • FormatNumber

  • IONApplicationArea (for ERP BOD mappings)

  • IONToolbox (for ERP and ION BOD mappings)

  • MECDataTranslator

  • MessageCounter

  • PersistentObject

  • SortingStructure

  • StringReplacer

When you pause on a class, method, or constant it shows a tooltip with the Javadoc. Press F2, or click on the tooltip to set focus on the Javadoc. When the Javadoc is in focus, these buttons are shown:

  • Back

  • Forward

  • @ Show in Javadoc view

  • Open Declaration (opens the source code, if available)

  • Open Attached Javadoc in a Browser

These are the ways to open the Javadoc view:

  • To open the Javadoc view:

    Click the @ button to open the Javadoc view, where Javadoc for the currently selected class, method, or constant is shown.

  • To open the Javadoc in a separate Browser view, click the Browser button.

    For example, to view Javadoc for the MECDataTranslator class, pause on a class reference (MECDataTranslator), the constructor, or a method, for example translate().

    Press F2 and then click the Browser button.

    Javadoc for the MECDataTranslator class, including its constructors and methods, is displayed in a separate browser view. Code examples for MECDataTranslator are included in the Javadoc for the class.