ShowBase documentation lacks proper return types and other details
Bug #1424248 reported by
ellie
This bug affects 1 person
Affects | Status | Importance | Assigned to | Milestone | |
---|---|---|---|---|---|
Panda3D |
Fix Released
|
Undecided
|
Unassigned |
Bug Description
The ShowBase class is very central for people not using the DirectStart hack. Sadly, the documentation appears to be rather abysmal:
None of the return types are properly specified, and there's almost no descriptive text either. At least the return types should be consistently specified.
Example:
E.g. what are win and winList? A reference to the main window and list of windows? But what do I get back, an id, a class instance (what class?), a list, an iterator, a HWND, ..? It's pretty much useless without any return type details and at least a short sentence on what it does.
Also, central things like "render2d" should definitely have a working link to the page on the documentation describing that component in more detail.