diff options
| author | Thomas White <taw@physics.org> | 2019-05-07 16:10:17 +0200 |
|---|---|---|
| committer | Thomas White <taw@physics.org> | 2019-05-07 16:25:44 +0200 |
| commit | 1bed7848a99aba510726b3fa287b1d7a3f75dfa6 (patch) | |
| tree | ddeea6dc2a6a23c80a8d5f76ae8fd4548b8ac3c7 /libcrystfel/src/crystal.c | |
| parent | 66ec127e34d2f732e65be61897347edf17bdb4e1 (diff) | |
Update all source code comments to Doxygen format
Diffstat (limited to 'libcrystfel/src/crystal.c')
| -rw-r--r-- | libcrystfel/src/crystal.c | 30 |
1 files changed, 9 insertions, 21 deletions
diff --git a/libcrystfel/src/crystal.c b/libcrystfel/src/crystal.c index 66a8e19c..ee02e1af 100644 --- a/libcrystfel/src/crystal.c +++ b/libcrystfel/src/crystal.c @@ -36,15 +36,7 @@ /** - * SECTION:crystal - * @short_description: Crystal - * @title: Crystal - * @section_id: - * @see_also: - * @include: "crystal.h" - * @Image: - * - * This structure represents a single crystal. + * \file crystal.h */ @@ -84,11 +76,9 @@ struct _crystal /** - * crystal_new: - * - * Create a new %Crystal. + * Create a new \ref Crystal. * - * Returns: the new unit cell, or NULL on failure. + * \returns The new unit cell, or NULL on failure. * */ Crystal *crystal_new() @@ -113,14 +103,13 @@ Crystal *crystal_new() /** - * crystal_copy: - * @cryst: A %Crystal to copy. + * \param cryst: A \ref Crystal to copy. * - * Creates a new %Crystal which is a copy of @cryst. The copy is a "shallow + * Creates a new \ref Crystal which is a copy of \p cryst. The copy is a "shallow * copy", which means that copies are NOT made of the data structures which - * @cryst contains references to, for example its %RefList. + * \p cryst contains references to, for example its \ref RefList. * - * Returns: a (shallow) copy of @cryst, or NULL on failure. + * \returns A (shallow) copy of \p cryst, or NULL on failure. * */ Crystal *crystal_copy(const Crystal *cryst) @@ -138,10 +127,9 @@ Crystal *crystal_copy(const Crystal *cryst) /** - * crystal_free: - * @cryst: A %Crystal to free. + * \param cryst: A \ref Crystal to free. * - * Frees a %Crystal, and all internal resources concerning that crystal. + * Frees a \ref Crystal, and all internal resources concerning that crystal. * */ void crystal_free(Crystal *cryst) |