improve consistency in compare.h documentation

Tue, 11 Feb 2025 19:47:58 +0100

author
Mike Becker <universe@uap-core.de>
date
Tue, 11 Feb 2025 19:47:58 +0100
changeset 1186
7fc882813125
parent 1185
d825aca193d3
child 1187
0f70bb04f7ba

improve consistency in compare.h documentation

src/cx/compare.h file | annotate | diff | comparison | revisions
--- a/src/cx/compare.h	Tue Feb 11 19:41:02 2025 +0100
+++ b/src/cx/compare.h	Tue Feb 11 19:47:58 2025 +0100
@@ -80,7 +80,7 @@
 int cx_cmp_int(const void *i1, const void *i2);
 
 /**
- * Compares two ints.
+ * Compares two integers of type int.
  *
  * @param i1 integer one
  * @param i2 integer two
@@ -110,7 +110,7 @@
 int cx_cmp_longint(const void *i1, const void *i2);
 
 /**
- * Compares two long ints.
+ * Compares two integers of type long int.
  *
  * @param i1 long integer one
  * @param i2 long integer two
@@ -140,7 +140,7 @@
 int cx_cmp_longlong(const void *i1, const void *i2);
 
 /**
- * Compares two long long ints.
+ * Compares two integers of type long long.
  *
  * @param i1 long long int one
  * @param i2 long long int two
@@ -260,7 +260,7 @@
 int cx_cmp_uint(const void *i1, const void *i2);
 
 /**
- * Compares two unsigned ints.
+ * Compares two integers of type unsigned int.
  *
  * @param i1 unsigned integer one
  * @param i2 unsigned integer two
@@ -290,7 +290,7 @@
 int cx_cmp_ulongint(const void *i1, const void *i2);
 
 /**
- * Compares two unsigned long ints.
+ * Compares two integers of type unsigned long int.
  *
  * @param i1 unsigned long integer one
  * @param i2 unsigned long integer two
@@ -320,7 +320,7 @@
 int cx_cmp_ulonglong(const void *i1, const void *i2);
 
 /**
- * Compares two unsigned long long ints.
+ * Compares two integers of type unsigned long long.
  *
  * @param i1 unsigned long long one
  * @param i2 unsigned long long two
@@ -470,7 +470,7 @@
 int cx_cmp_double(const void *d1, const void *d2);
 
 /**
- * Convenience function
+ * Compares two real numbers of type double with precision 1e-14.
  *
  * @param d1 double one
  * @param d2 double two
@@ -543,7 +543,7 @@
 int cx_vcmp_uintptr(uintptr_t ptr1, uintptr_t ptr2);
 
 /**
- * Compares the pointers specified in the arguments without de-referencing.
+ * Compares the pointers specified in the arguments without dereferencing.
  *
  * @param ptr1 pointer one
  * @param ptr2 pointer two

mercurial