Changeset 25614 for trunk/include/functions_rate.inc.php

Timestamp:

Nov 21, 2013, 11:02:44 AM (10 years ago)

Author:

mistic100

Message:

feature 2999: documentation of functions_rate and functions_session

File:

• trunk/include/functions_rate.inc.php (modified) (2 diffs)

trunk/include/functions_rate.inc.php

@@ -23 +23 @@
 
 /**
- * rate a picture by a user
+ * @package functions\rate
+ */
+
+
+/**
+ * Rate a picture by the current user.
  *
- * @param int image identifier
- * @param int rate
- * @return void
+ * @param int $image_id
+ * @param float $rate
+ * @return array as return by update_rating_score()
  */
 function rate_picture($image_id, $rate)
@@ -121 +126 @@
 
 
-/* update images.rating_score field
-  * we use a bayesian average (http://en.wikipedia.org/wiki/Bayesian_average) with
-C = average number of rates per item
-m = global average rate (all rates)
-
- * param int $element_id optional, otherwise applies to all
- * @return array(rating_score, count) if element_id is specified
+/**
+ * Update images.rating_score field.
+ * We use a bayesian average (http://en.wikipedia.org/wiki/Bayesian_average) with
+ *  C = average number of rates per item
+ *  m = global average rate (all rates)
+ *
+ * @param int|false $element_id if false applies to all
+ * @return array (score, average, count) values are null if $element_id is false
 */
 function update_rating_score($element_id = false)