r71346 MediaWiki - Code Review archive

Repository:MediaWiki
Revision:r71345‎ | r71346 | r71347 >
Date:10:55, 20 August 2010
Author:nikerabbit
Status:ok
Tags:
Comment:
Docu fixes
Modified paths:
  • /trunk/extensions/Translate/ffs/OpenLayers.php (modified) (history)
  • /trunk/extensions/Translate/ffs/PhpVariables.php (modified) (history)

Diff [purge]

Index: trunk/extensions/Translate/ffs/PhpVariables.php
@@ -4,7 +4,7 @@
55 *
66 * @author Niklas Laxström
77 * @author Siebrand Mazeland
8 - * @copyright Copyright © 2008, Niklas Laxström, Siebrand Mazeland
 8+ * @copyright Copyright © 2008-2010, Niklas Laxström, Siebrand Mazeland
99 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
1010 * @file
1111 */
@@ -20,10 +20,8 @@
2121 /**
2222 * Reads all \@author tags from the file and returns array of authors.
2323 *
24 - * @param $filename From which file to get the authors.
2524 * @return Array of authors.
26 - *
27 - * FIXME: possible to refactor to reduce duplication? (copy from Wiki.php)
 25+ * @todo Possible to refactor to reduce duplication? (copy from Wiki.php)
2826 */
2927 public function parseAuthors() {
3028 if ( $this->filename === false ) {
@@ -42,7 +40,7 @@
4341 * Basically the same, with different author prefix and separator between
4442 * headers and messages.
4543 *
46 - * FIXME: possible to refactor to reduce duplication?
 44+ * @todo Possible to refactor to reduce duplication?
4745 */
4846 protected function parseHeader() {
4947 $authors = array();
Index: trunk/extensions/Translate/ffs/OpenLayers.php
@@ -5,6 +5,7 @@
66 * @author Robert Leverington
77 * @copyright Copyright © 2009 Robert Leverington
88 * @license http://www.gnu.org/copyleft/gpl.html GNU General Public License 2.0 or later
 9+ * @file
910 */
1011
1112 class OpenLayersFormatReader extends SimpleFormatReader {
@@ -41,19 +42,20 @@
4243 private function leftTrim( $string ) {
4344 $string = ltrim( $string );
4445 $string = ltrim( $string, '"' );
45 -
4646 return $string;
4747 }
4848
4949 /**
5050 * Parse OpenLayer JavaScript language class.
51 - * Known issues:
 51+ *
 52+ * @param $mangler StringMangler
 53+ * @return \array Messages from the file.
 54+ *
 55+ * @todo Known issues:
5256 * - It is a requirement for key names to be enclosed in single
5357 * quotation marks, and for messages to be enclosed in double.
5458 * - The last key-value pair must have a comma at the end.
5559 * - Uses seperate $this->leftTrim() function, this is undersired.
56 - * @params $mangler StringMangler
57 - * @return Array: Messages from file.
5860 */
5961 public function parseMessages( StringMangler $mangler ) {
6062 $data = file_get_contents( $this->filename );
@@ -110,6 +112,7 @@
111113 }
112114
113115 class OpenLayersFormatWriter extends SimpleFormatWriter {
 116+
114117 /**
115118 * Export a languages messages.
116119 * @param $target File handler.

Status & tagging log