# HG changeset patch # User Tom Fredrik Blenning Klaussen # Date 1349999961 -7200 # Node ID 9d766788f0bc4a9b4cd39c935a28f58b5dc3b93d # Parent fae4322d6c298dfc1560eb9a059a78ac252c4cfd Fix remaining documentation errors. diff -r fae4322d6c29 -r 9d766788f0bc Flag.inc --- 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(); diff -r fae4322d6c29 -r 9d766788f0bc flag.php --- 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