From b532cc357559d0ff82218ce334b3648a1f78dacf Mon Sep 17 00:00:00 2001
From: Antoine Musso <hashar@users.mediawiki.org>
Date: Fri, 3 Sep 2004 01:05:32 +0000
Subject: [PATCH] Some documentation. Let's talk about it in wikitech-l.

---
 includes/DefaultSettings.php | 119 ++++++++++++++++++++++++++++++-----
 1 file changed, 104 insertions(+), 15 deletions(-)

diff --git a/includes/DefaultSettings.php b/includes/DefaultSettings.php
index 2b0a5dde4d..1a13e82444 100644
--- a/includes/DefaultSettings.php
+++ b/includes/DefaultSettings.php
@@ -1,6 +1,6 @@
 <?php
-# $Id$
 # DO NOT EDIT THIS FILE!
+
 /**
  * To customize your installation, edit "LocalSettings.php".
  *
@@ -8,16 +8,39 @@
  * before LocalSettings is included, if you localize something
  * like $wgScriptPath, you must also localize everything that
  * depends on it.
-*/
+ *
+ * @version $Id$
+ * @package MediaWiki
+ */
+
 # This is not a valid entry point, perform no further processing unless MEDIAWIKI is defined
 if( defined( 'MEDIAWIKI' ) ) {
 
+/**
+ * MediaWiki version number
+ * @global string $wgVersion
+ */
 $wgVersion			= '1.4-prealpha';
 
-$wgSitename         = 'MediaWiki'; # Please customize!
-$wgMetaNamespace    = FALSE; # will be same as you set $wgSitename
+/** 
+ * Name of the site.
+ * It must be changed in LocalSettings.php
+ * @global string $wgSiteName
+ */
+$wgSitename         = 'MediaWiki';
+
+/**
+ * Will be same as you set $wgSitename
+ * @global mixed $wgMetaNamespace
+ */
+$wgMetaNamespace    = FALSE;
 
 
+/** 
+ * URL of the server
+ * It will be automaticly build including https mode
+ * @global string $wgServer
+ */
 # check if server use https:
 $wgProto = (isset($_SERVER['HTTPS']) && $_SERVER['HTTPS'] == 'on') ? 'https' : 'http';
 
@@ -29,20 +52,50 @@ if ( @$wgCommandLineMode ) {
 }
 unset($wgProto);
 
+
+/**
+ * The path we should point to.
+ * It might be a virtual path in case with use apache mod_rewrite for example
+ * @global string $wgScriptPath
+ */
 $wgScriptPath	    = '/wiki';
 
-# Whether to support URLs like index.php/Page_title
+/**
+ * Whether to support URLs like index.php/Page_title
+ * @global bool $wgUsePathInfo
+ */
 $wgUsePathInfo		= ( strpos( php_sapi_name(), 'cgi' ) === false );
 
-# ATTN: Old installations used wiki.phtml and redirect.phtml -
-# make sure that LocalSettings.php is correctly set!
+
+/**#@+
+ * Script users will request to get articles
+ * ATTN: Old installations used wiki.phtml and redirect.phtml -
+ * make sure that LocalSettings.php is correctly set!
+ * @deprecated
+ */
+/** 
+ *	@global string $wgScript
+ */
 $wgScript           = "{$wgScriptPath}/index.php";
+/**
+ *	@global string $wgRedirectScript
+ */
 $wgRedirectScript   = "{$wgScriptPath}/redirect.php";
+/**#@-*/
 
 
-# Paths Settings
-# 
+/**#@+
+ * @global string
+ */
+/**
+ * style path as seen by users
+ * @global string $wgStylePath
+ */
 $wgStylePath   = "{$wgScriptPath}/style";
+/**
+ * filesystem stylesheets directory
+ * @global string $wgStyleDirectory
+ */
 $wgStyleDirectory = "{$IP}/style";
 $wgStyleSheetPath = &$wgStylePath;
 $wgStyleSheetDirectory = &$wgStyleDirectory;
@@ -53,26 +106,62 @@ $wgLogo				= "{$wgUploadPath}/wiki.png";
 $wgMathPath         = "{$wgUploadPath}/math";
 $wgMathDirectory    = "{$wgUploadDirectory}/math";
 $wgTmpDirectory     = "{$wgUploadDirectory}/tmp";
+/**#@-*/
 
 
 # Email settings
 #
+/**
+ * Site admin email address
+ * Default to wikiadmin@SERVER_NAME
+ * @global string $wgEmergencyContact
+ */
 $wgEmergencyContact = 'wikiadmin@' . getenv( 'SERVER_NAME' );
+/**
+ * Password reminder email address
+ * The address we should use as sender when a user is requesting his password
+ * Default to apache@SERVER_NAME
+ * @global string $wgPasswordSender
+ */
 $wgPasswordSender	= 'Wikipedia Mail <apache@' . getenv( 'SERVER_NAME' ) . '>';
 
-# For using a direct (authenticated) SMTP server connection.
-# "host" => 'SMTP domain', "IDHost" => 'domain for MessageID', "port" => "25", "auth" => true/false, "username" => user, "password" => password
+
+/**
+ * SMTP Mode
+ * For using a direct (authenticated) SMTP server connection. 
+ * Default to false or fill an array :
+ * <code>
+ * "host" => 'SMTP domain',
+ * "IDHost" => 'domain for MessageID',
+ * "port" => "25",
+ * "auth" => true/false,
+ * "username" => user,
+ * "password" => password
+ * </code>
+ *
+ * @global mixed $wgSMTP
+ */
 $wgSMTP				= false;
 
 
-# Database settings
-#
+/**#@+
+ * Database settings
+ */
+/** database host name or ip address */
 $wgDBserver         = 'localhost';
+/** name of the database */
 $wgDBname           = 'wikidb';
+/** */
 $wgDBconnection     = '';
+/** Database username */
 $wgDBuser           = 'wikiuser';
-$wgDBtype           = "mysql"; # "mysql" for working code and "PostgreSQL" for development/broken code
-$wgDBprefix         = ''; # Table name prefix
+/** Database type
+ * "mysql" for working code and "PostgreSQL" for development/broken code
+ */
+$wgDBtype           = "mysql";
+/** Table name prefix */
+$wgDBprefix         = ''; 
+/**#@-*/
 
 # Shared database for multiple wikis.
 # Presently used for storing a user table for single sign-on
-- 
2.20.1