From 1cbda1ce15651d75b4d73b51b583155f13170150 Mon Sep 17 00:00:00 2001
From: fbsanchez <fborja.sanchez@artica.es>
Date: Thu, 22 Jul 2021 11:06:40 +0200
Subject: [PATCH] Improved config.inc file content descriptions

---
 pandora_console/include/config.inc.php | 74 ++++++++++++++++----------
 1 file changed, 45 insertions(+), 29 deletions(-)

diff --git a/pandora_console/include/config.inc.php b/pandora_console/include/config.inc.php
index 30ab31b3e0..a3d5677729 100644
--- a/pandora_console/include/config.inc.php
+++ b/pandora_console/include/config.inc.php
@@ -1,38 +1,54 @@
 <?php
-// Pandora FMS - http://pandorafms.com
-// ==================================================
-// Copyright (c) 2005-2021 Artica Soluciones Tecnologicas
-//
-// This program is free software; you can redistribute it and/or
-// modify it under the terms of the  GNU Lesser General Public License
-// as published by the Free Software Foundation; version 2
-//
-// This program is distributed in the hope that it will be useful,
-// but WITHOUT ANY WARRANTY; without even the implied warranty of
-// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-// GNU General Public License for more details.
-
 /**
- * @package    Include
- * @subpackage Config
+ * Configuraton sample file.
+ *
+ * @category   Config
+ * @package    Pandora FMS
+ * @subpackage Community
+ * @version    1.0.0
+ * @license    See below
+ *
+ *    ______                 ___                    _______ _______ ________
+ *   |   __ \.-----.--.--.--|  |.-----.----.-----. |    ___|   |   |     __|
+ *  |    __/|  _  |     |  _  ||  _  |   _|  _  | |    ___|       |__     |
+ * |___|   |___._|__|__|_____||_____|__| |___._| |___|   |__|_|__|_______|
+ *
+ * ============================================================================
+ * Copyright (c) 2005-2021 Artica Soluciones Tecnologicas
+ * Please see http://pandorafms.org for full contribution list
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU General Public License
+ * as published by the Free Software Foundation for version 2.
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * ============================================================================
  */
 
-// Default values
-// $config["dbname"]="pandora";
-// $config["dbuser"]="pandora";
-// $config["dbpass"]="pandora";
-// $config["dbhost"]="localhost";
-// This is used for reporting, please add "/" character at the end
-// $config["homedir"]="/var/www/pandora_console/";
-// $config["homeurl"]="/pandora_console/";
-// $config["auth"]["scheme"] = "mysql";
-
-/**
- * Do not display any ERROR
+/*
+ * Default values
+ *   $config["dbname"]="pandora";
+ *   $config["dbuser"]="pandora";
+ *   $config["dbpass"]="pandora";
+ *   $config["dbhost"]="localhost";
+ *
+ *
+ * This is used for reporting, please add "/" character at the end
+ *   $config["homedir"]="/var/www/pandora_console/";
+ *   $config["homeurl"]="/pandora_console/";
+ *   $config["auth"]["scheme"] = "mysql";
  */
+
+// By default report any error but notices.
 error_reporting(E_ALL ^ E_NOTICE);
 
-// Display ALL errors
-// error_reporting(E_ERROR);
+/*
+ * Uncomment to display only critical errors.
+ *   error_reporting(E_ERROR);
+ * Uncomment to display none errors.
+ *   error_reporting(0);
+ */
+
 $ownDir = dirname(__FILE__).DIRECTORY_SEPARATOR;
 require $ownDir.'config_process.php';