diff options
| author | Juan Linietsky <reduzio@gmail.com> | 2017-09-12 17:42:36 -0300 |
|---|---|---|
| committer | Juan Linietsky <reduzio@gmail.com> | 2017-09-12 17:45:41 -0300 |
| commit | 4f929a0fdfae24b1ca5acf0b732219119090ee43 (patch) | |
| tree | 730471182cae00f2e47c7430db441d057383d29b /doc/classes/Semaphore.xml | |
| parent | 175777596ec3521731665dd750fd7087793b10fc (diff) | |
Changed the doc class generation to individual files per class. It is also possible to save module files in module directories and the build system will
recognize them.
Diffstat (limited to 'doc/classes/Semaphore.xml')
| -rw-r--r-- | doc/classes/Semaphore.xml | 31 |
1 files changed, 31 insertions, 0 deletions
diff --git a/doc/classes/Semaphore.xml b/doc/classes/Semaphore.xml new file mode 100644 index 0000000000..0aeb6472af --- /dev/null +++ b/doc/classes/Semaphore.xml @@ -0,0 +1,31 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<class name="Semaphore" inherits="Reference" category="Core" version="3.0.alpha.custom_build"> + <brief_description> + A synchronization Semaphore. + </brief_description> + <description> + A synchronization Semaphore. Element used in multi-threadding. Initialized to zero on creation. + </description> + <tutorials> + </tutorials> + <demos> + </demos> + <methods> + <method name="post"> + <return type="int" enum="Error"> + </return> + <description> + Lowers the [Semaphore], allowing one more thread in. + </description> + </method> + <method name="wait"> + <return type="int" enum="Error"> + </return> + <description> + Tries to wait for the [Semaphore], if its value is zero, blocks until non-zero. + </description> + </method> + </methods> + <constants> + </constants> +</class> |