Jadeite Extends Java API documentation:
Jadeite stands for Java Documentation with Extra Information Tacked-on for Emphasis. It provides an interface that encourages developers to extend Javadoc documentation to help searchers find the classes and methods they want in a Java API.
Released:
2009
Creator:
Jadeite is the product of research performed at the Carnegie Mellon University as part of their Natural Programming Project
Website:
edelstein.pebbles.cs.cmu.edu/jadeite/
Requirements:
Jadeite is an online tool usable with any Javascript enabled browser.
Extending Java API Information:
Two examples of the Jadeite interface in action are for the Java API and the JavaMail API. They demonstrate the similarities between Jadeite and the normal Javadoc interface. The key difference is the ability to add "placeholders" to the API documentation.
Placeholders work on the assumption that developers often expect a class to have a certain method to perform a specific function. In reality the task they are looking to perform is handled by a completely different class. A placeholder is a dummy entry that specifies where the method they are looking for exists. By adding a placeholder, a developer can aid future searchers who might have the same expectations. Placeholders can be made for classes as well as methods.
Jadeite also expands on the information contained within an API by providing a new construction section for each class.
It contains examples for common ways to construct the class.
Like its sister tool Apatite, Jadeite uses comparative font sizes to highlight commonly used parts of the API. The larger the font, the more frequently the package, class or method is considered to be.
Jadeite stands for Java Documentation with Extra Information Tacked-on for Emphasis. It provides an interface that encourages developers to extend Javadoc documentation to help searchers find the classes and methods they want in a Java API.
Released:
2009
Creator:
Jadeite is the product of research performed at the Carnegie Mellon University as part of their Natural Programming Project
Website:
edelstein.pebbles.cs.cmu.edu/jadeite/
Requirements:
Jadeite is an online tool usable with any Javascript enabled browser.
Extending Java API Information:
Two examples of the Jadeite interface in action are for the Java API and the JavaMail API. They demonstrate the similarities between Jadeite and the normal Javadoc interface. The key difference is the ability to add "placeholders" to the API documentation.
Placeholders work on the assumption that developers often expect a class to have a certain method to perform a specific function. In reality the task they are looking to perform is handled by a completely different class. A placeholder is a dummy entry that specifies where the method they are looking for exists. By adding a placeholder, a developer can aid future searchers who might have the same expectations. Placeholders can be made for classes as well as methods.
Jadeite also expands on the information contained within an API by providing a new construction section for each class.
It contains examples for common ways to construct the class.
Like its sister tool Apatite, Jadeite uses comparative font sizes to highlight commonly used parts of the API. The larger the font, the more frequently the package, class or method is considered to be.
SHARE
