header docblock

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

diff --git a/src/SemanticScuttle/functions.php b/src/SemanticScuttle/functions.php
index 15db0220f17bb349bf603064bd55fd90d81031e0..84e9c5f67b3ef0b5cd95ced054c627e55e7c7a12 100644 (file)
--- a/src/SemanticScuttle/functions.php
+++ b/src/SemanticScuttle/functions.php
@@ -1,6 +1,19 @@
 <?php
-/* Define functions used into the application */
-
+/**
+ * Defines some commonly used functions.
+ *
+ * SemanticScuttle - your social bookmark manager.
+ *
+ * PHP version 5.
+ *
+ * @category Bookmarking
+ * @package  SemanticScuttle
+ * @author   Benjamin Huynh-Kim-Bang <mensonge@users.sourceforge.net>
+ * @author   Christian Weiske <cweiske@cweiske.de>
+ * @author   Eric Dane <ericdane@users.sourceforge.net>
+ * @license  GPL http://www.gnu.org/licenses/gpl.html
+ * @link     http://sourceforge.net/projects/semanticscuttle
+ */
 
 // Converts tags:
 // - direction = out: convert spaces to underscores;
@@ -48,7 +61,7 @@ function filter($data, $type = NULL) {
 function getPerPageCount($userObject = null)
 {
        global $defaultPerPage, $defaultPerPageForAdmins;
-       
+
        if (isset($defaultPerPageForAdmins)
         && $userObject != null && $userObject->isAdmin()
     ) {