search

prisonerjohn / processing-web

0 stars 0 forks source link

[CLOSED] Documentation is vague about expected data type for constructor arguments #81

Open prisonerjohn opened 10 years ago

prisonerjohn commented 10 years ago

Issue by teo1978 Tuesday Mar 19, 2013 at 15:57 GMT Originally opened as https://github.com/processing/processing-web/issues/81

For example: http://processing.org/reference/XML.html

Constructor XML(file) XML(file, options) XML(input) XML(input, options) XML(name)

What type is input? is it a string? What type is file? Is it a File or a String (filename)? And what is options at all?

Argument types must always be specified, especially in cases like this when they are not obvious at all and when they are being changed at every .0bN version.

prisonerjohn commented 10 years ago

Comment by REAS Tuesday Mar 19, 2013 at 18:23 GMT

We'll clarify this. Please check the Javadoc until we clarify: http://processing.org/reference/javadoc/core/

prisonerjohn commented 10 years ago

Comment by alignedleft Wednesday Apr 03, 2013 at 16:51 GMT

@benfry Can you confirm that options is unsupported right now? (It is in the source, but is ignored.)

Also, what is name in this context?

prisonerjohn commented 10 years ago

Comment by benfry Sunday Jun 02, 2013 at 18:02 GMT

The constructors are (at the moment) for internal use only. The loadXML(...) method from within PApplet is the only way to go. I'll fill out the JavaDoc in the source as things settle down with the various data classes.

prisonerjohn commented 10 years ago

Comment by REAS Sunday Jun 02, 2013 at 19:00 GMT

So, @alignedleft that means we should remove all of the constructors from the reference. People will need to go to the JavaDoc to see the constructors. You can see the JSONObject source for an example.

prisonerjohn commented 10 years ago

Comment by alignedleft Sunday Jun 02, 2013 at 21:05 GMT

Constructors are no longer appearing, so this is all set, thanks.