Event Documentation

classic Classic list List threaded Threaded
8 messages Options
Reply | Threaded
Open this post in threaded view
|

Event Documentation

Thomas Singer
Hi all,

What do you think about a documentation what event field is filled with
what value for certain event types? I would recommend to put this kind
of documentation at the definition of the event type constant in class
SWT, e.g. for SWT.MenuDetect, SWT.Traverse.

--
Cheers,
Tom
_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
Reply | Threaded
Open this post in threaded view
|

Re: Event Documentation

Lars Vogel-2
+1 better documentation is always desired

Thomas Singer <[hidden email]> schrieb am Sa., 25. Juli 2020, 08:45:
Hi all,

What do you think about a documentation what event field is filled with
what value for certain event types? I would recommend to put this kind
of documentation at the definition of the event type constant in class
SWT, e.g. for SWT.MenuDetect, SWT.Traverse.

--
Cheers,
Tom
_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev

_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
Reply | Threaded
Open this post in threaded view
|

Re: Event Documentation

Wim Jongman-2
Thanks, Tom.

On Sat, Jul 25, 2020 at 11:33 AM Lars Vogel <[hidden email]> wrote:
+1 better documentation is always desired

Thomas Singer <[hidden email]> schrieb am Sa., 25. Juli 2020, 08:45:
Hi all,

What do you think about a documentation what event field is filled with
what value for certain event types? I would recommend to put this kind
of documentation at the definition of the event type constant in class
SWT, e.g. for SWT.MenuDetect, SWT.Traverse.

--
Cheers,
Tom
_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev

_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
Reply | Threaded
Open this post in threaded view
|

Re: Event Documentation

Laurent Caron-5
Hi Tom

+1 for me too, a good documentation is better than spending hours of step-by-step debugging (please believe my experience).

Laurent

Le dim. 26 juil. 2020 à 13:24, Wim Jongman <[hidden email]> a écrit :
Thanks, Tom.

On Sat, Jul 25, 2020 at 11:33 AM Lars Vogel <[hidden email]> wrote:
+1 better documentation is always desired

Thomas Singer <[hidden email]> schrieb am Sa., 25. Juli 2020, 08:45:
Hi all,

What do you think about a documentation what event field is filled with
what value for certain event types? I would recommend to put this kind
of documentation at the definition of the event type constant in class
SWT, e.g. for SWT.MenuDetect, SWT.Traverse.

--
Cheers,
Tom
_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev

_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
Reply | Threaded
Open this post in threaded view
|

Re: Event Documentation

Jens Lideström
In reply to this post by Lars Vogel-2
> What do you think about a documentation what event field is filled with
what value for certain event types?

That sounds like a good idea! I've noticed that it's often hard to
understand exactly what the different event types are for.

Sometimes there is detailed information in the documentation of the event
class, but sometimes not.

/Jens


On 2020-07-25 11:32, Lars Vogel wrote:

> +1 better documentation is always desired
>
> Thomas Singer <[hidden email] <mailto:[hidden email]>> schrieb am
> Sa., 25. Juli 2020, 08:45:
>
>     Hi all,
>
>     What do you think about a documentation what event field is filled with
>     what value for certain event types? I would recommend to put this kind
>     of documentation at the definition of the event type constant in class
>     SWT, e.g. for SWT.MenuDetect, SWT.Traverse.
>
>     --
>     Cheers,
>     Tom
>     _______________________________________________
>     platform-dev mailing list
>     [hidden email] <mailto:[hidden email]>
>     To unsubscribe from this list, visit
>     https://www.eclipse.org/mailman/listinfo/platform-dev
>
>
> _______________________________________________
> platform-dev mailing list
> [hidden email]
> To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
>
_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
Reply | Threaded
Open this post in threaded view
|

Re: Event Documentation

Thomas Singer
In reply to this post by Thomas Singer
I've added

https://bugs.eclipse.org/bugs/show_bug.cgi?id=565590

and will soon provide a patch. It will be far from perfect, but you can
use it as a base for further improvements.

Cheers,
Tom


On 25/07/2020 08:44, Thomas Singer wrote:
> Hi all,
>
> What do you think about a documentation what event field is filled with
> what value for certain event types? I would recommend to put this kind
> of documentation at the definition of the event type constant in class
> SWT, e.g. for SWT.MenuDetect, SWT.Traverse.
>
_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
Reply | Threaded
Open this post in threaded view
|

Re: Event Documentation

Thomas Singer
If someone likes to review the patch:

https://git.eclipse.org/r/c/platform/eclipse.platform.swt/+/166925

I'm not sure whether every detail is correct.

--
Cheers,
Tom


On 2020-07-28 07:27, Thomas Singer wrote:

> I've added
>
> https://bugs.eclipse.org/bugs/show_bug.cgi?id=565590
>
> and will soon provide a patch. It will be far from perfect, but you can
> use it as a base for further improvements.
>
> Cheers,
> Tom
>
>
> On 25/07/2020 08:44, Thomas Singer wrote:
>> Hi all,
>>
>> What do you think about a documentation what event field is filled
>> with what value for certain event types? I would recommend to put this
>> kind of documentation at the definition of the event type constant in
>> class SWT, e.g. for SWT.MenuDetect, SWT.Traverse.
>>
_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev
Reply | Threaded
Open this post in threaded view
|

Re: [EXTERNAL] Re: Event Documentation

Niraj Modi

Thanks Thomas for the patch, will review it.

Regards,
Niraj Modi
Inactive hide details for Thomas Singer ---07-08-2020 03:03:19 PM---If someone likes to review the patch: https://git.eclipse.oThomas Singer ---07-08-2020 03:03:19 PM---If someone likes to review the patch: https://git.eclipse.org/r/c/platform/eclipse.platform.swt/+/16

From: Thomas Singer <[hidden email]>
To: [hidden email]
Date: 07-08-2020 03:03 PM
Subject: [EXTERNAL] Re: [platform-dev] Event Documentation
Sent by: [hidden email]





If someone likes to review the patch:

https://git.eclipse.org/r/c/platform/eclipse.platform.swt/+/166925

I'm not sure whether every detail is correct.

--
Cheers,
Tom


On 2020-07-28 07:27, Thomas Singer wrote:

> I've added
>
>
https://bugs.eclipse.org/bugs/show_bug.cgi?id=565590
>
> and will soon provide a patch. It will be far from perfect, but you can
> use it as a base for further improvements.
>
> Cheers,
> Tom
>
>
> On 25/07/2020 08:44, Thomas Singer wrote:
>> Hi all,
>>
>> What do you think about a documentation what event field is filled
>> with what value for certain event types? I would recommend to put this
>> kind of documentation at the definition of the event type constant in
>> class SWT, e.g. for SWT.MenuDetect, SWT.Traverse.
>>
_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit
https://www.eclipse.org/mailman/listinfo/platform-dev





_______________________________________________
platform-dev mailing list
[hidden email]
To unsubscribe from this list, visit https://www.eclipse.org/mailman/listinfo/platform-dev