Bug 727 - Missing documentation for JogAmp module utility classes.
Summary: Missing documentation for JogAmp module utility classes.
Alias: None
Product: General
Classification: JogAmp
Component: source_code (show other bugs)
Version: unspecified
Hardware: All all
: --- enhancement
Assignee: Sven Gothel
Depends on:
Reported: 2013-05-02 12:24 CEST by Xerxes Rånby
Modified: 2013-05-03 12:49 CEST (History)
0 users

See Also:
Type: ---
SCM Refs:
Workaround: ---


Note You need to log in before you can comment on or make changes to this bug.
Description Xerxes Rånby 2013-05-02 12:24:30 CEST
Jan Ekholm ‏@jan_ekholm 44m
Sometimes JOGL code becomes a frankenmess of plain OpenGL and JOGL utility stuff. No docs really tell what the utility stuff does.
Comment 1 Sven Gothel 2013-05-02 20:38:20 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.
Comment 2 Xerxes Rånby 2013-05-03 12:49:10 CEST
The best JogAmp module utility class documentation to date is inside the JogAmp JOGL javadocs: