summaryrefslogtreecommitdiffstats
path: root/libdimension/dimension/interior.h
diff options
context:
space:
mode:
authorTavian Barnes <tavianator@gmail.com>2010-11-14 21:20:43 -0500
committerTavian Barnes <tavianator@gmail.com>2010-11-14 21:20:43 -0500
commit8fe33a340b8979a73fa84f201c15519a9b5d0266 (patch)
tree12cdbb1c1b9a48f533ab36980602785be1e1deeb /libdimension/dimension/interior.h
parent20a55aa78050d94b187d4edfaac91ea00efea505 (diff)
downloaddimension-8fe33a340b8979a73fa84f201c15519a9b5d0266.tar.xz
Document libdimension with Doxygen.
Diffstat (limited to 'libdimension/dimension/interior.h')
-rw-r--r--libdimension/dimension/interior.h23
1 files changed, 16 insertions, 7 deletions
diff --git a/libdimension/dimension/interior.h b/libdimension/dimension/interior.h
index 96168cf..7302426 100644
--- a/libdimension/dimension/interior.h
+++ b/libdimension/dimension/interior.h
@@ -18,28 +18,37 @@
* <http://www.gnu.org/licenses/>. *
*************************************************************************/
-/*
+/**
+ * @file
* Object interiors.
*/
#ifndef DIMENSION_INTERIOR_H
#define DIMENSION_INTERIOR_H
+/** An interior */
typedef struct dmnsn_interior {
- /* Refractive index */
- double ior;
+ double ior; /**< Refractive index. */
- /* Callbacks */
- dmnsn_free_fn *free_fn;
+ dmnsn_free_fn *free_fn; /**< Destructor callback. */
- /* Generic pointer */
+ /** Generic pointer. */
void *ptr;
- /* Reference count */
+ /** @internal Reference count. */
unsigned int *refcount;
} dmnsn_interior;
+/**
+ * Create an interior object.
+ * @return The new interior.
+ */
dmnsn_interior *dmnsn_new_interior(void);
+
+/**
+ * Delete an interior.
+ * @param[in,out] interior The interior to delete.
+ */
void dmnsn_delete_interior(dmnsn_interior *interior);
#endif /* DIMENSION_INTERIOR_H */