Skip to main content

Notice: this Wiki will be going read only early in 2024 and edits will no longer be possible. Please see: https://gitlab.eclipse.org/eclipsefdn/helpdesk/-/wikis/Wiki-shutdown-plan for the plan.

Jump to: navigation, search

ApiTools Milestones

Revision as of 13:40, 12 November 2007 by Darin wright.ca.ibm.com (Talk | contribs) (3.4 Milestone 4 (December 14th, 2007))

3.4 Milestone 4 (December 14th, 2007)

API tooling will reside in the incubator project. The plug-ins can be exported and dropped into an Eclipse SDK. Works items marked as Priority One are must haves, while Priority Two items are nice to have that may slide to the next milestone.

Priority One

  • Finalize Javadoc tags and code comments
  • Export API components from command line and IDE
    • Support Javadoc tags at member level
    • Provide action to convert existing component.xml file into javadoc tags
  • Binary compatibility
    • Command line tool for batch compare produces XML file for binary incompatibilities
    • Preference page to define API profiles and select workspace API compatibility baseline
    • Create markers in the workspace for binary incompatibilities between workspace and baseline. Invoked as a batch action.
  • API Usage
    • Configure reference extractor to extract only specific reference kinds
    • Command line tool to create XML file for illegal extending, implementing, and instantiating
    • Preference page to select API usage baseline
    • Create markers in the workspace for illegal API use based on API usage baseline. Invoked as a batch action.

Priority Two

  • Binary compatibility
    • Provide XSLT file to create HTML report from XML output
    • Batch report and IDE markers for missing @since tags and incorrect plug-in version numbers
    • Incremental binary compatibility checking in IDE
  • API Usage
    • Provide XSLT file to create HTML report from XML output
    • Incremental API usage scans in IDE (for illegal extending, implementing, and instantiating)
  • Implementation of plug-in project API component
    • Updates API description and class files dynamically with edits in the workspace

Back to the top