summaryrefslogtreecommitdiff
path: root/src/cr-num.c
diff options
context:
space:
mode:
authorCEST 2005 Dodji Seketeli <dodji@seketeli.org>2005-05-10 19:48:58 +0000
committerDodji Seketeli <dodji@src.gnome.org>2005-05-10 19:48:58 +0000
commit87e540b6a27f7fcca8b450bb44a8b197eeffb464 (patch)
tree99d68d410ff91b556e58c73b6c5cd262fc7959a6 /src/cr-num.c
parent3e0fb4e6acd9b29303384da9242b08c70e4d9add (diff)
downloadlibcroco-87e540b6a27f7fcca8b450bb44a8b197eeffb464.tar.gz
applied the following patches:
Tue May 10 21:49:05 CEST 2005 Dodji Seketeli <dodji@seketeli.org> applied the following patches: dodji@gnome.org--xml-style-2004/libcroco--mainline--0.6--patch-29 2004-06-09 00:09:41 GMT updated NEWS file for 0.6.0 [Dodji Seketeli] dodji@gnome.org--xml-style-2004/libcroco--mainline--0.6--patch-30 2004-09-20 16:13:02 GMT fixed a nasty memory management bug [Dodji Seketeli] dodji@gnome.org--xml-style-2004/libcroco--mainline--0.6--patch-31 2005-02-10 21:41:04 GMT rm test output upon 'make clean' [Peter Moulder] dodji@gnome.org--xml-style-2004/libcroco--mainline--0.6--patch-32 2005-02-13 13:14:16 GMT make 'all' target a prerequisite of the 'test' target [Peter Moulder] dodji@gnome.org--xml-style-2004/libcroco--mainline--0.6--patch-33 2005-02-13 19:24:25 GMT allow building/testing in a directory different from srcdir [Peter Moulder/Dodji Seketeli] dodji@gnome.org--xml-style-2004/libcroco--mainline--0.6--patch-34 2005-02-13 19:42:48 GMT added better api documentation [Peter Moulder] dodji@gnome.org--xml-style-2004/libcroco--mainline--0.6--patch-35 2005-05-05 16:38:07 GMT initial port to gtk-doc, switch to automake 1.7 [Sven Herzberg, Dodji Seketeli] dodji@gnome.org--xml-style-2004/libcroco--mainline--0.6--patch-36 2005-05-05 16:51:38 GMT more gtk-doc stuffs [Dodji Seketeli] dodji@gnome.org--xml-style-2004/libcroco--mainline--0.6--patch-37 2005-05-06 14:20:20 GMT typos and c++ compilation fixes [Peter Moulder]
Diffstat (limited to 'src/cr-num.c')
-rw-r--r--src/cr-num.c74
1 files changed, 45 insertions, 29 deletions
diff --git a/src/cr-num.c b/src/cr-num.c
index d95be07..cce30ff 100644
--- a/src/cr-num.c
+++ b/src/cr-num.c
@@ -23,7 +23,8 @@
*/
/**
- *@file
+ *@CRNum:
+ *
*The definition
*of the #CRNum class.
*/
@@ -32,9 +33,11 @@
#include "string.h"
/**
- *The default constructor of
+ * cr_num_new:
+ *
*#CRNum.
- *@return the newly built instance of
+ *
+ *Returns the newly built instance of
*#CRNum.
*/
CRNum *
@@ -55,16 +58,14 @@ cr_num_new (void)
}
/**
- *A constructor of #CRNum.
- *@param a_is_natural indicates whether the intance of #CRNum is
- *a natural number or not.
- *@param a_integer_part the integer part of the instance
- *of #CRNum
- *@param a_decimal_part in case the instance of #CRNum
- *natural number (but a decimal one) this parameter
- *is the decimal part of the instance of #CRNum.
- *@return the newly built instance of #CRNum or
- *NULL if an error arises.
+ * cr_num_new_with_val:
+ * @a_val: the numerical value of the number.
+ * @a_type: the type of number.
+ *
+ * A constructor of #CRNum.
+ *
+ * Returns the newly built instance of #CRNum or
+ * NULL if an error arises.
*/
CRNum *
cr_num_new_with_val (gdouble a_val, enum CRNumType a_type)
@@ -82,10 +83,10 @@ cr_num_new_with_val (gdouble a_val, enum CRNumType a_type)
}
/**
- *Returns the string representation of the
- *current instance of #CRNum.
- *@param a_this the current instance of #CRNum.
- *@return the newly built string representation
+ * cr_num_to_string:
+ *@a_this: the current instance of #CRNum.
+ *
+ *Returns the newly built string representation
*of the current instance of #CRNum. The returned
*string is NULL terminated. The caller *must*
*free the returned string.
@@ -200,12 +201,15 @@ cr_num_to_string (CRNum * a_this)
}
/**
- *Copies an instance of #CRNum.
- *@param a_src the instance of #CRNum to copy.
+ * cr_num_copy:
+ *@a_src: the instance of #CRNum to copy.
*Must be non NULL.
- *@param a_dst the destination of the copy.
+ *@a_dest: the destination of the copy.
*Must be non NULL
- *@return CR_OK upon successful completion, an
+ *
+ *Copies an instance of #CRNum.
+ *
+ *Returns CR_OK upon successful completion, an
*error code otherwise.
*/
enum CRStatus
@@ -219,9 +223,12 @@ cr_num_copy (CRNum * a_dest, CRNum * a_src)
}
/**
+ * cr_num_dup:
+ *@a_this: the instance of #CRNum to duplicate.
+ *
*Duplicates an instance of #CRNum
- *@param a_this the instance of #CRNum to duplicate.
- *@return the newly created (duplicated) instance of #CRNum.
+ *
+ *Returns the newly created (duplicated) instance of #CRNum.
*Must be freed by cr_num_destroy().
*/
CRNum *
@@ -242,11 +249,14 @@ cr_num_dup (CRNum * a_this)
}
/**
+ * cr_num_set:
*Sets an instance of #CRNum.
- *@param a_this the current instance of #CRNum to be set.
- *@param a_val the new numerical value to be hold by the current
+ *@a_this: the current instance of #CRNum to be set.
+ *@a_val: the new numerical value to be hold by the current
*instance of #CRNum
- *@param a_type the new type of #CRNum.
+ *@a_type: the new type of #CRNum.
+ *
+ * Returns CR_OK upon succesful completion, an error code otherwise.
*/
enum CRStatus
cr_num_set (CRNum * a_this, gdouble a_val, enum CRNumType a_type)
@@ -260,11 +270,15 @@ cr_num_set (CRNum * a_this, gdouble a_val, enum CRNumType a_type)
}
/**
+ * cr_num_is_fixed_length:
+ * @a_this: the current instance of #CRNum .
+ *
*Tests if the current instance of #CRNum is a fixed
*length value or not. Typically a fixed length value
*is anything from NUM_LENGTH_EM to NUM_LENGTH_PC.
*See the definition of #CRNumType to see what we mean.
- *@return TRUE if the instance of #CRNum is a fixed length number,
+ *
+ *Returns TRUE if the instance of #CRNum is a fixed length number,
*FALSE otherwise.
*/
gboolean
@@ -282,9 +296,11 @@ cr_num_is_fixed_length (CRNum * a_this)
}
/**
- *The destructor of #CRNum.
- *@param a_this the this pointer of
+ * cr_num_destroy:
+ *@a_this: the this pointer of
*the current instance of #CRNum.
+ *
+ *The destructor of #CRNum.
*/
void
cr_num_destroy (CRNum * a_this)