Bug 660 : Verify public access level for members of PApplet (fe firstMouse)
Last modified: 2008-08-16 15:23




Status:
ASSIGNED
Resolution:
-
Priority:
P2
Severity:
normal

 

Reporter:
davbol
Assigned To:
fry

Attachment Type Created Size Actions

Description:   Opened: 2007-10-24 11:45
As of 0132 beta. Not quite sure how to report this, as not sure which are
really "bugs", please forgive if longwinded, also see:
http://processing.org/discourse/yabb_beta/YaBB.cgi?
board=Suggestions;action=display;num=1193245991

There are publics in PApplet where it's not clear whether they are intentionally public
and intended for end-user access, or whether they're should instead have more
restricted access. (anything left public should be considered "fair game" for end-
users to muck with)

So I guess the "bug" is two-sided: some things in PApplet have public access that
perhaps should not, while some that are legitimately public are not documented in
the reference (and possibly don't syntax highlight also) and should somehow
distinguish themselves from the "accidental publics".

Some appear to be API members, such as "firstMouse", but are not documented in
the reference or syntax higlighted in the editor.

Others, such as keyEvent/mouseEvent do seem to be intentionally public, but it isn't
clear if these are "official" parts of the API, or fall under some other classification
where end-user access is expected but API-level documentation/highlighting is less
appropriate.

A good one is "platformName", which has a comment that it is only used internally,
yet is declared public -- so it is unclear whether end-users can/should rely on this
value being maintained/available in future releases. If not, reduce access; if yes,
identify/document it in some way as being "intentionally public and supported".
This bug is now being tracked here.