Add documentation via gtk-doc

1 files changed, 55 insertions, 1 deletions

diff --git a/src/image.h b/src/image.h
index 964ed124..dc93de0f 100644
--- a/src/image.h
+++ b/src/image.h
@@ -53,15 +53,69 @@ struct imagefeature {
 typedef struct _imagefeaturelist ImageFeatureList;
 
 
-/* Structure describing an image */
+/**
+ * image:
+ *
+ * <programlisting>
+ * struct image
+ * {
+ *    float                   *data;
+ *    uint16_t                *flags;
+ *    double                  *twotheta;
+ *
+ *    UnitCell                *indexed_cell;
+ *    UnitCell                *candidate_cells[MAX_CELL_CANDIDATES];
+ *    int                     ncells;
+
+ *    struct detector         *det;
+ *    struct beam_params      *beam;
+ *    char                    *filename;
+ *
+ *    int                     id;
+ *
+ *    double                  m;
+ *
+ *    double                  lambda;
+ *    double                  div;
+ *    double                  bw;
+ *    double                  i0;
+ *    int                     i0_available;
+ *    double                  osf;
+ *    double                  profile_radius;
+ *
+ *    int                     width;
+ *    int                     height;
+ *
+ *    RefList                 *reflections;
+ *
+ *    ImageFeatureList        *features;
+ * };
+ * </programlisting>
+ *
+ * The field <structfield>data</structfield> contains the raw image data, if it
+ * is currently available.  The data might be available throughout the
+ * processing of an experimental pattern, but it might not be available when
+ * simulating, scaling or merging patterns.  Similarly,
+ * <structfield>flags</structfield> contains an array of the same dimensions
+ * as <structfield>data</structfield> to contain the bad pixel flags.
+ * <structfield>twotheta</structfield> likewise contains an array of 2*theta
+ * (scattering angle) values in radians, since these values are generated as a
+ * by-product of the scattering vector calculation and can be used later for
+ * calculating intensities from differential scattering cross sections.
+ *
+ **/
+struct image;
+
 struct image {
 
 	float                   *data;
 	uint16_t                *flags;
 	double                  *twotheta;
+
 	UnitCell                *indexed_cell;
 	UnitCell                *candidate_cells[MAX_CELL_CANDIDATES];
 	int                     ncells;
+
 	struct detector         *det;
 	struct beam_params      *beam;  /* The nominal beam parameters */
 	char                    *filename;