osl: clarify osl_scheduleThread() documentation

Change-Id: If9990acd06f5395c07d44fc462292ccae795abe1

1 files changed, 4 insertions, 2 deletions

diff --git a/include/osl/thread.h b/include/osl/thread.h
index 0a7951a4441d..4025f608693c 100644
--- a/include/osl/thread.h
+++ b/include/osl/thread.h
@@ -164,11 +164,13 @@ SAL_DLLPUBLIC void SAL_CALL osl_waitThread(const TimeValue* pDelay);
 */
 SAL_DLLPUBLIC void SAL_CALL osl_terminateThread(oslThread Thread);
 
-/** Offers the rest of the threads time-slice to the OS.
-    scheduleThread() should be called in the working loop
+/** Schedules in thread to wait till after time slice of specified
+    thread. scheduleThread() should be called in the working loop
     of the thread, so any other thread could also get the
     processor. Returns False if the thread should terminate, so
     the thread could free any allocated resources.
+
+    @param Thread       Handle to thread to schedule in after
 */
 SAL_DLLPUBLIC sal_Bool SAL_CALL osl_scheduleThread(oslThread Thread);