P3
Improve API documentation in the javafx.async pacakge.
Things to look for are:
A) Does each public class have a class header describing that class? This should be at least one or two paragraphs. It must include an "@profile common" or "@profile desktop" tag. Use the "@example" facility where possible to include a graphical illustration of the object.
B) Does each public and protected function and var have a javadoc header? It must include an "@profile common" or "@profile desktop" tag (inheritance of tags is not supported). It should (where appropriate) include an "@defaultvalue" tag. Note that "@treatasprivate" functions and vars need not have documentation.
The Node.fx class is the closest thing we have to a well-documented class (and Amy Fowler has volunteered to add a graphical description to Node), so you can use it as an example of the level of documentation that would be good for all of our classes to have.
C) We also need package descriptions for each package in the form of a package.html file.
Things to look for are:
A) Does each public class have a class header describing that class? This should be at least one or two paragraphs. It must include an "@profile common" or "@profile desktop" tag. Use the "@example" facility where possible to include a graphical illustration of the object.
B) Does each public and protected function and var have a javadoc header? It must include an "@profile common" or "@profile desktop" tag (inheritance of tags is not supported). It should (where appropriate) include an "@defaultvalue" tag. Note that "@treatasprivate" functions and vars need not have documentation.
The Node.fx class is the closest thing we have to a well-documented class (and Amy Fowler has volunteered to add a graphical description to Node), so you can use it as an example of the level of documentation that would be good for all of our classes to have.
C) We also need package descriptions for each package in the form of a package.html file.