From: garvinhicking <garvinhicking>
Date: Tue, 5 Jun 2007 07:58:47 +0000 (+0000)
Subject: Beautify, add missing code comments
X-Git-Url: http://git.mjollnir.org/gw?a=commitdiff_plain;h=44ee7243e37b15c0fc7dba90f40aa4f01d0c7737;p=s9y.git

Beautify, add missing code comments
---

diff --git a/include/functions_config.inc.php b/include/functions_config.inc.php
index d731454..f9dcb83 100644
--- a/include/functions_config.inc.php
+++ b/include/functions_config.inc.php
@@ -460,6 +460,9 @@ function serendipity_checkAutologin($ident, $iv) {
     return $cookie;
 }
 
+/**
+ * Set a session cookie which can identify a user accross http/https boundaries
+ */
 function serendipity_setAuthorToken() {
     $hash = sha1(uniqid(rand(), true));
     serendipity_setCookie('author_token', $hash);
@@ -1950,6 +1953,13 @@ function serendipity_setFormToken($type = 'form') {
     }
 }
 
+/**
+ * Load available/configured options for a specific theme (through config.inc.php of a template directory)
+ * into an array.
+ *
+ * @param   array   Referenced variable coming from the config.inc.php file, where the config values will be stored in
+ * @return  array   Final return array with default values
+ */
 function &serendipity_loadThemeOptions(&$template_config) {
     global $serendipity;
     $_template_vars =& serendipity_db_query("SELECT name, value FROM {$serendipity['dbPrefix']}options
@@ -1969,6 +1979,13 @@ function &serendipity_loadThemeOptions(&$template_config) {
     return $template_vars;
 }
 
+/**
+ * Check if a member of a group has permissions to execute a plugin
+ *
+ * @param string    Pluginname
+ * @param int       ID of the group of which the members should be checked
+ * @return boolean
+ */
 function serendipity_hasPluginPermissions($plugin, $groupid = null) {
     static $forbidden = null;
     global $serendipity;
diff --git a/include/functions_entries.inc.php b/include/functions_entries.inc.php
index f5d350e..673f5c1 100644
--- a/include/functions_entries.inc.php
+++ b/include/functions_entries.inc.php
@@ -952,17 +952,15 @@ function serendipity_printEntries($entries, $extended = 0, $preview = false, $sm
                 $entry['is_cached'] = true;
             }
 
-	    //--JAM: Highlight-span search terms
-	    if ($serendipity['action'] == 'search') {
-	        $searchterms = str_replace('"', '', $serendipity['GET']['searchterms']);
-	        $searchterms = explode($searchterms, ' ');
-		foreach($searchterms as $searchdx => $searchterm) {
-		    $searchclass = "foundterm foundterm".$searchdx;
-		    $entry['body'] = preg_replace('/('.$searchterm.')/mi',
-		        '<span class="'.$searchclass.'">\1</span>',
-			$entry['body']);
-		}
-	    }
+            //--JAM: Highlight-span search terms
+            if ($serendipity['action'] == 'search') {
+                $searchterms = str_replace('"', '', $serendipity['GET']['searchterms']);
+                $searchterms = explode($searchterms, ' ');
+                foreach($searchterms as $searchdx => $searchterm) {
+                    $searchclass = "foundterm foundterm".$searchdx;
+                    $entry['body'] = preg_replace('/('.$searchterm.')/mi', '<span class="'.$searchclass.'">\1</span>', $entry['body']);
+                }
+            }
 
             if (!empty($entry['properties']['ep_cache_extended'])) {
                 $entry['extended']  = &$entry['properties']['ep_cache_extended'];