Mercurial > SimpleWebPresenter

changeset 77:9d766788f0bc

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Fix remaining documentation errors.
author Tom Fredrik Blenning Klaussen <bfg@blenning.no>
date Fri, 12 Oct 2012 01:59:21 +0200
parents fae4322d6c29
children 9b490aa11124
files Flag.inc flag.php
diffstat 2 files changed, 16 insertions(+), 1 deletions(-) [+]
line wrap: on
line diff
--- a/Flag.inc	Fri Oct 12 01:54:51 2012 +0200
+++ b/Flag.inc	Fri Oct 12 01:59:21 2012 +0200
@@ -7,15 +7,25 @@
 
 include_once 'CacheTimeCheck.inc';
 
+/// @cond
 $scriptCache = ScriptIncludeCache::instance(__FILE__);
 $scriptCache->includeOnce('Language.inc');
 $scriptCache->includeOnce('common-functions.inc');
+/// @endcond
 
+/**
+ * Functionality for generating a flag based on state options
+ */
 class Flag {
   private $active;
   private $lang;
   private $cache;
 
+  /**
+   * Constructs a flag object
+   *
+   * @param $masterCache link this objects cache to this masterCache
+   */
   function __construct($masterCache)
   {
     $this->active = $_GET['active'];
@@ -44,6 +54,9 @@
     $this->cache->cache_time($this->name);
   }
 
+  /**
+   * Produce an apropriate response, eg cached or the actual content
+   */
   function getPage()
   {
     $this->cache->CheckHttpModified();
--- a/flag.php	Fri Oct 12 01:54:51 2012 +0200
+++ b/flag.php	Fri Oct 12 01:59:21 2012 +0200
@@ -7,8 +7,10 @@
 
 include_once 'CacheTimeCheck.inc';
 
+/// @cond
 $scriptCache = ScriptIncludeCache::instance(__FILE__);
 $scriptCache->includeOnce('Flag.inc');
 
 $flag = new Flag($scriptCache);
-print $flag->getPage();
\ No newline at end of file
+print $flag->getPage();
+/// @endcond
\ No newline at end of file