aboutsummaryrefslogtreecommitdiff
path: root/src/cell.c
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2011-03-28 18:00:27 +0200
committerThomas White <taw@physics.org>2012-02-22 15:27:22 +0100
commit2a6ce4a23bd88ca2603b47559ac831dbead6c6ad (patch)
tree93b7d1c005b81a4050ba8ce92aed3ba5ea1d4c4f /src/cell.c
parent49c9f1e1e7a01c09c1cebd99ca1dc6c32eec284d (diff)
Update docs
Diffstat (limited to 'src/cell.c')
-rw-r--r--src/cell.c23
1 files changed, 23 insertions, 0 deletions
diff --git a/src/cell.c b/src/cell.c
index cd0e0975..cb846db5 100644
--- a/src/cell.c
+++ b/src/cell.c
@@ -26,6 +26,20 @@
#include "image.h"
+/**
+ * SECTION:unitcell
+ * @short_description: Unit cell
+ * @title: UnitCell
+ * @section_id:
+ * @see_also:
+ * @include: "cell.h"
+ * @Image:
+ *
+ * This structure represents a unit cell.
+ */
+
+
+
/* Weighting factor of lengths relative to angles */
#define LWEIGHT (10.0e-9)
@@ -64,6 +78,15 @@ struct _unitcell {
/************************** Setters and Constructors **************************/
+
+/**
+ * cell_new:
+ *
+ * Create a new %UnitCell.
+ *
+ * Returns: the new unit cell, or NULL on failure.
+ *
+ */
UnitCell *cell_new()
{
UnitCell *cell;