Til Schneider schrieb:
>> You might want to think about adding a documentation tag for the events
>> thrown by the object.
>> This has been missing from the API docs in the 0.5.x branch and is very
>> important if one wants to make full use of the fine event system!
>
> Yes, right. We already thought about this. The problem is: There is no
> real code pattern, that defines what events are fired.
>
> For a method I can look for the pattern:
> qx.Proto.methodName = function(param1, param2) { ...
>
> And the doc comment can be placed right before it:
> /** Does something really cracy. */
> qx.Proto.methodName = function(param1, param2) { ...
>
> But how should this work for events? Events are just fired. OK. I could
> scan the code for these calls, that actually fire the event. But where
> should the doc comment be placed then?
>
> Perhaps we could change qx.core.Target, so events have to be declared,
> before they can be fired. Then the doc comment could be placed before
> that declaration. But this would mean that when an event is about to be
> fired, qx.core.Target has to check whether it was declared before, which
> would cost little a run time for each firing. If this check is missing
> then it is not ensured that every event is documented.
Why not just scan for all obj.dispatchEvent and obj.createDispatchEvent
code? We could place the doc comment directly above this call.
Sebastian
>
> All the advantages of Linux Managed Hosting--Without the Cost and Risk!
> Fully trained technicians. The highest number of Red Hat certifications in
> the hosting industry. Fanatical Support. Click to learn more
> http://sel.as-us.falkag.net/sel?cmd=lnk&kid=107521&bid=248729&dat=121642
> _______________________________________________
> qooxdoo-devel mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel
All the advantages of Linux Managed Hosting--Without the Cost and Risk!
Fully trained technicians. The highest number of Red Hat certifications in
the hosting industry. Fanatical Support. Click to learn more
http://sel.as-us.falkag.net/sel?cmd=lnk&kid=107521&bid=248729&dat=121642
_______________________________________________
qooxdoo-devel mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/qooxdoo-devel
