Refs #2450: Documented handler files.

git-svn-id: http://code.elgg.org/elgg/trunk@6942 36083f99-b078-4883-b0ff-0f9b5a30f544

1 files changed, 10 insertions, 9 deletions

diff --git a/engine/handlers/cron_handler.php b/engine/handlers/cron_handler.php
index a86cf7f4c..537b34f39 100644
--- a/engine/handlers/cron_handler.php
+++ b/engine/handlers/cron_handler.php
@@ -1,18 +1,21 @@
 <?php
 /**
- * Elgg Cron handler.
+ * Cron handlers
  *
- * @package Elgg
- * @subpackage Core
- * @author Curverider Ltd
- * @link http://elgg.org/
+ * This file dispatches cron actions.  It is called via a URL rewrite in .htaccess
+ * from http://site/p/.  Anything after 'action/' is considered the action
+ * and will be passed to {@link action()}.
+ *
+ * @package Elgg.Core
+ * @subpackage Actions
+ * @link http://docs.elgg.org/Tutorials/Actions
+ *
+ * @todo
  */
 
-// Load Elgg engine
 require_once("../start.php");
 global $CONFIG;
 
-// Get basic parameters
 $period = get_input('period');
 if (!$period) {
 	throw new CronException(sprintf(elgg_echo('CronException:unknownperiod'), $period));
@@ -26,8 +29,6 @@ foreach ($CONFIG->input as $k => $v) {
 	$params[$k] = $v;
 }
 
-// Trigger hack
-
 // Data to return to
 $std_out = "";
 $old_stdout = "";