Skip to main content

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index] [List Home]
[cosmos-dev] Provisional API comments


Happy Monday team,

As we are winding down in the exercise of adjusting our package naming to indicate provisional APIs, please also make sure that provisional APIs are adequately commented.  There should be a class comment for each class in a provisional package, and also method comments for all non-private methods.  This will help enable generation of Javadoc, and successful adoption by our consumers.

Thanks,
David
---
David Whiteman | Tivoli Autonomic Computing
Eclipse COSMOS project committer |
http://www.eclipse.org/cosmos/
david_whiteman@xxxxxxxxxx | 919-254-8224 | T/L 444-8224

Back to the top