diff options
author | Thomas White <taw@bitwiz.org.uk> | 2011-03-26 20:26:06 +0100 |
---|---|---|
committer | Thomas White <taw@physics.org> | 2012-02-22 15:27:21 +0100 |
commit | cf481c5e99e6923358687d66fd6afecc95625a57 (patch) | |
tree | ad847b8243eda52ffc8081880dd402dc39e5fbed /src/utils.c | |
parent | 03acd73808f6f21bbfc38300796b24ecf823a697 (diff) |
Add documentation via gtk-doc
Diffstat (limited to 'src/utils.c')
-rw-r--r-- | src/utils.c | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/src/utils.c b/src/utils.c index 1d023783..7a27e057 100644 --- a/src/utils.c +++ b/src/utils.c @@ -23,6 +23,28 @@ #include "image.h" +/** + * SECTION:utils + * @short_description: Miscellaneous utilities + * @title: Utilities + * @section_id: + * @see_also: + * @include: "utils.h" + * @Image: + * + * Wibble + */ + +/** + * show_matrix_eqn: + * @M: A matrix + * @v: A vector + * @r: The number of elements in @v and the side length of @M. + * + * Displays a matrix equation of the form @M.a = @v. + * + * @M must be square. + **/ void show_matrix_eqn(gsl_matrix *M, gsl_vector *v, int r) { int i, j; @@ -312,6 +334,17 @@ int assplode(const char *a, const char *delims, char ***pbits, return n; } +/** + * SECTION:reflitemlist + * @short_description: The index list and indexed arrays + * @title: ReflItemList + * @section_id: + * @see_also: + * @include: "utils.h" + * @Image: + * + * Wibble + */ struct _reflitemlist { struct refl_item *items; @@ -333,10 +366,18 @@ static void alloc_items(ReflItemList *items) } +/** + * new_items: + * + * Creates a new %ReflItemList. + * + * Returns: The new list, or NULL. + **/ ReflItemList *new_items() { ReflItemList *new; new = malloc(sizeof(ReflItemList)); + if ( new == NULL ) return NULL; new->max_items = 1024; new->n_items = 0; new->items = NULL; |