| Summary: | Missing documentation for JogAmp module utility classes. | ||
|---|---|---|---|
| Product: | [JogAmp] General | Reporter: | Xerxes Rånby <xerxes> |
| Component: | source_code | Assignee: | Sven Gothel <sgothel> |
| Status: | RESOLVED INVALID | ||
| Severity: | enhancement | ||
| Priority: | --- | ||
| Version: | unspecified | ||
| Hardware: | All | ||
| OS: | all | ||
| Type: | --- | SCM Refs: | |
| Workaround: | --- | ||
|
Description
Xerxes Rånby
2013-05-02 12:24:30 CEST
I am sorry (not really, but just being polite here), but such a critique is itself a 'frankenmess' since it doesn't specify which modules lack documentation. Asking for a better documentation while being broad and unspecific is not constructive and itself lacks documentation. Many utility classes do have proper API documentation as well as covering unit test. The latter also demonstrate their usage. I have to admit, nothing is 100% perfect, but we need to ask for detailed question so we are able to better the product. Iff serious, and this would imply cooperation and commitment, I recommend to reopen this bug as a root bug entry and add subsequent child bugs blocking this one asking for missing documentation or clarification of specific modules. Sorry if this sounds harsh .. but we need to have a doable process w/ community as well. The best JogAmp module utility class documentation to date is inside the JogAmp JOGL javadocs: http://jogamp.org/deployment/jogamp-next/javadoc/jogl/javadoc/com/jogamp/opengl/util/package-summary.html and http://jogamp.org/deployment/jogamp-next/javadoc/jogl/javadoc/overview-summary.html |