From 82c0d2acc24a0b19de246c4f2c3d37a8e197d11e Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?Philip=20H=C3=A4usler?= <msquare@notrademark.de>
Date: Tue, 7 Jan 2014 16:19:35 +0100
Subject: [PATCH] controller comments

---
 includes/controller/angeltypes_controller.php |  9 ++++++++
 .../controller/user_angeltypes_controller.php | 21 +++++++++++++++++++
 includes/controller/users_controller.php      |  3 +++
 3 files changed, 33 insertions(+)

diff --git a/includes/controller/angeltypes_controller.php b/includes/controller/angeltypes_controller.php
index 8b1783f2..fbbdbb84 100644
--- a/includes/controller/angeltypes_controller.php
+++ b/includes/controller/angeltypes_controller.php
@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * Text for Angeltype related links.
+ */
 function angeltypes_title() {
   return _("Angeltypes");
 }
@@ -32,6 +35,9 @@ function angeltypes_controller() {
   );
 }
 
+/**
+ * Delete an Angeltype.
+ */
 function angeltype_delete_controller() {
   global $privileges, $user;
   
@@ -60,6 +66,9 @@ function angeltype_delete_controller() {
   );
 }
 
+/**
+ * Change an Angeltype.
+ */
 function angeltype_edit_controller() {
   global $privileges, $user;
   
diff --git a/includes/controller/user_angeltypes_controller.php b/includes/controller/user_angeltypes_controller.php
index b2a04a17..62987c78 100644
--- a/includes/controller/user_angeltypes_controller.php
+++ b/includes/controller/user_angeltypes_controller.php
@@ -1,5 +1,8 @@
 <?php
 
+/**
+ * Remove all unconfirmed users from a specific angeltype.
+ */
 function user_angeltypes_delete_all_controller() {
   global $user, $privileges;
   
@@ -37,6 +40,9 @@ function user_angeltypes_delete_all_controller() {
   );
 }
 
+/**
+ * Confirm all unconfirmed users for an angeltype.
+ */
 function user_angeltypes_confirm_all_controller() {
   global $user, $privileges;
   
@@ -74,6 +80,9 @@ function user_angeltypes_confirm_all_controller() {
   );
 }
 
+/**
+ * Confirm an user for an angeltype.
+ */
 function user_angeltype_confirm_controller() {
   global $user, $privileges;
   
@@ -127,6 +136,9 @@ function user_angeltype_confirm_controller() {
   );
 }
 
+/**
+ * Remove a user from an Angeltype.
+ */
 function user_angeltype_delete_controller() {
   global $user, $privileges;
   
@@ -182,10 +194,16 @@ function user_angeltype_delete_controller() {
   );
 }
 
+/**
+ * Update an UserAngelType.
+ */
 function user_angeltype_update_controller() {
 
 }
 
+/**
+ * User joining an Angeltype (Or Coordinator doing this for him).
+ */
 function user_angeltype_add_controller() {
   global $user, $privileges;
   
@@ -236,6 +254,9 @@ function user_angeltype_add_controller() {
   );
 }
 
+/**
+ * Route UserAngelType actions.
+ */
 function user_angeltypes_controller() {
   if (! isset($_REQUEST['action']))
     redirect(page_link_to('angeltypes'));
diff --git a/includes/controller/users_controller.php b/includes/controller/users_controller.php
index 8e0aace7..c5c437ca 100644
--- a/includes/controller/users_controller.php
+++ b/includes/controller/users_controller.php
@@ -77,6 +77,9 @@ function user_password_recovery_controller() {
   }
 }
 
+/**
+ * Menu title for password recovery.
+ */
 function user_password_recovery_title() {
   return _("Password recovery");
 }