* translator documentation updated.

* superfluous whitespace removed.
* added FIXMEs for missing documentation and un-i18n-able timestamps.

diff --git a/actions/groupunblock.php b/actions/groupunblock.php
index dd6b15c26c20a61a4a214c0c2fa7a9ee4ad2f75d..ef2380725e041c476264a2389a6c71e6d002cdf9 100644 (file)
--- a/actions/groupunblock.php
+++ b/actions/groupunblock.php
@@ -32,7 +32,7 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
 }
 
 /**
- * Unlock a user from a group
+ * Unblock a user from a group
  *
  * @category Action
  * @package  StatusNet
@@ -40,7 +40,6 @@ if (!defined('STATUSNET') && !defined('LACONICA')) {
  * @license  http://www.fsf.org/licensing/licenses/agpl.html AGPLv3
  * @link     http://status.net/
  */
-
 class GroupunblockAction extends Action
 {
     var $profile = null;
@@ -53,11 +52,11 @@ class GroupunblockAction extends Action
      *
      * @return boolean success flag
      */
-
     function prepare($args)
     {
         parent::prepare($args);
         if (!common_logged_in()) {
+            // TRANS: Client error displayed when trying to unblock a user from a group while not logged in.
             $this->clientError(_('Not logged in.'));
             return false;
         }
@@ -68,11 +67,13 @@ class GroupunblockAction extends Action
         }
         $id = $this->trimmed('unblockto');
         if (empty($id)) {
+            // TRANS: Client error displayed when trying to unblock a user from a group without providing a profile.
             $this->clientError(_('No profile specified.'));
             return false;
         }
         $this->profile = Profile::staticGet('id', $id);
         if (empty($this->profile)) {
+            // TRANS: Client error displayed when trying to unblock a user from a group without providing an existing profile.
             $this->clientError(_('No profile with that ID.'));
             return false;
         }
@@ -83,15 +84,18 @@ class GroupunblockAction extends Action
         }
         $this->group = User_group::staticGet('id', $group_id);
         if (empty($this->group)) {
+            // TRANS: Client error displayed when trying to unblock a user from a non-existing group.
             $this->clientError(_('No such group.'));
             return false;
         }
         $user = common_current_user();
         if (!$user->isAdmin($this->group)) {
+            // TRANS: Client error displayed when trying to unblock a user from a group without being an administrator for the group.
             $this->clientError(_('Only an admin can unblock group members.'), 401);
             return false;
         }
         if (!Group_block::isBlocked($this->group, $this->profile)) {
+            // TRANS: Client error displayed when trying to unblock a non-blocked user from a group.
             $this->clientError(_('User is not blocked from group.'));
             return false;
         }
@@ -105,7 +109,6 @@ class GroupunblockAction extends Action
      *
      * @return void
      */
-
     function handle($args)
     {
         parent::handle($args);
@@ -119,12 +122,12 @@ class GroupunblockAction extends Action
      *
      * @return void
      */
-
     function unblockProfile()
     {
         $result = Group_block::unblockProfile($this->group, $this->profile);
 
         if (!$result) {
+            // TRANS: Server error displayed when unblocking a user from a group fails because of an unknown error.
             $this->serverError(_('Error removing the block.'));
             return;
         }
@@ -146,4 +149,3 @@ class GroupunblockAction extends Action
         }
     }
 }
-

diff --git a/actions/showmessage.php b/actions/showmessage.php
index db757948baba6e64bbb731d9eeaa1530d819caaf..d737f85d3a0b2ba3b4bb0531f5344f023c5eb4ed 100644 (file)
--- a/actions/showmessage.php
+++ b/actions/showmessage.php
@@ -26,8 +26,8 @@
  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link      http://status.net/
  */
-if (!defined('STATUSNET') && !defined('LACONICA')) { 
-    exit(1); 
+if (!defined('STATUSNET') && !defined('LACONICA')) {
+    exit(1);
 }
 
 require_once INSTALLDIR.'/lib/mailbox.php';
@@ -36,26 +36,24 @@ require_once INSTALLDIR.'/lib/mailbox.php';
  * Show a single message
  *
  * // XXX: It is totally weird how this works!
- * 
+ *
  * @category Personal
  * @package  StatusNet
  * @author   Evan Prodromou <evan@status.net>
  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  * @link     http://status.net/
  */
-
 class ShowmessageAction extends MailboxAction
 {
     /**
      * Message object to show
      */
-
     var $message = null;
-    
+
     /**
      * The current user
      */
-    
+
     var $user = null;
 
     /**
@@ -67,17 +65,17 @@ class ShowmessageAction extends MailboxAction
      *
      * @return success flag
      */
-
     function prepare($args)
     {
         parent::prepare($args);
-        
+
         $this->page = 1;
-        
+
         $id            = $this->trimmed('message');
         $this->message = Message::staticGet('id', $id);
 
         if (!$this->message) {
+            // TRANS: Client error displayed requesting a single message that does not exist.
             $this->clientError(_('No such message.'), 404);
             return false;
         }
@@ -90,40 +88,47 @@ class ShowmessageAction extends MailboxAction
     function handle($args)
     {
         Action::handle($args);
-                        
-        if ($this->user && ($this->user->id == $this->message->from_profile || 
+
+        if ($this->user && ($this->user->id == $this->message->from_profile ||
             $this->user->id == $this->message->to_profile)) {
                 $this->showPage();
         } else {
+            // TRANS: Client error displayed requesting a single direct message the requesting user was not a party in.
             $this->clientError(_('Only the sender and recipient ' .
                 'may read this message.'), 403);
             return;
         }
     }
-    
+
     function title()
-    {                        
+    {
         if ($this->user->id == $this->message->from_profile) {
             $to = $this->message->getTo();
-            return sprintf(_("Message to %1\$s on %2\$s"),
+            // @todo FIXME: Might be nice if the timestamp could be localised.
+            // TRANS: Page title for single direct message display when viewing user is the sender.
+            // TRANS: %1$s is the addressed user's nickname, $2$s is a timestamp.
+            return sprintf(_('Message to %1$s on %2$s'),
                              $to->nickname,
                              common_exact_date($this->message->created));
         } else if ($this->user->id == $this->message->to_profile) {
             $from = $this->message->getFrom();
-            return sprintf(_("Message from %1\$s on %2\$s"),
+            // @todo FIXME: Might be nice if the timestamp could be localised.
+            // TRANS: Page title for single message display.
+            // TRANS: %1$s is the sending user's nickname, $2$s is a timestamp.
+            return sprintf(_('Message from %1$s on %2$s'),
                              $from->nickname,
                              common_exact_date($this->message->created));
         }
     }
-        
-    function getMessages() 
-    {    
+
+    function getMessages()
+    {
         $message     = new Message();
         $message->id = $this->message->id;
         $message->find();
         return $message;
     }
-    
+
     function getMessageProfile()
     {
         if ($this->user->id == $this->message->from_profile) {
@@ -135,23 +140,21 @@ class ShowmessageAction extends MailboxAction
             return null;
         }
     }
-    
+
     /**
      * Don't show local navigation
      *
      * @return void
      */
-
     function showLocalNavBlock()
     {
     }
-    
+
     /**
      * Don't show page notice
      *
      * @return void
      */
-
     function showPageNoticeBlock()
     {
     }
@@ -161,17 +164,15 @@ class ShowmessageAction extends MailboxAction
      *
      * @return void
      */
-
-    function showAside() 
+    function showAside()
     {
     }
- 
+
     /**
      * Don't show any instructions
      *
      * @return string
      */
-     
     function getInstructions()
     {
         return '';

diff --git a/actions/subedit.php b/actions/subedit.php
index cf6589e50420baafb6cf2b5fa50711109e6bb1c9..3b77aff584fc4b3446dc10a1fa08b531ae878459 100644 (file)
--- a/actions/subedit.php
+++ b/actions/subedit.php
@@ -19,6 +19,7 @@
 
 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
 
+// @todo FIXME: Documentation needed.
 class SubeditAction extends Action
 {
     var $profile = null;
@@ -28,6 +29,7 @@ class SubeditAction extends Action
         parent::prepare($args);
 
         if (!common_logged_in()) {
+            // TRANS: Client error displayed trying a change a subscription while not logged in.
             $this->clientError(_('Not logged in.'));
             return false;
         }
@@ -43,6 +45,7 @@ class SubeditAction extends Action
         $id = $this->trimmed('profile');
 
         if (!$id) {
+            // TRANS: Client error displayed trying a change a subscription without providing a profile.
             $this->clientError(_('No profile specified.'));
             return false;
         }
@@ -50,6 +53,7 @@ class SubeditAction extends Action
         $this->profile = Profile::staticGet('id', $id);
 
         if (!$this->profile) {
+            // TRANS: Client error displayed trying a change a subscription for a non-existant profile ID.
             $this->clientError(_('No profile with that ID.'));
             return false;
         }
@@ -67,6 +71,7 @@ class SubeditAction extends Action
                                                'subscribed' => $this->profile->id));
 
             if (!$sub) {
+                // TRANS: Client error displayed trying a change a subscription for a non-subscribed profile.
                 $this->clientError(_('You are not subscribed to that profile.'));
                 return false;
             }
@@ -80,6 +85,7 @@ class SubeditAction extends Action
 
             if (!$result) {
                 common_log_db_error($sub, 'UPDATE', __FILE__);
+                // TRANS: Server error displayed when updating a subscription fails with a database error.
                 $this->serverError(_('Could not save subscription.'));
                 return false;
             }