From aa72c4e0d27430ad4cd7781b508e80b165f73a4c Mon Sep 17 00:00:00 2001 From: m4tx Date: Fri, 2 Jan 2015 22:46:37 +0100 Subject: [PATCH] Add missing documentation in DateFormatter.php Change-Id: Ic5c04bdb88bc57a7c44159d7858ef791c24354c4 --- includes/parser/DateFormatter.php | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/includes/parser/DateFormatter.php b/includes/parser/DateFormatter.php index 82f0e9d48f..3db8d1e6fe 100644 --- a/includes/parser/DateFormatter.php +++ b/includes/parser/DateFormatter.php @@ -315,8 +315,8 @@ class DateFormatter { } /** - * @todo document - * @return string + * Return a regex that can be used to find month names in string + * @return string regex to find the months with */ public function getMonthRegex() { $names = array(); @@ -338,7 +338,7 @@ class DateFormatter { } /** - * @todo document + * Make an ISO year from a year name, for instance: '-1199' from '1200 BC' * @param string $year Year name * @return string ISO year name */ @@ -356,9 +356,10 @@ class DateFormatter { } /** - * @todo document - * @param string $iso - * @return int|string + * Make a year one from an ISO year, for instance: '400 BC' from '-0399'. + * @param string $iso ISO year + * @return int|string int representing year number in case of AD dates, or string containing + * year number and 'BC' at the end otherwise. */ public function makeNormalYear( $iso ) { if ( $iso[0] == '-' ) { -- 2.20.1