Refs #2450: Documented handler files.

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

1 files changed, 13 insertions, 9 deletions

diff --git a/engine/handlers/pagehandler.php b/engine/handlers/pagehandler.php
index 2e98c071a..a92c2f408 100644
--- a/engine/handlers/pagehandler.php
+++ b/engine/handlers/pagehandler.php
@@ -1,23 +1,27 @@
 <?php
 /**
- * Elgg page handler
+ * Pages handler.
  *
- * If page_handler() fails, send to front page.
+ * This file dispatches pages.  It is called via a URL rewrite in .htaccess
+ * from http://site/pg/handler/page1/page2.  The first element after 'pg/' is
+ * the page handler name as registered by {@link register_page_handler()}.
+ * The rest of the string is sent to {@link page_handler()}.
  *
- * @package Elgg
- * @subpackage Core
- * @author Curverider Ltd
- * @link http://elgg.org/
+ * {@link page_handler()} explodes the pages string by / and sends it to
+ * the page handler function as registered by {@link register_page_handler()}.
+ * If a valid page handler isn't found, the user will be forwarded to the site
+ * front page.
+ *
+ * @package Elgg.Core
+ * @subpackage PageHandler
+ * @link http://docs.elgg.org/Tutorials/PageHandlers
  */
 
-// Load Elgg engine
 require_once("../start.php");
 
-// Get input
 $handler = get_input('handler');
 $page = get_input('page');
 
-// Call the page handler functions
 if (!page_handler($handler, $page)) {
 	forward();
 }
\ No newline at end of file