com phpruntests: Added missing Docblock and added tags to conform with PEAR CS.: src/rtText.php
| From: | David Soria Parra | Date: | Sat, 25 Apr 2009 14:26:43 +0000 |
| Subject: | com phpruntests: Added missing Docblock and added tags to conform with PEAR CS.: src/rtText.php | ||
| Groups: | php.qa | ||
| Request: | Send a blank email to php-qa+get-66528@lists.php.net to get a copy of this message | ||
Commit: 497a4f0ac2aaf41661e2c132ea51a04166bd3a58
Author: Stefan Priebsch <spriebsch@php.net> Sat, 25 Apr 2009 14:26:43 +0000
Parents: 677d4c209a552ae9a6b7152b9bafc0c9df3e23e8
Branches: master
Link: http://git.php.net/?p=phpruntests.git;a=commitdiff;h=497a4f0ac2aaf41661e2c132ea51a04166bd3a58
Log:
Added missing Docblock and added tags to conform with PEAR CS.
Changed paths:
M src/rtText.php
Diff:
diff --git a/src/rtText.php b/src/rtText.php
index 616cd17..06580de 100644
--- a/src/rtText.php
+++ b/src/rtText.php
@@ -1,6 +1,29 @@
<?php
/**
- * rtText reads named texts from texts/ subdirectory.
+ * rtText
+ *
+ * @category Testing
+ * @package RUNTESTS
+ * @author Zoe Slattery <zoe@php.net>
+ * @author Stefan Priebsch <spriebsch@php.net>
+ * @copyright 2009 The PHP Group
+ * @license http://www.php.net/license/3_01.txt
PHP License 3.01
+ * @link http://qa.php.net/
+ */
+
+/**
+ * Reads texts stored in texts/ subdirectory
+ *
+ * rtText reads named texts from texts/ subdirectory
+ * optionally replacing %n placeholders.
+ *
+ * @category Testing
+ * @package RUNTESTS
+ * @author Zoe Slattery <zoe@php.net>
+ * @author Stefan Priebsch <spriebsch@php.net>
+ * @copyright 2009 The PHP Group
+ * @license http://www.php.net/license/3_01.txt
PHP License 3.01
+ * @link http://qa.php.net/
*/
class rtText
{
@@ -10,9 +33,10 @@ class rtText
*
* @param string $name Text name to return
* @param array $replacements Placeholder replacements
+ *
* @return string
*/
- public static function get($name, array $replacements = array())
+ public static function get($name, $replacements = array())
{
$filename = dirname(__FILE__) . '/texts/' . $name . '.txt';