Welcome to mirror list, hosted at ThFree Co, Russian Federation.

github.com/matomo-org/matomo.git - Unnamed repository; edit this file 'description' to name the repository.
summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authordiosmosis <benakamoorthi@fastmail.fm>2013-12-08 06:36:27 +0400
committerdiosmosis <benakamoorthi@fastmail.fm>2013-12-08 06:36:27 +0400
commit4cafa9e3c79051476c54ad81a3e73e7242e7775a (patch)
tree431054418bf63b5094e5c4be961ab420278d289e /core/SettingsServer.php
parent87d676dbff31adb4c1cf389cd66511434ab925ab (diff)
Refs #4200 revised some of class/method docs.
Diffstat (limited to 'core/SettingsServer.php')
-rw-r--r--core/SettingsServer.php19
1 files changed, 10 insertions, 9 deletions
diff --git a/core/SettingsServer.php b/core/SettingsServer.php
index c43b1f9502..0e6baf131d 100644
--- a/core/SettingsServer.php
+++ b/core/SettingsServer.php
@@ -12,14 +12,15 @@ namespace Piwik;
/**
* Contains helper methods that can be used to get information regarding the
- * server, its settings and PHP settings.
+ * server, its settings and currently used PHP settings.
*
* @package Piwik
*/
class SettingsServer
{
/**
- * Returns true if the current script execution was triggered misc/cron/archive.php.
+ * Returns true if the current script execution was triggered by the cron archiving
+ * script (**misc/cron/archive.php**).
*
* Helpful for error handling: directly throw error without HTML (eg. when DB is down).
*
@@ -33,7 +34,7 @@ class SettingsServer
}
/**
- * Returns true if running on Microsoft IIS 7 (or above), false if otherwise.
+ * Returns `true` if running on Microsoft IIS 7 (or above), `false` if otherwise.
*
* @return bool
* @api
@@ -48,7 +49,7 @@ class SettingsServer
}
/**
- * Returns true if running on an Apache web server, false if otherwise.
+ * Returns `true` if running on an Apache web server, `false` if otherwise.
*
* @return bool
* @api
@@ -62,7 +63,7 @@ class SettingsServer
}
/**
- * Returns true if running on a Windows operating system, false if otherwise.
+ * Returns `true` if running on a Windows operating system, `false` if otherwise.
*
* @since 0.6.5
* @return bool
@@ -74,8 +75,8 @@ class SettingsServer
}
/**
- * Returns true if this php version/build supports timezone manipulation
- * (e.g., php >= 5.2, or compiled with EXPERIMENTAL_DATE_SUPPORT=1 for
+ * Returns `true` if this PHP version/build supports timezone manipulation
+ * (e.g., php >= 5.2, or compiled with **EXPERIMENTAL_DATE_SUPPORT=1** for
* php < 5.2).
*
* @return bool
@@ -92,9 +93,9 @@ class SettingsServer
}
/**
- * Returns true if the GD PHP extension is available, false if otherwise.
+ * Returns `true` if the GD PHP extension is available, `false` if otherwise.
*
- * ImageGraph and sparklines depend on the GD extension.
+ * _Note: ImageGraph and the sparkline report visualization depend on the GD extension._
*
* @return bool
* @api