Question about your docs.

Solar2D General Questions/Discussion
#1

I am now going through learning about all the api’s you all have.  Starting with display.

My question concerns http://docs.coronalabs.com/api/library/display/currentStage.html

Look at the example:

local count = display.currentStage.numChildren
print( "Number of objects on the screen = " … count )

I THINK you call “numChildren” a property.  I will use that term “property” to explain my question.

No where on that document does it talk about what properties display.currentStage has.  Are there any other properties?  How can we know?  Do other display “things” have properties?  Example display.capture?  etc.  You really should list all methods for all api’s.

Because I think numChildren can be very useful.  So, just wandering how many other useful properties there might be.

At the last moment, I decided to look at the return value - it says DisplayObject.  So, I went there and I saw a bunch of methods and properties but none of them mentioned numChildren.  So, where did this property numChildren come from?  Is it unique to currentStage?  If so, are there others?

Thanks!

#2

This section

“A reference to the current stage object, which is the root group for all display objects and groups”

(and the presence of the numChildren property) leads me to believe the documentation should state GroupObject rather than DisplayObject

http://docs.coronalabs.com/api/type/GroupObject/index.html

#3

gotta follow the inheritance:  is a StageObject, which is a GroupObject, which is a DisplayObject, which is an EventListener.

in the header area, look at the Type for “properties”, look at the Return value for “methods” aka functions (display.currentStage isn’t a function, so can’t have a return value, call it a doc error)  see the header of display.getCurrentStage() for comparison

#4

This section

“A reference to the current stage object, which is the root group for all display objects and groups”

(and the presence of the numChildren property) leads me to believe the documentation should state GroupObject rather than DisplayObject

http://docs.coronalabs.com/api/type/GroupObject/index.html

#5

gotta follow the inheritance:  is a StageObject, which is a GroupObject, which is a DisplayObject, which is an EventListener.

in the header area, look at the Type for “properties”, look at the Return value for “methods” aka functions (display.currentStage isn’t a function, so can’t have a return value, call it a doc error)  see the header of display.getCurrentStage() for comparison