Hey,
about those topic, having stuff in the statics section, was a long discussion
in a bug report:
http://bugzilla.qooxdoo.org/show_bug.cgi?id=3194
Just take a look at the comments to get an impression.
If we could enhance that functionality so that the API
generator introspected on these members and displayed the comments as
a sub-tree of the static constant that would get me quite a ways
there.
I don't think that this is going to happen because it's just too much work for
a coding style we do not recommend.
Regards,
Martin
Am 21.02.2011 um 11:32 schrieb thron7:
Put this in a bug.
T.
On 02/18/2011 09:18 PM, aditya siram wrote:
It's desirable only because I want other developers (not just users)
to be able to read all my comments directly from the API viewer
without having to read the source. I use these maps when I want some
package up some functions without having to instantiate a new Qooxdoo
class in a new file. I use statics all the time to create smaller
objects eg.
statics : {
obj1 : {
func1 : function () {}
prop1 : SOME_CONSTANT
},
obj2 : {
func2 : function () {}
prop2 : SOME_OTHER_CONSTANT
},
}
members : {
...
}
obj1.func1, and obj2.func2 however, don't pick comments. In the case
of statics only capitalized members are picked up by the API
generator. If we could enhance that functionality so that the API
generator introspected on these members and displayed the comments as
a sub-tree of the static constant that would get me quite a ways
there.
-deech
On Fri, Feb 18, 2011 at 4:47 AM, Martin Wittemann
<[email protected]<mailto:[email protected]>> wrote:
Hey,
I have a number of members in my qooxdoo classes that are traditional
Javascript objects in my code like:
something : {
...
}
however any documentation I write for these does not show up in the
API viewer. Is there someway to get it show up?
Thats not really the common use for a qooxdoo class to have maps or any other
data types stored public in a class definition. So currently, there is no way
to add those stuff to the APi viewer. We are also sure that we don't want to
force the developers to document all internal members they use. But maybe its a
good idea to open up an enhancement report in out bugzilla which describes what
it could be good for to show those documentations available.
Best,
Martin
------------------------------------------------------------------------------
The ultimate all-in-one performance toolkit: Intel(R) Parallel Studio XE:
Pinpoint memory and threading errors before they happen.
Find and fix more than 250 security defects in the development cycle.
Locate bottlenecks in serial and parallel code that limit performance.
http://p.sf.net/sfu/intel-dev2devfeb
_______________________________________________
qooxdoo-devel mailing list
[email protected]<mailto:[email protected]>
https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel
------------------------------------------------------------------------------
The ultimate all-in-one performance toolkit: Intel(R) Parallel Studio XE:
Pinpoint memory and threading errors before they happen.
Find and fix more than 250 security defects in the development cycle.
Locate bottlenecks in serial and parallel code that limit performance.
http://p.sf.net/sfu/intel-dev2devfeb
_______________________________________________
qooxdoo-devel mailing list
[email protected]<mailto:[email protected]>
https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel
------------------------------------------------------------------------------
The ultimate all-in-one performance toolkit: Intel(R) Parallel Studio XE:
Pinpoint memory and threading errors before they happen.
Find and fix more than 250 security defects in the development cycle.
Locate bottlenecks in serial and parallel code that limit performance.
http://p.sf.net/sfu/intel-dev2devfeb
_______________________________________________
qooxdoo-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel
------------------------------------------------------------------------------
The ultimate all-in-one performance toolkit: Intel(R) Parallel Studio XE:
Pinpoint memory and threading errors before they happen.
Find and fix more than 250 security defects in the development cycle.
Locate bottlenecks in serial and parallel code that limit performance.
http://p.sf.net/sfu/intel-dev2devfeb
_______________________________________________
qooxdoo-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel
