Hi  experts,

As I am not familiar with the appropriate tools and the proceedings, I'd like to request a knowledgeable person to enhance the docs for some RTL functions that might get rather important to me in the future:

1) http://www.freepascal.org/docs-html/rtl/classes/checksynchronize.html

IMHO this is not a documentation at all but just a vague hit on how this function might be used.

I think a more appropriate description could be similar to

------------------------------------------------------------------------
*CheckSynchronize **checks if there are entries in the event queue, pulls them and fires events (aka callbacks) for each of them until the event queue is empty. **
**
**The Events **CheckSynchronize **pulls from the queue have been generated by **TThread.Synchronize <http://www.freepascal.org/docs-html/rtl/classes/tthread.html>**and TThread.Queue calls. **
**
**Calling **CheckSynchronize**is only allowed in the Main thread, but not ion worker threads generated by TThread siblings.*

CheckSynchronize should be called regularly by the main application thread to handle any TThread.Synchronize <http://www.freepascal.org/docs-html/rtl/classes/tthread.html>*and TThread.Queue* calls that may be waiting for execution by the main thread.
------------------------------------------------------------------------


2) http://www.freepascal.org/docs-html/rtl/classes/wakemainthread.html

------------------------------------------------------------------------
WakeMainThread is called by the TThread.synchronize <http://www.freepascal.org/docs-html/rtl/classes/tthread.html>*and the TThread.Queue* call. ,,,, (In fact I don't really understand the rest of the text, but that might be my own silliness. Of course I do know exactly what WakeMainThread is supposed to do.)
------------------------------------------------------------------------


3) http://www.freepascal.org/docs-html/rtl/classes/tthread.html

- The function Synchronize is missing even though http://www.freepascal.org/docs-html/rtl/classes/checksynchronize.html links here on that behalf - the function Queue is missing (which of course has been implemented only recently)

Thanks a lot !

-Michael




_______________________________________________
fpc-devel maillist  -  fpc-devel@lists.freepascal.org
http://lists.freepascal.org/mailman/listinfo/fpc-devel

Reply via email to