From 833c0c52de8324e1d0e6dce3b2f1e467de14ff91 Mon Sep 17 00:00:00 2001 From: Jan Schneider Date: Mon, 5 Jul 2010 12:22:07 +0200 Subject: [PATCH] phpdoc --- turba/lib/Turba.php | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/turba/lib/Turba.php b/turba/lib/Turba.php index 02d320fd7..46d95b749 100644 --- a/turba/lib/Turba.php +++ b/turba/lib/Turba.php @@ -221,9 +221,14 @@ class Turba { /** * Formats the name according to the user's preference. * + * If the format is 'none', the full name with all parts is returned. If + * the format is 'last_first' or 'first_last', only the first name and + * last name are returned. + * * @param Turba_Object $ob The object to get a name from. * @param string $name_format The formatting. One of 'none', 'last_first' - * or 'first_last'. + * or 'first_last'. Defaults to the user + * preference. * * @return string The formatted name, either "Firstname Lastname" * or "Lastname, Firstname" depending on $name_format or -- 2.11.0