Add some code documentation skeletons and comment some methods/functions.

[Project_webapp.git] / index.php

diff --git a/index.php b/index.php
index 5c12c9e0477395dd88a9d26353b096dcd9e58440..33db471dab67fc5cf393608b7f00565ffa2f8f09 100644 (file)
--- a/index.php
+++ b/index.php
@@ -13,7 +13,7 @@ if (!isset($page)) {
 }
 
 /**
- * form MUST have an hidden field named 'form' to enable proper routing
+ * form MUST have an hidden field named 'form' to enable proper routing here
  */
 $form = filter_input(INPUT_POST, 'form', FILTER_SANITIZE_URL);
 $is_form = true;
@@ -24,6 +24,10 @@ if (!isset($form)) {
 
 //var_dump($_SESSION);
 
+/**
+ * [get_action_type description]
+ * @return [type] [description]
+ */
 function get_action_type() {
     global $is_page, $is_form;
 
@@ -38,6 +42,11 @@ function get_action_type() {
     }
 }
 
+/**
+ * [get_url_action description]
+ * @param  [type] $action_type [description]
+ * @return [type]              [description]
+ */
 function get_url_action($action_type) {
     global $page, $form;
 
@@ -72,6 +81,12 @@ function validate_url_action($action_name)
     return $configs['actions'][0];
 }
 
+/**
+ * [display_action description]
+ * @param  [type] $action_name [description]
+ * @param  [type] $action_type [description]
+ * @return [type]              [description]
+ */
 function display_action($action_name, $action_type)
 {
     global $configs;