diff options
| author | Tavian Barnes <tavianator@gmail.com> | 2010-11-14 21:20:43 -0500 |
|---|---|---|
| committer | Tavian Barnes <tavianator@gmail.com> | 2010-11-14 21:20:43 -0500 |
| commit | 8fe33a340b8979a73fa84f201c15519a9b5d0266 (patch) | |
| tree | 12cdbb1c1b9a48f533ab36980602785be1e1deeb /libdimension/dimension/lights.h | |
| parent | 20a55aa78050d94b187d4edfaac91ea00efea505 (diff) | |
| download | dimension-8fe33a340b8979a73fa84f201c15519a9b5d0266.tar.xz | |
Document libdimension with Doxygen.
Diffstat (limited to 'libdimension/dimension/lights.h')
| -rw-r--r-- | libdimension/dimension/lights.h | 11 |
1 files changed, 9 insertions, 2 deletions
diff --git a/libdimension/dimension/lights.h b/libdimension/dimension/lights.h index 7b7385e..7c0f140 100644 --- a/libdimension/dimension/lights.h +++ b/libdimension/dimension/lights.h @@ -18,13 +18,20 @@ * <http://www.gnu.org/licenses/>. * *************************************************************************/ -/* - * Types of lights. +/** + * @file + * Pre-defined light types. */ #ifndef DIMENSION_LIGHTS_H #define DIMENSION_LIGHTS_H +/** + * A point light. + * @param[in] x0 The origin of the light. + * @param[in] color The color of the light. + * @return A point light. + */ dmnsn_light *dmnsn_new_point_light(dmnsn_vector x0, dmnsn_color color); #endif /* DIMENSION_LIGHTS_H */ |