Minor code cleanup: PHPDoc, spelling, unused variables, etc.

[github/shaarli/Shaarli.git] / application / Utils.php

diff --git a/application/Utils.php b/application/Utils.php
index 7d7eaffdb71b86abe8b56b879fcbb968a7fb511e..0166ee2ac0e132035af72e132a50ceb4368933e7 100644 (file)
--- a/application/Utils.php
+++ b/application/Utils.php
@@ -32,6 +32,10 @@ function logm($logFile, $clientIp, $message)
  *
  *  In Shaarli, they are used as a tinyurl-like link to individual entries,
  *  e.g. smallHash('20111006_131924') --> yZH23w
+ *
+ * @param string $text Create a hash from this text.
+ *
+ * @return string generated small hash.
  */
 function smallHash($text)
 {
@@ -106,7 +110,9 @@ function unescape($str)
 }
 
 /**
- * Link sanitization before templating
+ * Sanitize link before rendering.
+ *
+ * @param array $link Link to escape.
  */
 function sanitizeLink(&$link)
 {