Improved documentation of more classes in the system module
git-svn-id: https://sfml.svn.sourceforge.net/svnroot/sfml/branches/sfml2@1204 4e206d99-4929-0410-ac5d-dfc041789085
This commit is contained in:
parent
351a43f696
commit
fcdc5cdf82
11 changed files with 187 additions and 120 deletions
|
@ -32,8 +32,6 @@
|
|||
namespace sf
|
||||
{
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Make the current thread sleep for a given time
|
||||
////////////////////////////////////////////////////////////
|
||||
void Sleep(float duration)
|
||||
{
|
||||
if (duration >= 0)
|
||||
|
|
|
@ -42,8 +42,6 @@
|
|||
namespace sf
|
||||
{
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Default constructor
|
||||
////////////////////////////////////////////////////////////
|
||||
Thread::Thread() :
|
||||
myThreadImpl(NULL),
|
||||
myFunction (NULL),
|
||||
|
@ -53,8 +51,6 @@ myUserData (NULL)
|
|||
}
|
||||
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Construct the thread from a function pointer
|
||||
////////////////////////////////////////////////////////////
|
||||
Thread::Thread(Thread::FuncType function, void* userData) :
|
||||
myThreadImpl(NULL),
|
||||
|
@ -65,8 +61,6 @@ myUserData (userData)
|
|||
}
|
||||
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Virtual destructor
|
||||
////////////////////////////////////////////////////////////
|
||||
Thread::~Thread()
|
||||
{
|
||||
|
@ -74,8 +68,6 @@ Thread::~Thread()
|
|||
}
|
||||
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Create and run the thread
|
||||
////////////////////////////////////////////////////////////
|
||||
void Thread::Launch()
|
||||
{
|
||||
|
@ -84,8 +76,6 @@ void Thread::Launch()
|
|||
}
|
||||
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Wait until the thread finishes
|
||||
////////////////////////////////////////////////////////////
|
||||
void Thread::Wait()
|
||||
{
|
||||
|
@ -98,11 +88,6 @@ void Thread::Wait()
|
|||
}
|
||||
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Terminate the thread
|
||||
/// Terminating a thread with this function is not safe,
|
||||
/// you should rather try to make the thread function
|
||||
/// terminate by itself
|
||||
////////////////////////////////////////////////////////////
|
||||
void Thread::Terminate()
|
||||
{
|
||||
|
@ -115,8 +100,6 @@ void Thread::Terminate()
|
|||
}
|
||||
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Function called as the thread entry point
|
||||
////////////////////////////////////////////////////////////
|
||||
void Thread::Run()
|
||||
{
|
||||
|
|
|
@ -42,8 +42,6 @@
|
|||
namespace sf
|
||||
{
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Default constructor
|
||||
////////////////////////////////////////////////////////////
|
||||
ThreadLocal::ThreadLocal(void* value)
|
||||
{
|
||||
myImpl = new priv::ThreadLocalImpl;
|
||||
|
@ -51,8 +49,6 @@ ThreadLocal::ThreadLocal(void* value)
|
|||
}
|
||||
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Destructor
|
||||
////////////////////////////////////////////////////////////
|
||||
ThreadLocal::~ThreadLocal()
|
||||
{
|
||||
|
@ -60,8 +56,6 @@ ThreadLocal::~ThreadLocal()
|
|||
}
|
||||
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Set the thread-specific value of the variable
|
||||
////////////////////////////////////////////////////////////
|
||||
void ThreadLocal::SetValue(void* value)
|
||||
{
|
||||
|
@ -69,8 +63,6 @@ void ThreadLocal::SetValue(void* value)
|
|||
}
|
||||
|
||||
|
||||
////////////////////////////////////////////////////////////
|
||||
/// Retrieve the thread-specific value of the variable
|
||||
////////////////////////////////////////////////////////////
|
||||
void* ThreadLocal::GetValue() const
|
||||
{
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue