Skip to content

Commit

Permalink
everything is important
Browse files Browse the repository at this point in the history
  • Loading branch information
ivanseidel committed May 14, 2013
1 parent c1ea3df commit 8916b74
Showing 1 changed file with 5 additions and 4 deletions.
9 changes: 5 additions & 4 deletions README.textile
Original file line number Diff line number Diff line change
Expand Up @@ -105,6 +105,10 @@ h3. You should know:
- @bool Thread::shouldRun()@ := Returns true, if the Thread should be runned. (Basicaly, the logic is: (reached time AND is enabled?).
- @void Thread::onRun(void (*callback)(void))@ := The target callback function to be called.
- @void Thread::run()@ := This will run the Thread (call the callback function).
- @int Thread::ThreadID@ := Theoretically, it's the address of memory. It's unique, and can be used to compare if two threads are identical.
- @int Thread::ThreadName@ := A human-redable thread name. Default is "Thread ThreadID" eg.: "Thread 141515";
- protected: @void Thread::runned()@ := Used to reset internal timer of the Thread. This is automaticaly called AFTER a call to @run()@.


- @void ThreadController::run()@ := This will run the all @Threads@ within the @ThreadController@, only if needed (if shouldRun returns true);
- @bool ThreadController::add(Thread* _thread)@ := This will add a the thread to the ThreadController, and return @true@ if suceeded (it the array is full, returns false).
Expand All @@ -115,10 +119,7 @@ h3. You should know:
- @Thread* ThreadController::get(int index)@ := Returns the Thread on the position @index@.

h3. You don't need to know:

- @int Thread::ThreadID@ := Theoretically, it's the address of memory. It's unique, and can be used to compare if two threads are identical.
- @int Thread::ThreadName@ := A human-redable thread name. Default is "Thread ThreadID" eg.: "Thread 141515";
- protected: @void Thread::runned()@ := Used to reset internal timer of the Thread. This is automaticaly called AFTER a call to @run()@.
- Nothing, yet ;)

h2. Version History

Expand Down

0 comments on commit 8916b74

Please sign in to comment.