From dcfa85c804387ef1c75cf47aae6f6502b17beeb8 Mon Sep 17 00:00:00 2001
From: till <till@208e9e7b-5314-0410-a742-e7e81cd9613c>
Date: Sat, 15 Nov 2008 15:33:26 +0000
Subject: * added docblock for ctr

git-svn-id: https://svn.roundcube.net/trunk@2057 208e9e7b-5314-0410-a742-e7e81cd9613c
---
 roundcubemail/program/include/rcube_message.php | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

(limited to 'roundcubemail/program/include')

diff --git a/roundcubemail/program/include/rcube_message.php b/roundcubemail/program/include/rcube_message.php
index d59c9448a..9aff68b52 100644
--- a/roundcubemail/program/include/rcube_message.php
+++ b/roundcubemail/program/include/rcube_message.php
@@ -45,7 +45,20 @@ class rcube_message
   public $sender = null;
   public $is_safe = false;
   
-  
+
+  /**
+   * __construct
+   *
+   * Provide a uid, and parse message structure.
+   *
+   * @param string $uid The message UID.
+   *
+   * @uses rcmail::get_instance()
+   * @uses rcube_imap::decode_mime_string()
+   * @uses self::set_safe()
+   *
+   * @see self::$app, self::$imap, self::$opt, self::$structure
+   */
   function __construct($uid)
   {
     $this->app = rcmail::get_instance();
-- 
cgit v1.2.3