diff options
| -rw-r--r-- | libdimension/profile.h | 4 | ||||
| -rw-r--r-- | libdimension/prtree.h | 8 | ||||
| -rw-r--r-- | libdimension/threads.c | 1 |
3 files changed, 8 insertions, 5 deletions
diff --git a/libdimension/profile.h b/libdimension/profile.h index 9282c66..04c77e2 100644 --- a/libdimension/profile.h +++ b/libdimension/profile.h @@ -31,12 +31,12 @@ /** * Record an test and its expected result. Called by dmnsn_[un]likely(); * don't call directly. - * @param[in] value The result of the test. + * @param[in] result The result of the test. * @param[in] expected The expected result of the test. * @param[in] func The name of the function the test occurs in. * @param[in] file The name of the file the test occurs in. * @param[in] line The line number on which the test occurs. - * @return \p value. + * @return \p result. */ bool dmnsn_expect(bool result, bool expected, const char *func, const char *file, unsigned int line); diff --git a/libdimension/prtree.h b/libdimension/prtree.h index c69d1ec..86707cf 100644 --- a/libdimension/prtree.h +++ b/libdimension/prtree.h @@ -31,10 +31,12 @@ #include <stdbool.h> +/** A priority R-tree; the spatial subdivision method used for intersection + queries against the scene graph. */ typedef struct dmnsn_prtree { - dmnsn_bounding_box bounding_box; - dmnsn_array *unbounded; - dmnsn_array *bounded; + dmnsn_bounding_box bounding_box; /**< The bounding box for the whole scene. */ + dmnsn_array *unbounded; /**< The unbounded objects. */ + dmnsn_array *bounded; /**< A PR-tree of the bounded objects. */ } dmnsn_prtree; /** Create a PR-tree. */ diff --git a/libdimension/threads.c b/libdimension/threads.c index cf94d70..eb5e0aa 100644 --- a/libdimension/threads.c +++ b/libdimension/threads.c @@ -72,6 +72,7 @@ dmnsn_new_thread(dmnsn_progress *progress, dmnsn_thread_fn *thread_fn, } } +/** Payload for threads executed by dmnsn_execute_concurrently(). */ typedef struct dmnsn_concurrent_thread_payload { dmnsn_concurrent_thread_fn *thread_fn; void *arg; |