docblock

git-svn-id: https://semanticscuttle.svn.sourceforge.net/svnroot/semanticscuttle/trunk@673 b3834d28-1941-0410-a4f8-b48e95affb8f

diff --git a/src/SemanticScuttle/functions.php b/src/SemanticScuttle/functions.php
index d21a094a9a6e0965151194fef36863acc925e663..15db0220f17bb349bf603064bd55fd90d81031e0 100644 (file)
--- a/src/SemanticScuttle/functions.php
+++ b/src/SemanticScuttle/functions.php
@@ -35,10 +35,23 @@ function filter($data, $type = NULL) {
        return $data;
 }
 
-function getPerPageCount($userObject = null) {
+/**
+ * Returns the number of bookmarks that shall be displayed on one page.
+ *
+ * @param SemanticScuttle_Model_User $userObject Object of the current user
+ *
+ * @return integer Number of bookmarks per page
+ *
+ * @uses $defaultPerPage
+ * @uses $defaultPerPageForAdmins
+ */
+function getPerPageCount($userObject = null)
+{
        global $defaultPerPage, $defaultPerPageForAdmins;
        
-       if(isset($defaultPerPageForAdmins) && $userObject != null && $userObject->isAdmin()) {          
+       if (isset($defaultPerPageForAdmins)
+        && $userObject != null && $userObject->isAdmin()
+    ) {
                return $defaultPerPageForAdmins;
        } else {
                return $defaultPerPage;