Skip to content

Commit

Permalink
Fix some phpdoc.
Browse files Browse the repository at this point in the history
  • Loading branch information
mrubinsk committed Apr 4, 2014
1 parent 21b82b6 commit 8dbe6f2
Show file tree
Hide file tree
Showing 45 changed files with 279 additions and 258 deletions.
22 changes: 11 additions & 11 deletions framework/ActiveSync/lib/Horde/ActiveSync.php
Expand Up @@ -24,16 +24,16 @@
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @package ActiveSync
*
* @property Horde_ActiveSync_Wbxml_Encoder encoder The Wbxml encoder.
* @property Horde_ActiveSync_Wbxml_Decoder decoder The Wbxml decoder.
* @property Horde_ActiveSync_State_Base state The state object.
* @property Horde_Controller_Reqeust_Http request The HTTP request object.
* @property Horde_ActiveSync_Driver_Base driver
* @property boolean provisioning
* @property boolean multipart
* @property string certPath
* @property Horde_ActiveSync_Device device
* @property Horde_Log_Logger logger
* @property-read Horde_ActiveSync_Wbxml_Encoder $encoder The Wbxml encoder.
* @property-read Horde_ActiveSync_Wbxml_Decoder $decoder The Wbxml decoder.
* @property-read Horde_ActiveSync_State_Base $state The state object.
* @property-read Horde_Controller_Reqeust_Http $request The HTTP request object.
* @property-read Horde_ActiveSync_Driver_Base $driver The backend driver object.
* @property-read boolean|string $provisioning Provisioning support: True, False, or 'loose'
* @property-read boolean $multipart Indicate this is a multipart request.
* @property-read string $certPath Local path to the certificate bundle.
* @property-read Horde_ActiveSync_Device $device The current device object.
* @property-read Horde_Log_Logger $logger The logger object.
*/
class Horde_ActiveSync
{
Expand Down Expand Up @@ -308,7 +308,7 @@ class Horde_ActiveSync
/**
* Provisioning support
*
* @var string (TODO _constant this)
* @var string
*/
protected $_provisioning;

Expand Down
1 change: 1 addition & 0 deletions framework/ActiveSync/lib/Horde/ActiveSync/Collections.php
Expand Up @@ -23,6 +23,7 @@
* @copyright 2010-2014 Horde LLC (http://www.horde.org)
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @package ActiveSync
* @internal Not intended for use outside of the ActiveSync library.
*/
class Horde_ActiveSync_Collections implements IteratorAggregate
{
Expand Down
24 changes: 12 additions & 12 deletions framework/ActiveSync/lib/Horde/ActiveSync/Device.php
Expand Up @@ -23,25 +23,25 @@
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @package ActiveSync
*
* @property string id The device id.
* @property string deviceType The device type string.
* @property string clientType The client name, if available.
* @property integer rwstatus The RemoteWipe status - a
* @property string $id The device id.
* @property string $deviceType The device type string.
* @property string $clientType The client name, if available.
* @property integer $rwstatus The RemoteWipe status - a
* Horde_ActiveSync::RWSTATUS_* constant.
* @property string userAgent The device's user agent string.
* @property string user The userid for the current device account.
* @property array supported The SUPPORTED data sent from this device.
* @property string policykey The current policykey, if provisioned.
* @property array properties The device properties, sent in DEVICEINFO,
* @property string $userAgent The device's user agent string.
* @property string $user The userid for the current device account.
* @property array $supported The SUPPORTED data sent from this device.
* @property string $policykey The current policykey, if provisioned.
* @property array $properties The device properties, sent in DEVICEINFO,
* along with any custom properties set.
* @property string announcedVersion The most last EAS supported versions
* @property string $announcedVersion The most last EAS supported versions
* announced to the device.
* @property integer multiplex Bitmask describing collections that this
* @property integer $multiplex Bitmask describing collections that this
* device does not support user created
* folders for, therefore all sources must
* be multiplexed together. Masks are
* the MULTIPLEX_* constants.
* @property boolean blocked True if device has been marked as blocked.
* @property boolean $blocked True if device has been marked as blocked.
*
*/
class Horde_ActiveSync_Device
Expand Down
Expand Up @@ -34,19 +34,17 @@
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @package ActiveSync
*
* @property string attmethod The attachment method.
* @property integer attsize The attachment size.
* @property string displayname The attachment's display name.
* @property string attname The attachment's name.
* @property boolean attremoved @todo
* @property contentid The Content-Id of the mime part.
* @property contentlocation @todo
* @property isinline Indicates that this part is to be displayed
* inline.
* @property string $attmethod The attachment method.
* @property integer $attsize The attachment size.
* @property string $displayname The attachment's display name.
* @property string $attname The attachment's name.
* @property boolean $attremoved @todo
* @property string $contentid The Content-Id of the mime part.
* @property string $contentlocation @todo
* @property boolean $isinline Indicates that this part is to be displayed inline.
*/
class Horde_ActiveSync_Message_AirSyncBaseAttachment extends Horde_ActiveSync_Message_Base
{

/* Attachement types */
const ATT_TYPE_NORMAL = 1;
const ATT_TYPE_EMBEDDED = 5;
Expand Down
Expand Up @@ -34,11 +34,11 @@
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @package ActiveSync
*
* @property integer type The content type of the body.
* A Horde_ActiveSync::BODYPREF_TYPE_* constant.
* @property integer estimateddatasize The estimated size of the untruncated body.
* @property integer truncated The truncated flag. 0 == not truncated, 1 == truncated
* @property mixed string|stream The body data.
* @property integer $type The content type of the body.
* A Horde_ActiveSync::BODYPREF_TYPE_* constant.
* @property integer $estimateddatasize The estimated size of the untruncated body.
* @property integer $truncated The truncated flag. 0 == not truncated, 1 == truncated
* @property mixed $string|stream $data The body data.
*/
class Horde_ActiveSync_Message_AirSyncBaseBody extends Horde_ActiveSync_Message_Base
{
Expand Down
Expand Up @@ -34,10 +34,10 @@
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @package ActiveSync
*
* @property string contenttype The content type of the attachment.
* @property mixed string|stream The attachment data.
* @property integer total The total size of the attachment.
* @property integer range @todo
* @property string $contenttype The content type of the attachment.
* @property mixed $string|stream $data The attachment data.
* @property integer $total The total size of the attachment.
* @property string $range The range string being returned.
*/
class Horde_ActiveSync_Message_AirSyncBaseFileAttachment extends Horde_ActiveSync_Message_Base
{
Expand Down
12 changes: 6 additions & 6 deletions framework/ActiveSync/lib/Horde/ActiveSync/Message/Attachment.php
Expand Up @@ -34,12 +34,12 @@
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @package ActiveSync
*
* @property string attmethod The attachment method.
* @property integer attsize The attachment size.
* @property string displayname The attachment's display name.
* @property string attname The attachment's name.
* @property string attoid The ObjectID of the attachment.
* @property integer attremoved @todo
* @property string $attmethod The attachment method.
* @property integer $attsize The attachment size.
* @property string $displayname The attachment's display name.
* @property string $attname The attachment's name.
* @property string $attoid The ObjectID of the attachment.
* @property integer $attremoved @todo
*/
class Horde_ActiveSync_Message_Attachment extends Horde_ActiveSync_Message_Base
{
Expand Down
Expand Up @@ -34,10 +34,10 @@
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @package ActiveSync
*
* @property string email The attendee's email address.
* @property string name The attendee's name.
* @property integer status The attendee's status (a STATUS_* constant).
* @property integer type The attendee type (a TYPE_* constant)
* @property string $email The attendee's email address.
* @property string $name The attendee's name.
* @property integer $status The attendee's status (a STATUS_* constant).
* @property integer $type The attendee type (a TYPE_* constant)
*/
class Horde_ActiveSync_Message_Attendee extends Horde_ActiveSync_Message_Base
{
Expand Down
134 changes: 67 additions & 67 deletions framework/ActiveSync/lib/Horde/ActiveSync/Message/Contact.php
Expand Up @@ -34,73 +34,73 @@
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @package ActiveSync
*
* anniversary
* @property string assistantname
* @property string assistnamephonenumber
* @property Horde_Date birthday
* @property string business2phonenumber
* @property string businesscity
* @property string businesscountry
* @property string businesspostalcode
* @property string businessstate
* @property string businessstreet
* @property string businessfaxnumber
* @property string businessphonenumber
* @property string carphonenumber
* @property array categories
* @property array children
* @property string companyname
* @property string department
* @property string email1address
* @property string email2address
* @property string email3address
* @property string fileas
* @property string firstname
* @property string home2phonenumber
* @property string homecity
* @property string homecountry
* @property string homepostalcode
* @property string homestate
* @property string homestreet
* @property string homefaxnumber
* @property string homephonenumber
* @property string jobtitle
* @property string lastname
* @property string middlename
* @property string mobilephonenumber
* @property string officelocation
* @property string othercity
* @property string othercountry
* @property string otherpostalcode
* @property string otherstate
* @property string otherstreet
* @property string pagernumber
* @property string radiophonenumber
* @property string spouse
* @property string suffix
* @property string title
* @property string webpage
* @property string yomicompanyname
* @property string yomifirstname
* @property string yomilastname
* @property string picture
* @property string customerid
* @property string governmentid
* @property string imaddress
* @property string imaddress2
* @property string imaddress3
* @property string managername
* @property string companymainphone
* @property string accountname
* @property string nickname
* @property string mms
* @property string alias (EAS >= 14.0 only)
* @property string weightedrank (EAS >= 14.0 only)
* @property string body (EAS 2.5 only)
* @property integer bodysize (EAS 2.5 only)
* @property integer bodytruncated (EAS 2.5 only)
* @property integer rtf (EAS 2.5 only)
* @property Horde_ActiveSync_Message_AirSyncBaseBody airsyncbasebody (EAS >= 12.0 only)
* @property Horde_Date $anniversary
* @property string $assistantname
* @property string $assistnamephonenumber
* @property Horde_Date $birthday
* @property string $business2phonenumber
* @property string $businesscity
* @property string $businesscountry
* @property string $businesspostalcode
* @property string $businessstate
* @property string $businessstreet
* @property string $businessfaxnumber
* @property string $businessphonenumber
* @property string $carphonenumber
* @property array $categories
* @property array $children
* @property string $companyname
* @property string $department
* @property string $email1address
* @property string $email2address
* @property string $email3address
* @property string $fileas
* @property string $firstname
* @property string $home2phonenumber
* @property string $homecity
* @property string $homecountry
* @property string $homepostalcode
* @property string $homestate
* @property string $homestreet
* @property string $homefaxnumber
* @property string $homephonenumber
* @property string $jobtitle
* @property string $lastname
* @property string $middlename
* @property string $mobilephonenumber
* @property string $officelocation
* @property string $othercity
* @property string $othercountry
* @property string $otherpostalcode
* @property string $otherstate
* @property string $otherstreet
* @property string $pagernumber
* @property string $radiophonenumber
* @property string $spouse
* @property string $suffix
* @property string $title
* @property string $webpage
* @property string $yomicompanyname
* @property string $yomifirstname
* @property string $yomilastname
* @property string $picture
* @property string $customerid
* @property string $governmentid
* @property string $imaddress
* @property string $imaddress2
* @property string $imaddress3
* @property string $managername
* @property string $companymainphone
* @property string $accountname
* @property string $nickname
* @property string $mms
* @property string $alias (EAS >= 14.0 only)
* @property string $weightedrank (EAS >= 14.0 only)
* @property string $body (EAS 2.5 only)
* @property integer $bodysize (EAS 2.5 only)
* @property integer $bodytruncated (EAS 2.5 only)
* @property integer $rtf (EAS 2.5 only)
* @property Horde_ActiveSync_Message_AirSyncBaseBody $airsyncbasebody (EAS >= 12.0 only)
*/
class Horde_ActiveSync_Message_Contact extends Horde_ActiveSync_Message_Base
{
Expand Down
34 changes: 17 additions & 17 deletions framework/ActiveSync/lib/Horde/ActiveSync/Message/Exception.php
Expand Up @@ -34,23 +34,23 @@
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @package ActiveSync
*
* @property mixed string|Horde_Date timezone
* @property Horde_Date dtstamp
* @property Horde_Date starttime
* @property string subject
* @property string organizername
* @property string organizeremail
* @property string location
* @property Horde_Date endtime
* @property integer sensitivity
* @property integer busystatus
* @property integer alldayevent
* @property integer reminder
* @property integer meetingstatus
* @property Horde_Date exceptionstarttime
* @property integer deleted
* @property array attendees
* @property array categories
* @property mixed $string|Horde_Date timezone
* @property Horde_Date $dtstamp
* @property Horde_Date $starttime
* @property string $subject
* @property string $organizername
* @property string $organizeremail
* @property string $location
* @property Horde_Date $endtime
* @property integer $sensitivity
* @property integer $busystatus
* @property integer $alldayevent
* @property integer $reminder
* @property integer $meetingstatus
* @property Horde_Date $exceptionstarttime
* @property integer $deleted
* @property array $attendees
* @property array $categories
*/
class Horde_ActiveSync_Message_Exception extends Horde_ActiveSync_Message_Appointment
{
Expand Down
26 changes: 13 additions & 13 deletions framework/ActiveSync/lib/Horde/ActiveSync/Message/Flag.php
Expand Up @@ -45,19 +45,19 @@
* @author Michael J Rubinsky <mrubinsk@horde.org>
* @package ActiveSync
*
* @property integer flagstatus
* @property integer flagtype
* @property Horde_Date startdate
* @property Horde_Date utcstartdate
* @property Horde_Date duedate
* @property Horde_Date utcduedate
* @property Horde_Date datecompleted
* @property integer reminderset
* @property integer remindertime
* @property string subject
* @property Horde_Date ordinaldate
* @property Horde_Date subordinaldate
* @property integer completetime
* @property integer $flagstatus
* @property integer $flagtype
* @property Horde_Date $startdate
* @property Horde_Date $utcstartdate
* @property Horde_Date $duedate
* @property Horde_Date $utcduedate
* @property Horde_Date $datecompleted
* @property integer $reminderset
* @property integer $remindertime
* @property string $subject
* @property Horde_Date $ordinaldate
* @property Horde_Date $subordinaldate
* @property integer $completetime
*/
class Horde_ActiveSync_Message_Flag extends Horde_ActiveSync_Message_Base
{
Expand Down

0 comments on commit 8dbe6f2

Please sign in to comment.