Document libdimension with Doxygen.

1 files changed, 29 insertions, 2 deletions

diff --git a/libdimension/dimension/csg.h b/libdimension/dimension/csg.h
index 176467a..5d923bf 100644
--- a/libdimension/dimension/csg.h
+++ b/libdimension/dimension/csg.h
@@ -18,16 +18,43 @@
  * <http://www.gnu.org/licenses/>.                                       *
  *************************************************************************/
 
-/*
+/**
+ * @file
  * Constructive solid geometry
  */
 
 #ifndef DIMENSION_CSG_H
 #define DIMENSION_CSG_H
 
-dmnsn_object *dmnsn_new_csg_union(dmnsn_array *objects);
+/**
+ * CSG union.
+ * @param[in] objects  The objects from which to compose the union.
+ * @return A union of the objects in \p objects.
+ */
+dmnsn_object *dmnsn_new_csg_union(const dmnsn_array *objects);
+
+/**
+ * CSG intersection.
+ * @param[in,out] A  The first object.
+ * @param[in,out] B  The second object.
+ * @return The intersection of \p A and \p B.
+ */
 dmnsn_object *dmnsn_new_csg_intersection(dmnsn_object *A, dmnsn_object *B);
+
+/**
+ * CSG intersection.
+ * @param[in,out] A  The outer object.
+ * @param[in,out] B  The inner object.
+ * @return The difference between \p A and \p B.
+ */
 dmnsn_object *dmnsn_new_csg_difference(dmnsn_object *A, dmnsn_object *B);
+
+/**
+ * CSG Merge.
+ * @param[in,out] A  The first object.
+ * @param[in,out] B  The second object.
+ * @return The merge of \p A and \p B.
+ */
 dmnsn_object *dmnsn_new_csg_merge(dmnsn_object *A, dmnsn_object *B);
 
 #endif /* DIMENSION_CSG_H */