From 4dcb60b4e72b50c84f581b19ee83f77f18db3c49 Mon Sep 17 00:00:00 2001
From: Benjamin Sonntag <benjamin@sonntag.fr>
Date: Mon, 9 Oct 2017 20:56:03 +0200
Subject: [PATCH] [cosm] many cosmetic comment fixes, + ensure license and
 copyright everywhere

---
 bureau/admin/mail_list.php            | 12 ++++++------
 bureau/admin/mail_manage_catchall.php | 15 ++++++++-------
 bureau/admin/mail_undelete.php        | 13 +++++++------
 bureau/admin/main.php                 | 15 ++++++++-------
 bureau/admin/mem_admin.php            | 15 +++++++--------
 bureau/admin/mem_chgmail.php          | 18 +++++++-----------
 bureau/admin/mem_cm.php               | 17 ++++++-----------
 bureau/admin/mem_cm2.php              | 17 ++++++-----------
 bureau/admin/mem_logout.php           | 18 +++++++-----------
 bureau/admin/mem_param.php            | 18 +++++++-----------
 bureau/admin/mem_passwd.php           | 18 +++++++-----------
 bureau/admin/menu.php                 | 18 +++++++-----------
 bureau/admin/piwik_user_dodel.php     |  4 ++++
 bureau/admin/piwik_useradmin.php      |  7 ++++++-
 14 files changed, 93 insertions(+), 112 deletions(-)

diff --git a/bureau/admin/mail_list.php b/bureau/admin/mail_list.php
index 225bbf56..aa984d3f 100755
--- a/bureau/admin/mail_list.php
+++ b/bureau/admin/mail_list.php
@@ -1,9 +1,5 @@
 <?php
 /*
- ----------------------------------------------------------------------
- AlternC - Web Hosting System
- Copyright (C) 2000-2012 by the AlternC Development Team.
- https://alternc.org/
  ----------------------------------------------------------------------
  LICENSE
 
@@ -19,10 +15,14 @@
 
  To read the license please visit http://www.gnu.org/copyleft/gpl.html
  ----------------------------------------------------------------------
- Purpose of file: listing of mail accounts for one domain.
- ----------------------------------------------------------------------
 */
 
+/**
+ * List the email account of a domain 
+ *
+ * @copyright AlternC-Team 2000-2017 https://alternc.com/
+ */
+
 require_once("../class/config.php");
 include_once("head.php");
 
diff --git a/bureau/admin/mail_manage_catchall.php b/bureau/admin/mail_manage_catchall.php
index 969c88ab..5551d110 100644
--- a/bureau/admin/mail_manage_catchall.php
+++ b/bureau/admin/mail_manage_catchall.php
@@ -1,9 +1,5 @@
 <?php
 /*
- ----------------------------------------------------------------------
- AlternC - Web Hosting System
- Copyright (C) 2000-2012 by the AlternC Development Team.
- https://alternc.org/
  ----------------------------------------------------------------------
  LICENSE
 
@@ -19,10 +15,15 @@
 
  To read the license please visit http://www.gnu.org/copyleft/gpl.html
  ----------------------------------------------------------------------
- Purpose of file: Manage catch-all
- ----------------------------------------------------------------------
 */
-require_once("../class/config.php");
+
+/**
+ * Manages the catch-all account of a domain for a user 
+ * 
+ * @copyright AlternC-Team 2000-2017 https://alternc.com/
+ */ 
+
+ require_once("../class/config.php");
 include_once("head.php");
 
 $fields = array (
diff --git a/bureau/admin/mail_undelete.php b/bureau/admin/mail_undelete.php
index 55a394f2..513cb1ec 100644
--- a/bureau/admin/mail_undelete.php
+++ b/bureau/admin/mail_undelete.php
@@ -1,9 +1,5 @@
 <?php
 /*
- ----------------------------------------------------------------------
- AlternC - Web Hosting System
- Copyright (C) 2000-2012 by the AlternC Development Team.
- https://alternc.org/
  ----------------------------------------------------------------------
  LICENSE
 
@@ -19,9 +15,14 @@
 
  To read the license please visit http://www.gnu.org/copyleft/gpl.html
  ----------------------------------------------------------------------
- Purpose of file: undelete one mailbox
- ----------------------------------------------------------------------
 */
+
+/**
+ * Undelete a user's mailbox
+ * 
+ * @copyright AlternC-Team 2000-2017 https://alternc.com/
+ */
+
 require_once("../class/config.php");
 
 $fields = array (
diff --git a/bureau/admin/main.php b/bureau/admin/main.php
index 54f69297..4e75df6c 100644
--- a/bureau/admin/main.php
+++ b/bureau/admin/main.php
@@ -1,10 +1,5 @@
 <?php
 /*
- main.php
- ----------------------------------------------------------------------
- AlternC - Web Hosting System
- Copyright (C) 2002-2017 by the AlternC Development Team.
- https://alternc.com/
  ----------------------------------------------------------------------
  LICENSE
 
@@ -20,9 +15,15 @@
 
  To read the license please visit http://www.gnu.org/copyleft/gpl.html
  ----------------------------------------------------------------------
- Purpose of file: Main page shown after login, display misc information
- ----------------------------------------------------------------------
 */
+
+/**
+ * Main page shown after a successful login of an account
+ * Displays misc informations
+ * 
+ * @copyright AlternC-Team 2000-2017 https://alternc.com/
+ */
+
 require_once("../class/config.php");
 
 include_once("head.php");
diff --git a/bureau/admin/mem_admin.php b/bureau/admin/mem_admin.php
index c9ce0525..a7e210bc 100644
--- a/bureau/admin/mem_admin.php
+++ b/bureau/admin/mem_admin.php
@@ -1,10 +1,5 @@
 <?php
 /*
- mem_admin.php
- ----------------------------------------------------------------------
- AlternC - Web Hosting System
- Copyright (C) 2002-2017 by the AlternC Development Team.
- https://alternc.com/
  ----------------------------------------------------------------------
  LICENSE
 
@@ -20,10 +15,14 @@
 
  To read the license please visit http://www.gnu.org/copyleft/gpl.html
  ----------------------------------------------------------------------
- Original Author of file: Benjamin Sonntag <benjamin@octopuce.com>
- Purpose of file: Manage administrators preferences
- ----------------------------------------------------------------------
 */
+
+/**
+ * Change the administrator's account preferences
+ * 
+ * @copyright AlternC-Team 2000-2017 https://alternc.com/
+ */
+
 require_once("../class/config.php");
 
 $fields = array (
diff --git a/bureau/admin/mem_chgmail.php b/bureau/admin/mem_chgmail.php
index a13a1d87..659a6d9f 100644
--- a/bureau/admin/mem_chgmail.php
+++ b/bureau/admin/mem_chgmail.php
@@ -1,13 +1,5 @@
 <?php
 /*
- $Id: mem_chgmail.php,v 1.3 2003/06/10 08:18:26 root Exp $
- ----------------------------------------------------------------------
- AlternC - Web Hosting System
- Copyright (C) 2002 by the AlternC Development Team.
- http://alternc.org/
- ----------------------------------------------------------------------
- Based on:
- Valentin Lacambre's web hosting softwares: http://altern.org/
  ----------------------------------------------------------------------
  LICENSE
 
@@ -23,10 +15,14 @@
 
  To read the license please visit http://www.gnu.org/copyleft/gpl.html
  ----------------------------------------------------------------------
- Original Author of file:  Benjamin Sonntag
- Purpose of file: Change the email of a member step 1.
- ----------------------------------------------------------------------
 */
+
+/**
+ * Changes the email of an account, STEP 1
+ * 
+ * @copyright AlternC-Team 2000-2017 https://alternc.com/
+ */
+
 require_once("../class/config.php");
 
 $fields = array (
diff --git a/bureau/admin/mem_cm.php b/bureau/admin/mem_cm.php
index 23e95a3a..caf01a20 100644
--- a/bureau/admin/mem_cm.php
+++ b/bureau/admin/mem_cm.php
@@ -1,13 +1,5 @@
 <?php
 /*
- $Id: mem_cm.php,v 1.6 2004/11/29 17:27:04 anonymous Exp $
- ----------------------------------------------------------------------
- AlternC - Web Hosting System
- Copyright (C) 2002 by the AlternC Development Team.
- http://alternc.org/
- ----------------------------------------------------------------------
- Based on:
- Valentin Lacambre's web hosting softwares: http://altern.org/
  ----------------------------------------------------------------------
  LICENSE
 
@@ -23,11 +15,14 @@
 
  To read the license please visit http://www.gnu.org/copyleft/gpl.html
  ----------------------------------------------------------------------
- Original Author of file:  Benjamin Sonntag
- Purpose of file: Change the email of a member step 2.
- ----------------------------------------------------------------------
 */
 
+/**
+ * Change the email of an account, STEP 2
+ *
+ * @copyright AlternC-Team 2000-2017 https://alternc.com/
+ */
+
 require_once("../class/config_nochk.php");
 include_once("head.php");
 
diff --git a/bureau/admin/mem_cm2.php b/bureau/admin/mem_cm2.php
index d4f44ed5..77dc44de 100644
--- a/bureau/admin/mem_cm2.php
+++ b/bureau/admin/mem_cm2.php
@@ -1,13 +1,5 @@
 <?php
 /*
- $Id: mem_cm2.php,v 1.5 2004/11/29 17:27:04 anonymous Exp $
- ----------------------------------------------------------------------
- AlternC - Web Hosting System
- Copyright (C) 2002 by the AlternC Development Team.
- http://alternc.org/
- ----------------------------------------------------------------------
- Based on:
- Valentin Lacambre's web hosting softwares: http://altern.org/
  ----------------------------------------------------------------------
  LICENSE
 
@@ -23,11 +15,14 @@
 
  To read the license please visit http://www.gnu.org/copyleft/gpl.html
  ----------------------------------------------------------------------
- Original Author of file:  Benjamin Sonntag
- Purpose of file: Change the email of a member step 3.
- ----------------------------------------------------------------------
 */
 
+/**
+ * Change the email of an account, STEP 3
+ *
+ * @copyright AlternC-Team 2000-2017 https://alternc.com/
+ */
+
 require_once("../class/config_nochk.php");
 
 $fields = array (
diff --git a/bureau/admin/mem_logout.php b/bureau/admin/mem_logout.php
index e0f63b6d..d7c4b9bf 100644
--- a/bureau/admin/mem_logout.php
+++ b/bureau/admin/mem_logout.php
@@ -1,13 +1,5 @@
 <?php
 /*
- $Id: mem_logout.php,v 1.3 2003/08/13 23:52:24 root Exp $
- ----------------------------------------------------------------------
- AlternC - Web Hosting System
- Copyright (C) 2002 by the AlternC Development Team.
- http://alternc.org/
- ----------------------------------------------------------------------
- Based on:
- Valentin Lacambre's web hosting softwares: http://altern.org/
  ----------------------------------------------------------------------
  LICENSE
 
@@ -23,10 +15,14 @@
 
  To read the license please visit http://www.gnu.org/copyleft/gpl.html
  ----------------------------------------------------------------------
- Original Author of file:
- Purpose of file:
- ----------------------------------------------------------------------
 */
+
+/**
+ * Logout a member.
+ * 
+ * @copyright AlternC-Team 2000-2017 https://alternc.com/
+ */
+
 require_once("../class/config.php");
 
 $mem->del_session();
diff --git a/bureau/admin/mem_param.php b/bureau/admin/mem_param.php
index 2cb218c3..97ee6cec 100755
--- a/bureau/admin/mem_param.php
+++ b/bureau/admin/mem_param.php
@@ -1,13 +1,5 @@
 <?php
 /*
- $Id: mem_param.php,v 1.8 2004/07/23 14:03:57 anonymous Exp $
- ----------------------------------------------------------------------
- AlternC - Web Hosting System
- Copyright (C) 2002 by the AlternC Development Team.
- http://alternc.org/
- ----------------------------------------------------------------------
- Based on:
- Valentin Lacambre's web hosting softwares: http://altern.org/
  ----------------------------------------------------------------------
  LICENSE
 
@@ -23,10 +15,14 @@
 
  To read the license please visit http://www.gnu.org/copyleft/gpl.html
  ----------------------------------------------------------------------
- Original Author of file:  Benjamin Sonntag
- Purpose of file: Allow the customization of the user interface
- ----------------------------------------------------------------------
 */
+
+/**
+ * Customize the user's interface of AlternC
+ * 
+ * @copyright AlternC-Team 2000-2017 https://alternc.com/
+ */
+
 require_once("../class/config.php");
 
 include_once("head.php");
diff --git a/bureau/admin/mem_passwd.php b/bureau/admin/mem_passwd.php
index 0dc960b2..c160ae8d 100644
--- a/bureau/admin/mem_passwd.php
+++ b/bureau/admin/mem_passwd.php
@@ -1,13 +1,5 @@
 <?php
 /*
- $Id: mem_passwd.php,v 1.1.1.1 2003/03/26 17:41:29 root Exp $
- ----------------------------------------------------------------------
- AlternC - Web Hosting System
- Copyright (C) 2002 by the AlternC Development Team.
- http://alternc.org/
- ----------------------------------------------------------------------
- Based on:
- Valentin Lacambre's web hosting softwares: http://altern.org/
  ----------------------------------------------------------------------
  LICENSE
 
@@ -23,10 +15,14 @@
 
  To read the license please visit http://www.gnu.org/copyleft/gpl.html
  ----------------------------------------------------------------------
- Original Author of file:
- Purpose of file:
- ----------------------------------------------------------------------
 */
+
+/**
+ * Changes a user account's password
+ *
+ * @copyright AlternC-Team 2000-2017 https://alternc.com/
+ */
+
 require_once("../class/config.php");
 
 $fields = array (
diff --git a/bureau/admin/menu.php b/bureau/admin/menu.php
index bab8291e..95454167 100644
--- a/bureau/admin/menu.php
+++ b/bureau/admin/menu.php
@@ -1,13 +1,5 @@
 <?php
 /*
- $Id: menu.php,v 1.9 2005/01/18 22:16:10 anarcat Exp $
- ----------------------------------------------------------------------
- AlternC - Web Hosting System
- Copyright (C) 2002 by the AlternC Development Team.
- http://alternc.org/
- ----------------------------------------------------------------------
- Based on:
- Valentin Lacambre's web hosting softwares: http://altern.org/
  ----------------------------------------------------------------------
  LICENSE
 
@@ -23,10 +15,14 @@
 
  To read the license please visit http://www.gnu.org/copyleft/gpl.html
  ----------------------------------------------------------------------
- Original Author of file:
- Purpose of file:
- ----------------------------------------------------------------------
 */
+
+/**
+ * Main left menu of AlternC, uses Hooks 
+ * 
+ * @copyright AlternC-Team 2000-2017 https://alternc.com/
+ */
+
 require_once("../class/config.php");
 
 // Getting logo
diff --git a/bureau/admin/piwik_user_dodel.php b/bureau/admin/piwik_user_dodel.php
index 6d3a1481..8df53fba 100755
--- a/bureau/admin/piwik_user_dodel.php
+++ b/bureau/admin/piwik_user_dodel.php
@@ -17,6 +17,10 @@
  ----------------------------------------------------------------------
 */
 
+/**
+ * delete piwik users
+ * @copyright AlternC-Team 2000-2017 https://alternc.com/
+ */
 require_once("../class/config.php");
 
 $fields = array (
diff --git a/bureau/admin/piwik_useradmin.php b/bureau/admin/piwik_useradmin.php
index 71915bb6..b5fab077 100755
--- a/bureau/admin/piwik_useradmin.php
+++ b/bureau/admin/piwik_useradmin.php
@@ -17,7 +17,12 @@
  ----------------------------------------------------------------------
 */
 
-require_once("../class/config.php");
+/**
+ * Manages piwik user accounts
+ * @copyright AlternC-Team 2000-2017 https://alternc.com/
+ */
+
+ require_once("../class/config.php");
 include_once("head.php");
 
 $fields = array (