Minor docblock tweaks. Also added some new constants that may or may not make it...
authorSam Boyer
Wed, 8 Oct 2008 00:13:18 +0000 (00:13 +0000)
committerSam Boyer
Wed, 8 Oct 2008 00:13:18 +0000 (00:13 +0000)
panels_page/panels_page.module

index 2b584f8..aa6338e 100644 (file)
@@ -35,6 +35,17 @@ define('PANELS_HAS_FALLBACK_ROUTER', 1 << 1 | PANELS_IS_DYNAMIC);
 define('PANELS_PID_SHARES_PATH', 1 << 2 | PANELS_IS_DYNAMIC);
 
 /**
+ * Indicates that the panel page is being loaded from code (i.e., from
+ * hook_default_panel_pages).
+ */
+define('PANELS_DEFAULT', 1 << 3);
+
+/**
+ * Indicates that the panel_page is an overridden default.
+ */
+define('PANELS_OVERRIDDEN', 1 << 4 | PANELS_DEFAULT);
+
+/**
  * Implementation of hook_help().
  */
 function panels_page_help($path, $arg) {
@@ -221,7 +232,7 @@ function panels_page_master_loader($args) {
  *
  * @param string $name
  * @param array $args
- * @return array $loader_data
+ * @return array $load
  */
 function _panels_page_master_loader($name, $args) {
   static $loader_data = array();
@@ -339,11 +350,11 @@ function _panels_page_rebuild_menu_map($load_objects, $positions) {
  * Prepare the fallback router, update the menu cache with it, then load up
  * our loader item and initiate fallback.
  *
- * Mostly lifted from menu_get_item().
+ * Partially lifted from menu_get_item().
  *
- * @param $load
- * @param $map
- * @return unknown_type
+ * @param object $load
+ * @param array $map
+ * @return object $load
  */
 function panels_page_prepare_fallback_render(&$load, $map) {
   $original_map = arg(NULL, $_GET['q']);
@@ -367,7 +378,7 @@ function panels_page_prepare_fallback_render(&$load, $map) {
  * Figure out if a panel is the current page; mostly useful in theming.
  *
  * This function will return NULL until panels_page_set_current() has been
- * properly called and loaded.
+ * called and loaded with data.
  */
 function panels_page_get_current() {
   // Take advantage of our .inc organization to know if it's at all possible