phpdoc

horde · Mar 28, 2014 · 50d41fc · 50d41fc
1 parent f05ae16
commit 50d41fc
Showing 1 changed file with 25 additions and 19 deletions.
diff --git a/framework/Service_Weather/lib/Horde/Service/Weather/Current/Base.php b/framework/Service_Weather/lib/Horde/Service/Weather/Current/Base.php
@@ -14,25 +14,31 @@
 /**
  * Horde_Service_Weather_Current_Base class
  *
- * @property pressure          The barometric pressure.
- * @property pressure_trend    The pressure trend.
- * @property logo_url          URL to a provider logo.
- * @property dewpoint          The dewpoint.
- * @property wind_direction    The cardinal wind direction.
- * @property wind_degrees      The wind direction, in degrees.
- * @property wind_speed        The wind speed, in requested units.
- * @property wind_gust         The wind gust speed.
- * @property visibility        The visisbility, in requested units.
- * @property wind_chill        The wind chill.
- * @property heat_index        Heat index.
- * @property temp              The temperature.
- * @property icon              Icon name to represent conditions.
- * @property condition         The condition string.
- * @property humidity          The humidity.
- * @property wind              Full wind description string.
- * @property icon_url          Url to icon.
- * @property logo_url          Url to logo.
- * @property time              Forecast time.
+ * @property string pressure          The barometric pressure.
+ * @property string pressure_trend    The pressure trend.
+ * @property string logo_url          URL to a provider logo.
+ * @property string dewpoint          The dewpoint.
+ * @property string wind_direction    The cardinal wind direction.
+ * @property string wind_degrees      The wind direction, in degrees.
+ * @property string wind_speed        The wind speed, in requested units.
+ * @property string wind_gust         The wind gust speed.
+ * @property string visibility        The visisbility, in requested units.
+ * @property string wind_chill        The wind chill.
+ * @property string heat_index        Heat index.
+ * @property string temp              The temperature.
+ * @property string icon              Icon name to represent conditions.
+ * @property string condition         The condition string.
+ * @property string humidity          The humidity.
+ * @property string wind              Full wind description string.
+ * @property string icon_url          Url to icon.
+ * @property string logo_url          Url to logo.
+ * @property Horde_Date time          Forecast time in local (to station) time.
+ *                                    NOTE the timezone property of the date
+ *                                    object is NOT guarenteed to be correct,
+ *                                    and might be presented as the servers'
+ *                                    default timezone. This is because not
+ *                                    all APIs return the timezone identifier.
+ * @property Horde_Date time_utc      Forecast time in UTC. @since 1.2.0
  *
  * @author   Michael J Rubinsky <mrubinsk@horde.org>
  * @category Horde