Documentation fixes

[vlp.git] / src / int / util.c

diff --git a/src/int/util.c b/src/int/util.c
index 96d68858edf5ba40a6badde659384eb13b07f200..898587ddc3713799f0d232620b79d425791f836d 100644 (file)
--- a/src/int/util.c
+++ b/src/int/util.c
@@ -37,7 +37,10 @@ or             Andrzej Salwicki
 
 #include <time.h>
 
-/* Utility routines */
+/**
+ * @file
+ * @brief Utility routines
+ */
 
 /**
  * Compute entier (floor)
@@ -136,7 +139,7 @@ void abend(char *msg)
 static int ranpat1 = 7, ranpat2 = 503, ranpat3 = 15661;
 
 /**
- * Initialize generator
+ * Initializes random number generator
  */
 void ranset()
 {
@@ -149,7 +152,9 @@ void ranset()
 }
 
 /**
- * Produce next pseudo random number
+ * Produces next pseudo random number
+ *
+ * @see ranset must be invoked before running this function
  */
 double prandom()
 {
@@ -177,6 +182,10 @@ double prandom()
 
 /**
  * Copy a block of memory
+ *
+ * @param from[in] source block to copy from
+ * @param to[out] destination block to copy to
+ * @param len number of character to copy
  */
 void moveblock(char *from, char *to, word len)
 {