diff options
Diffstat (limited to 'doc/tmpl/weather.sgml')
-rw-r--r-- | doc/tmpl/weather.sgml | 683 |
1 files changed, 683 insertions, 0 deletions
diff --git a/doc/tmpl/weather.sgml b/doc/tmpl/weather.sgml new file mode 100644 index 0000000..3df6757 --- /dev/null +++ b/doc/tmpl/weather.sgml @@ -0,0 +1,683 @@ +<!-- ##### SECTION Title ##### --> +weather + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT WeatherLocation ##### --> +<para> + +</para> + +@name: +@code: +@zone: +@radar: +@zone_valid: +@coordinates: +@latitude: +@longitude: +@latlon_valid: +@country_code: +@tz_hint: + +<!-- ##### FUNCTION weather_location_new ##### --> +<para> + +</para> + +@trans_name: +@code: +@zone: +@radar: +@coordinates: +@country_code: +@tz_hint: +@Returns: + + +<!-- ##### FUNCTION weather_location_clone ##### --> +<para> + +</para> + +@location: +@Returns: + + +<!-- ##### FUNCTION weather_location_free ##### --> +<para> + +</para> + +@location: + + +<!-- ##### FUNCTION weather_location_equal ##### --> +<para> + +</para> + +@location1: +@location2: +@Returns: + + +<!-- ##### ENUM WeatherForecastType ##### --> +<para> + +</para> + +@FORECAST_STATE: +@FORECAST_ZONE: +@FORECAST_LIST: + +<!-- ##### ENUM TempUnit ##### --> +<para> + +</para> + +@TEMP_UNIT_INVALID: +@TEMP_UNIT_DEFAULT: +@TEMP_UNIT_KELVIN: +@TEMP_UNIT_CENTIGRADE: +@TEMP_UNIT_FAHRENHEIT: + +<!-- ##### ENUM SpeedUnit ##### --> +<para> + +</para> + +@SPEED_UNIT_INVALID: +@SPEED_UNIT_DEFAULT: +@SPEED_UNIT_MS: +@SPEED_UNIT_KPH: +@SPEED_UNIT_MPH: +@SPEED_UNIT_KNOTS: +@SPEED_UNIT_BFT: + +<!-- ##### ENUM PressureUnit ##### --> +<para> + +</para> + +@PRESSURE_UNIT_INVALID: +@PRESSURE_UNIT_DEFAULT: +@PRESSURE_UNIT_KPA: +@PRESSURE_UNIT_HPA: +@PRESSURE_UNIT_MB: +@PRESSURE_UNIT_MM_HG: +@PRESSURE_UNIT_INCH_HG: +@PRESSURE_UNIT_ATM: + +<!-- ##### ENUM DistanceUnit ##### --> +<para> + +</para> + +@DISTANCE_UNIT_INVALID: +@DISTANCE_UNIT_DEFAULT: +@DISTANCE_UNIT_METERS: +@DISTANCE_UNIT_KM: +@DISTANCE_UNIT_MILES: + +<!-- ##### STRUCT WeatherPrefs ##### --> +<para> + +</para> + +@type: +@radar: +@radar_custom_url: +@temperature_unit: +@speed_unit: +@pressure_unit: +@distance_unit: + +<!-- ##### STRUCT WeatherInfo ##### --> +<para> + +</para> + + +<!-- ##### USER_FUNCTION WeatherInfoFunc ##### --> +<para> + +</para> + +@info: +@data: + + +<!-- ##### MACRO weather_info_new ##### --> +<para> + +</para> + +@location: +@prefs: +@cb: +@data: + + +<!-- ##### MACRO weather_info_update ##### --> +<para> + +</para> + +@info: +@prefs: +@cb: +@data: + + +<!-- ##### FUNCTION weather_info_abort ##### --> +<para> + +</para> + +@info: + + +<!-- ##### FUNCTION weather_info_clone ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_free ##### --> +<para> + +</para> + +@info: + + +<!-- ##### FUNCTION weather_info_is_valid ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_network_error ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_to_metric ##### --> +<para> + +</para> + +@info: + + +<!-- ##### FUNCTION weather_info_to_imperial ##### --> +<para> + +</para> + +@info: + + +<!-- ##### FUNCTION weather_info_get_location ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_location_name ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_update ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_sky ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_conditions ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_temp ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_temp_min ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_temp_max ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_dew ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_humidity ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_wind ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_pressure ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_visibility ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_apparent ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_sunrise ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_sunset ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_forecast ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_forecast_list ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_radar ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_temp_summary ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_weather_summary ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_icon_name ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION weather_info_next_sun_event ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### ENUM WeatherWindDirection ##### --> +<para> + +</para> + +@WIND_INVALID: +@WIND_VARIABLE: +@WIND_N: +@WIND_NNE: +@WIND_NE: +@WIND_ENE: +@WIND_E: +@WIND_ESE: +@WIND_SE: +@WIND_SSE: +@WIND_S: +@WIND_SSW: +@WIND_SW: +@WIND_WSW: +@WIND_W: +@WIND_WNW: +@WIND_NW: +@WIND_NNW: +@WIND_LAST: + +<!-- ##### ENUM WeatherSky ##### --> +<para> + +</para> + +@SKY_INVALID: +@SKY_CLEAR: +@SKY_BROKEN: +@SKY_SCATTERED: +@SKY_FEW: +@SKY_OVERCAST: +@SKY_LAST: + +<!-- ##### ENUM WeatherConditionPhenomenon ##### --> +<para> + +</para> + +@PHENOMENON_INVALID: +@PHENOMENON_NONE: +@PHENOMENON_DRIZZLE: +@PHENOMENON_RAIN: +@PHENOMENON_SNOW: +@PHENOMENON_SNOW_GRAINS: +@PHENOMENON_ICE_CRYSTALS: +@PHENOMENON_ICE_PELLETS: +@PHENOMENON_HAIL: +@PHENOMENON_SMALL_HAIL: +@PHENOMENON_UNKNOWN_PRECIPITATION: +@PHENOMENON_MIST: +@PHENOMENON_FOG: +@PHENOMENON_SMOKE: +@PHENOMENON_VOLCANIC_ASH: +@PHENOMENON_SAND: +@PHENOMENON_HAZE: +@PHENOMENON_SPRAY: +@PHENOMENON_DUST: +@PHENOMENON_SQUALL: +@PHENOMENON_SANDSTORM: +@PHENOMENON_DUSTSTORM: +@PHENOMENON_FUNNEL_CLOUD: +@PHENOMENON_TORNADO: +@PHENOMENON_DUST_WHIRLS: +@PHENOMENON_LAST: + +<!-- ##### ENUM WeatherConditionQualifier ##### --> +<para> + +</para> + +@QUALIFIER_INVALID: +@QUALIFIER_NONE: +@QUALIFIER_VICINITY: +@QUALIFIER_LIGHT: +@QUALIFIER_MODERATE: +@QUALIFIER_HEAVY: +@QUALIFIER_SHALLOW: +@QUALIFIER_PATCHES: +@QUALIFIER_PARTIAL: +@QUALIFIER_THUNDERSTORM: +@QUALIFIER_BLOWING: +@QUALIFIER_SHOWERS: +@QUALIFIER_DRIFTING: +@QUALIFIER_FREEZING: +@QUALIFIER_LAST: + +<!-- ##### FUNCTION weather_info_get_value_update ##### --> +<para> + +</para> + +@info: +@value: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_value_sky ##### --> +<para> + +</para> + +@info: +@sky: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_value_conditions ##### --> +<para> + +</para> + +@info: +@phenomenon: +@qualifier: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_value_temp ##### --> +<para> + +</para> + +@info: +@unit: +@value: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_value_temp_min ##### --> +<para> + +</para> + +@info: +@unit: +@value: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_value_temp_max ##### --> +<para> + +</para> + +@info: +@unit: +@value: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_value_dew ##### --> +<para> + +</para> + +@info: +@unit: +@value: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_value_apparent ##### --> +<para> + +</para> + +@info: +@unit: +@value: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_value_wind ##### --> +<para> + +</para> + +@info: +@unit: +@speed: +@direction: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_value_pressure ##### --> +<para> + +</para> + +@info: +@unit: +@value: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_value_visibility ##### --> +<para> + +</para> + +@info: +@unit: +@value: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_value_sunrise ##### --> +<para> + +</para> + +@info: +@value: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_value_sunset ##### --> +<para> + +</para> + +@info: +@value: +@Returns: + + |