diff --git a/reference/pht/atomicinteger/construct.xml b/reference/pht/atomicinteger/construct.xml index ac680c96a6..d53d779927 100644 --- a/reference/pht/atomicinteger/construct.xml +++ b/reference/pht/atomicinteger/construct.xml @@ -3,14 +3,14 @@ - AtomicInteger::__construct + pht\AtomicInteger::__construct AtomicInteger creation &reftitle.description; - public AtomicIntegerAtomicInteger::__construct + public AtomicIntegerpht\AtomicInteger::__construct intvalue0 diff --git a/reference/pht/atomicinteger/dec.xml b/reference/pht/atomicinteger/dec.xml index 011841c003..c6326e2546 100644 --- a/reference/pht/atomicinteger/dec.xml +++ b/reference/pht/atomicinteger/dec.xml @@ -3,14 +3,14 @@ - AtomicInteger::dec + pht\AtomicInteger::dec Decrements the atomic integer's value by one &reftitle.description; - public voidAtomicInteger::dec + public voidpht\AtomicInteger::dec @@ -18,7 +18,7 @@ the mutex lock of the atomic integer will be acquired, and so there is no need to manually acquire it (unless this operation needs to be grouped with other operations on the same atomic integer - see the example in - AtomicInteger::lock for a demonstration of this). + pht\AtomicInteger::lock for a demonstration of this). diff --git a/reference/pht/atomicinteger/get.xml b/reference/pht/atomicinteger/get.xml index 56fb098ad1..ef9780212a 100644 --- a/reference/pht/atomicinteger/get.xml +++ b/reference/pht/atomicinteger/get.xml @@ -3,14 +3,14 @@ - AtomicInteger::get + pht\AtomicInteger::get Gets the atomic integer's value &reftitle.description; - public intAtomicInteger::get + public intpht\AtomicInteger::get @@ -18,7 +18,7 @@ the mutex lock of the atomic integer will be acquired, and so there is no need to manually acquire it (unless this operation needs to be grouped with other operations on the same atomic integer - see the example in - AtomicInteger::lock for a demonstration of this). + pht\AtomicInteger::lock for a demonstration of this). diff --git a/reference/pht/atomicinteger/inc.xml b/reference/pht/atomicinteger/inc.xml index b11c61911b..9052f89ed5 100644 --- a/reference/pht/atomicinteger/inc.xml +++ b/reference/pht/atomicinteger/inc.xml @@ -3,14 +3,14 @@ - AtomicInteger::inc + pht\AtomicInteger::inc Increments the atomic integer's value by one &reftitle.description; - public voidAtomicInteger::inc + public voidpht\AtomicInteger::inc @@ -18,7 +18,7 @@ the mutex lock of the atomic integer will be acquired, and so there is no need to manually acquire it (unless this operation needs to be grouped with other operations on the same atomic integer - see the example in - AtomicInteger::lock for a demonstration of this). + pht\AtomicInteger::lock for a demonstration of this). diff --git a/reference/pht/atomicinteger/lock.xml b/reference/pht/atomicinteger/lock.xml index 92c0894ad6..8a82cde3e9 100644 --- a/reference/pht/atomicinteger/lock.xml +++ b/reference/pht/atomicinteger/lock.xml @@ -3,14 +3,14 @@ - AtomicInteger::lock + pht\AtomicInteger::lock Acquires the atomic integer's mutex lock &reftitle.description; - public voidAtomicInteger::lock + public voidpht\AtomicInteger::lock diff --git a/reference/pht/atomicinteger/set.xml b/reference/pht/atomicinteger/set.xml index ee3a574b13..546121d006 100644 --- a/reference/pht/atomicinteger/set.xml +++ b/reference/pht/atomicinteger/set.xml @@ -3,14 +3,14 @@ - AtomicInteger::set + pht\AtomicInteger::set Sets the atomic integer's value &reftitle.description; - public voidAtomicInteger::set + public voidpht\AtomicInteger::set intvalue @@ -18,7 +18,7 @@ lock of the atomic integer will be acquired, and so there is no need to manually acquire it (unless this operation needs to be grouped with other operations on the same atomic integer - see the example in - AtomicInteger::lock for a demonstration of this). + pht\AtomicInteger::lock for a demonstration of this). diff --git a/reference/pht/atomicinteger/unlock.xml b/reference/pht/atomicinteger/unlock.xml index 246479c379..ebcb552564 100644 --- a/reference/pht/atomicinteger/unlock.xml +++ b/reference/pht/atomicinteger/unlock.xml @@ -3,14 +3,14 @@ - AtomicInteger::unlock + pht\AtomicInteger::unlock Releases the atomic integer's mutex lock &reftitle.description; - public voidAtomicInteger::unlock + public voidpht\AtomicInteger::unlock diff --git a/reference/pht/book.xml b/reference/pht/book.xml index 61cbb563b1..902b773e16 100644 --- a/reference/pht/book.xml +++ b/reference/pht/book.xml @@ -20,9 +20,9 @@ The approach to threading that pht takes is to abstract away the thread - itself behind a dedicated object (Thread). Tasks are + itself behind a dedicated object (pht\Thread). Tasks are then added to the thread's internal task queue, where they are processed - when the thread is started (via Thread::start). + when the thread is started (via pht\Thread::start). All thread tasks will execute in isolation inside of the newly spawned @@ -35,8 +35,8 @@ The isolation of threading contexts makes the passing around of data between them somewhat problematic. To solve this problem, threadable data - structures (HashTable, Vector, - and Queue) have been implemented to allow for a + structures (pht\HashTable, pht\Vector, + and pht\Queue) have been implemented to allow for a two-way communication style between threads, where they expose mutex locks to control their integrity. These data structures can be safely passed around between threads, and manipulated by multiple threads using the mutex @@ -47,19 +47,19 @@ Atomic values are also supported by pht. Currently, only an - AtomicInteger class exists. Like the threaded data + pht\AtomicInteger class exists. Like the threaded data structures, it too can safely be passed around between threads. &reference.pht.setup; - &reference.pht.thread; - &reference.pht.runnable; - &reference.pht.hashtable; - &reference.pht.vector; - &reference.pht.queue; - &reference.pht.atomicinteger; - &reference.pht.threaded; + &reference.pht.pht.thread; + &reference.pht.pht.runnable; + &reference.pht.pht.hashtable; + &reference.pht.pht.vector; + &reference.pht.pht.queue; + &reference.pht.pht.atomicinteger; + &reference.pht.pht.threaded; diff --git a/reference/pht/hashtable/lock.xml b/reference/pht/hashtable/lock.xml index 2113a0daca..8897bc76fb 100644 --- a/reference/pht/hashtable/lock.xml +++ b/reference/pht/hashtable/lock.xml @@ -3,14 +3,14 @@ - HashTable::lock + pht\HashTable::lock Acquires the hash table's mutex lock &reftitle.description; - public voidHashTable::lock + public voidpht\HashTable::lock diff --git a/reference/pht/hashtable/size.xml b/reference/pht/hashtable/size.xml index 49c5d7fbff..f7f295fbaa 100644 --- a/reference/pht/hashtable/size.xml +++ b/reference/pht/hashtable/size.xml @@ -3,19 +3,19 @@ - HashTable::size + pht\HashTable::size Gets the size of the hash table &reftitle.description; - public intHashTable::size + public intpht\HashTable::size Returns the current size of the hash table. This operation requires a - HashTable's mutex lock to be held if it is being used + pht\HashTable's mutex lock to be held if it is being used by multiple threads. diff --git a/reference/pht/hashtable/unlock.xml b/reference/pht/hashtable/unlock.xml index ede9c722b3..8007b06a1b 100644 --- a/reference/pht/hashtable/unlock.xml +++ b/reference/pht/hashtable/unlock.xml @@ -3,14 +3,14 @@ - HashTable::unlock + pht\HashTable::unlock Releases the hash table's mutex lock &reftitle.description; - public voidHashTable::unlock + public voidpht\HashTable::unlock diff --git a/reference/pht/queue/front.xml b/reference/pht/queue/front.xml index ce0fc11556..a204190a6a 100644 --- a/reference/pht/queue/front.xml +++ b/reference/pht/queue/front.xml @@ -3,14 +3,14 @@ - Queue::front + pht\Queue::front Returns the first value from a queue &reftitle.description; - public mixedQueue::front + public mixedpht\Queue::front @@ -21,7 +21,7 @@ - Due to the fact that all values in a Queue are + Due to the fact that all values in a pht\Queue are serialised, extracting a value from the queue will require it to be deserialised. This can incur a noticeable performance hit if the inspection of the queue's front value is performed within a loop. diff --git a/reference/pht/queue/lock.xml b/reference/pht/queue/lock.xml index 6adac871f3..516e13756c 100644 --- a/reference/pht/queue/lock.xml +++ b/reference/pht/queue/lock.xml @@ -3,14 +3,14 @@ - Queue::lock + pht\Queue::lock Acquires the queue's mutex lock &reftitle.description; - public voidQueue::lock + public voidpht\Queue::lock diff --git a/reference/pht/queue/pop.xml b/reference/pht/queue/pop.xml index 9d9560b991..26a51c289b 100644 --- a/reference/pht/queue/pop.xml +++ b/reference/pht/queue/pop.xml @@ -3,14 +3,14 @@ - Queue::pop + pht\Queue::pop Pops a value off of the front of a queue &reftitle.description; - public mixedQueue::pop + public mixedpht\Queue::pop diff --git a/reference/pht/queue/push.xml b/reference/pht/queue/push.xml index 1b64d61c83..13bed9ba75 100644 --- a/reference/pht/queue/push.xml +++ b/reference/pht/queue/push.xml @@ -3,14 +3,14 @@ - Queue::push + pht\Queue::push Pushes a value to the end of a queue &reftitle.description; - public voidQueue::push + public voidpht\Queue::push mixedvalue @@ -25,7 +25,7 @@ value - The value to be added to a Queue. This value will + The value to be added to a pht\Queue. This value will be serialised (since it may be passed around between threads). diff --git a/reference/pht/queue/size.xml b/reference/pht/queue/size.xml index 48cfa76cf5..316baf750d 100644 --- a/reference/pht/queue/size.xml +++ b/reference/pht/queue/size.xml @@ -3,19 +3,19 @@ - Queue::size + pht\Queue::size Gets the size of the queue &reftitle.description; - public intQueue::size + public intpht\Queue::size Returns the current size of the queue. This operation requires a - Queue's mutex lock to be held if it is being used by + pht\Queue's mutex lock to be held if it is being used by multiple threads. diff --git a/reference/pht/queue/unlock.xml b/reference/pht/queue/unlock.xml index 76827863aa..cec9936dbf 100644 --- a/reference/pht/queue/unlock.xml +++ b/reference/pht/queue/unlock.xml @@ -3,14 +3,14 @@ - Queue::unlock + pht\Queue::unlock Releases the queue's mutex lock &reftitle.description; - public voidQueue::unlock + public voidpht\Queue::unlock diff --git a/reference/pht/runnable/run.xml b/reference/pht/runnable/run.xml index 913f71f5cc..53a27f7a99 100644 --- a/reference/pht/runnable/run.xml +++ b/reference/pht/runnable/run.xml @@ -3,14 +3,14 @@ - Runnable::run + pht\Runnable::run The entry point of a threaded class &reftitle.description; - public voidRunnable::run + public voidpht\Runnable::run diff --git a/reference/pht/thread/addClassTask.xml b/reference/pht/thread/addClassTask.xml index c81ad9736a..58ac76390f 100644 --- a/reference/pht/thread/addClassTask.xml +++ b/reference/pht/thread/addClassTask.xml @@ -3,19 +3,19 @@ - Thread::addClassTask + pht\Thread::addClassTask Class threading &reftitle.description; - public voidThread::addClassTask + public voidpht\Thread::addClassTask stringclassName mixed...ctorArgs - Adds a new class task to a Threads internal task queue. + Adds a new class task to a pht\Threads internal task queue. @@ -27,7 +27,7 @@ The name of the class to be threaded. This class must implement the - Runnable interface. + pht\Runnable interface. diff --git a/reference/pht/thread/addFileTask.xml b/reference/pht/thread/addFileTask.xml index 2236aca359..b37b35fbc5 100644 --- a/reference/pht/thread/addFileTask.xml +++ b/reference/pht/thread/addFileTask.xml @@ -3,19 +3,19 @@ - Thread::addFileTask + pht\Thread::addFileTask File threading &reftitle.description; - public voidThread::addFileTask + public voidpht\Thread::addFileTask stringfileName mixed...globals - Adds a new file task to a Threads internal task queue. + Adds a new file task to a pht\Threads internal task queue. diff --git a/reference/pht/thread/addFunctionTask.xml b/reference/pht/thread/addFunctionTask.xml index 46cf4f5693..8affe76960 100644 --- a/reference/pht/thread/addFunctionTask.xml +++ b/reference/pht/thread/addFunctionTask.xml @@ -3,19 +3,19 @@ - Thread::addFunctionTask + pht\Thread::addFunctionTask Function threading &reftitle.description; - public voidThread::addFunctionTask + public voidpht\Thread::addFunctionTask callablefunc mixed...funcArgs - Adds a new function task to a Threads internal task queue. + Adds a new function task to a pht\Threads internal task queue. diff --git a/reference/pht/thread/join.xml b/reference/pht/thread/join.xml index 09d8d729ae..a1261fecd4 100644 --- a/reference/pht/thread/join.xml +++ b/reference/pht/thread/join.xml @@ -3,14 +3,14 @@ - Thread::join + pht\Thread::join Joins a thread &reftitle.description; - public voidThread::join + public voidpht\Thread::join diff --git a/reference/pht/thread/start.xml b/reference/pht/thread/start.xml index 172269c8b6..735f3669d5 100644 --- a/reference/pht/thread/start.xml +++ b/reference/pht/thread/start.xml @@ -3,19 +3,19 @@ - Thread::start + pht\Thread::start Starts the new thread &reftitle.description; - public voidThread::start + public voidpht\Thread::start This will cause a new thread to be spawned for the associated - Thread object, where its internal task queue will + pht\Thread object, where its internal task queue will begin to be processed. diff --git a/reference/pht/thread/taskCount.xml b/reference/pht/thread/taskCount.xml index 837736a5ef..2e6f43687c 100644 --- a/reference/pht/thread/taskCount.xml +++ b/reference/pht/thread/taskCount.xml @@ -3,18 +3,18 @@ - Thread::taskCount + pht\Thread::taskCount Gets a thread's task count &reftitle.description; - public intThread::taskCount + public intpht\Thread::taskCount - Retrieves the current task count of a Thread. + Retrieves the current task count of a pht\Thread. diff --git a/reference/pht/threaded/lock.xml b/reference/pht/threaded/lock.xml index 6292e4586e..06eed7aec4 100644 --- a/reference/pht/threaded/lock.xml +++ b/reference/pht/threaded/lock.xml @@ -3,20 +3,20 @@ - Threaded::lock + pht\Threaded::lock Acquires the mutex lock &reftitle.description; - public voidThreaded::lock + public voidpht\Threaded::lock This method will acquire the mutex lock associated with the given class - (either a HashTable, Queue, - Vector, or AtomicInteger). + (either a pht\HashTable, pht\Queue, + pht\Vector, or pht\AtomicInteger). diff --git a/reference/pht/threaded/unlock.xml b/reference/pht/threaded/unlock.xml index 892b0e9293..38e6dbe00b 100644 --- a/reference/pht/threaded/unlock.xml +++ b/reference/pht/threaded/unlock.xml @@ -3,20 +3,20 @@ - Threaded::unlock - Unlocks a mutex lock + pht\Threaded::unlock + Releases the mutex lock &reftitle.description; - public voidThreaded::unlock + public voidpht\Threaded::unlock This method will unlock the mutex lock associated with the given class - (either a HashTable, Queue, - Vector, or AtomicInteger). + (either a pht\HashTable, pht\Queue, + pht\Vector, or pht\AtomicInteger). diff --git a/reference/pht/vector/construct.xml b/reference/pht/vector/construct.xml index 6c985ffcad..92fa683d4e 100644 --- a/reference/pht/vector/construct.xml +++ b/reference/pht/vector/construct.xml @@ -3,14 +3,14 @@ - Vector::__construct + pht\Vector::__construct Vector creation &reftitle.description; - public VectorVector::__construct + public Vectorpht\Vector::__construct intsize0 mixedvalue0 diff --git a/reference/pht/vector/deleteAt.xml b/reference/pht/vector/deleteAt.xml index 25d12db634..158ce361b7 100644 --- a/reference/pht/vector/deleteAt.xml +++ b/reference/pht/vector/deleteAt.xml @@ -3,14 +3,14 @@ - Vector::deleteAt + pht\Vector::deleteAt Deletes a value in the vector &reftitle.description; - public voidVector::deleteAt + public voidpht\Vector::deleteAt intoffset @@ -18,7 +18,7 @@ time). - Since the Vector class supports array access, + Since the pht\Vector class supports array access, deleting values can also be performed using the array subset notation ([]) in combination with the unset function. diff --git a/reference/pht/vector/insertAt.xml b/reference/pht/vector/insertAt.xml index fbc28f8266..34ca813a04 100644 --- a/reference/pht/vector/insertAt.xml +++ b/reference/pht/vector/insertAt.xml @@ -3,14 +3,14 @@ - Vector::insertAt + pht\Vector::insertAt Inserts a value into the vector &reftitle.description; - public voidVector::insertAt + public voidpht\Vector::insertAt mixedvalue intoffset @@ -40,8 +40,8 @@ The offset at which the value will be inserted at. This offset must be within the 0..N range (inclusive), where N is the size of the vector. Inserting at position N is the equivalent of using - Vector::push, and inserting at position 0 is the - equivalent of using Vector::unshift. Attempting + pht\Vector::push, and inserting at position 0 is the + equivalent of using pht\Vector::unshift. Attempting to insert at offsets outside of this range will result in an Error exception. diff --git a/reference/pht/vector/lock.xml b/reference/pht/vector/lock.xml index 381c49b56f..807ecd51b1 100644 --- a/reference/pht/vector/lock.xml +++ b/reference/pht/vector/lock.xml @@ -3,14 +3,14 @@ - Vector::lock + pht\Vector::lock Acquires the vector's mutex lock &reftitle.description; - public voidVector::lock + public voidpht\Vector::lock diff --git a/reference/pht/vector/pop.xml b/reference/pht/vector/pop.xml index 2a094dba61..26dd48eb0b 100644 --- a/reference/pht/vector/pop.xml +++ b/reference/pht/vector/pop.xml @@ -3,14 +3,14 @@ - Vector::pop + pht\Vector::pop Pops a value to the vector &reftitle.description; - public mixedVector::pop + public mixedpht\Vector::pop diff --git a/reference/pht/vector/push.xml b/reference/pht/vector/push.xml index 95fa82013d..a1f573ab42 100644 --- a/reference/pht/vector/push.xml +++ b/reference/pht/vector/push.xml @@ -3,14 +3,14 @@ - Vector::push + pht\Vector::push Pushes a value to the vector &reftitle.description; - public voidVector::push + public voidpht\Vector::push mixedvalue @@ -18,7 +18,7 @@ vector will automatically be resized if it is not large enough. - Since the Vector class supports array access, new + Since the pht\Vector class supports array access, new values can also be pushed onto the vector using the empty subset notation ([]). diff --git a/reference/pht/vector/resize.xml b/reference/pht/vector/resize.xml index 251ea7bcef..34d3cdb341 100644 --- a/reference/pht/vector/resize.xml +++ b/reference/pht/vector/resize.xml @@ -3,14 +3,14 @@ - Vector::resize + pht\Vector::resize Resizes a vector &reftitle.description; - public voidVector::resize + public voidpht\Vector::resize intsize mixedvalue0 diff --git a/reference/pht/vector/shift.xml b/reference/pht/vector/shift.xml index 029c2b9a24..de7c23b70b 100644 --- a/reference/pht/vector/shift.xml +++ b/reference/pht/vector/shift.xml @@ -3,14 +3,14 @@ - Vector::shift + pht\Vector::shift Shifts a value from the vector &reftitle.description; - public mixedVector::shift + public mixedpht\Vector::shift diff --git a/reference/pht/vector/size.xml b/reference/pht/vector/size.xml index 317bfd71af..bc8f9ac930 100644 --- a/reference/pht/vector/size.xml +++ b/reference/pht/vector/size.xml @@ -3,19 +3,19 @@ - Vector::size + pht\Vector::size Gets the size of the vector &reftitle.description; - public intVector::size + public intpht\Vector::size Returns the current size of the vector. This operation requires a - Vector's mutex lock to be held if it is being used by + pht\Vector's mutex lock to be held if it is being used by multiple threads. diff --git a/reference/pht/vector/unlock.xml b/reference/pht/vector/unlock.xml index 7a55616675..131e730445 100644 --- a/reference/pht/vector/unlock.xml +++ b/reference/pht/vector/unlock.xml @@ -3,14 +3,14 @@ - Vector::unlock + pht\Vector::unlock Releases the vector's mutex lock &reftitle.description; - public voidVector::unlock + public voidpht\Vector::unlock diff --git a/reference/pht/vector/unshift.xml b/reference/pht/vector/unshift.xml index 814c94a801..5a1dd5b365 100644 --- a/reference/pht/vector/unshift.xml +++ b/reference/pht/vector/unshift.xml @@ -3,14 +3,14 @@ - Vector::unshift + pht\Vector::unshift Unshifts a value to the vector front &reftitle.description; - public voidVector::unshift + public voidpht\Vector::unshift mixedvalue diff --git a/reference/pht/vector/updateAt.xml b/reference/pht/vector/updateAt.xml index beacf307a1..a80342e8a0 100644 --- a/reference/pht/vector/updateAt.xml +++ b/reference/pht/vector/updateAt.xml @@ -3,14 +3,14 @@ - Vector::updateAt + pht\Vector::updateAt Updates a value in the vector &reftitle.description; - public voidVector::updateAt + public voidpht\Vector::updateAt mixedvalue intoffset @@ -19,7 +19,7 @@ time). The vector will automatically be resized if it is not large enough. - Since the Vector class supports array access, + Since the pht\Vector class supports array access, updating values can also be performed using the array subset notation ([]). diff --git a/reference/pht/versions.xml b/reference/pht/versions.xml index 3cea987acf..4c7c30f53e 100644 --- a/reference/pht/versions.xml +++ b/reference/pht/versions.xml @@ -4,56 +4,56 @@ Do NOT translate this file --> - - - - - - - + + + + + + + - - + + - - - + + + - - - - - - - + + + + + + + - - - - + + + + - - - - - - - - - - - - - + + + + + + + + + + + + + - - - - - - - - + + + + + + + +