diff options
Diffstat (limited to 'doc/tmpl')
| -rw-r--r-- | doc/tmpl/libmateweather-unused.sgml | 493 | ||||
| -rw-r--r-- | doc/tmpl/location-entry.sgml | 73 | ||||
| -rw-r--r-- | doc/tmpl/mateweather-enum-types.sgml | 34 | ||||
| -rw-r--r-- | doc/tmpl/mateweather-location.sgml | 210 | ||||
| -rw-r--r-- | doc/tmpl/mateweather-mateconf.sgml | 136 | ||||
| -rw-r--r-- | doc/tmpl/mateweather-prefs.sgml | 169 | ||||
| -rw-r--r-- | doc/tmpl/mateweather-timezone.sgml | 87 | ||||
| -rw-r--r-- | doc/tmpl/mateweather-xml.sgml | 27 | ||||
| -rw-r--r-- | doc/tmpl/parser.sgml | 74 | ||||
| -rw-r--r-- | doc/tmpl/timezone-menu.sgml | 62 | ||||
| -rw-r--r-- | doc/tmpl/weather-priv.sgml | 430 | ||||
| -rw-r--r-- | doc/tmpl/weather.sgml | 683 |
12 files changed, 2478 insertions, 0 deletions
diff --git a/doc/tmpl/libmateweather-unused.sgml b/doc/tmpl/libmateweather-unused.sgml new file mode 100644 index 0000000..5470c86 --- /dev/null +++ b/doc/tmpl/libmateweather-unused.sgml @@ -0,0 +1,493 @@ +<!-- ##### SECTION ./tmpl/mateweather-enum-types.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/mateweather-enum-types.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/mateweather-enum-types.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/mateweather-enum-types.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/mateweather-enum-types.sgml:Title ##### --> +mateweather-enum-types + + +<!-- ##### SECTION ./tmpl/parser.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/parser.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/parser.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/parser.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/parser.sgml:Title ##### --> +parser + + +<!-- ##### SECTION ./tmpl/weather-priv.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/weather-priv.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/weather-priv.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/weather-priv.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/weather-priv.sgml:Title ##### --> +weather-priv + + +<!-- ##### MACRO CONST_ALPHABET ##### --> +<para> + +</para> + + +<!-- ##### MACRO CONST_DIGITS ##### --> +<para> + +</para> + + +<!-- ##### MACRO DATA_SIZE ##### --> +<para> + +</para> + + +<!-- ##### MACRO DEGREES_TO_RADIANS ##### --> +<para> + +</para> + +@deg: + +<!-- ##### MACRO MATEWEATHER_TYPE_LOCATION ##### --> +<para> + +</para> + + +<!-- ##### MACRO MATEWEATHER_TYPE_LOCATION_LEVEL ##### --> +<para> + +</para> + + +<!-- ##### MACRO MATEWEATHER_TYPE_TIMEZONE ##### --> +<para> + +</para> + + +<!-- ##### STRUCT MateWeatherParser ##### --> +<para> + +</para> + +@xml: +@locales: +@use_regions: +@year_start: +@year_end: + +<!-- ##### MACRO N_ ##### --> +<para> + +</para> + +@str: + +<!-- ##### MACRO PRESSURE_INCH_TO_ATM ##### --> +<para> + +</para> + +@inch: + +<!-- ##### MACRO PRESSURE_INCH_TO_HPA ##### --> +<para> + +</para> + +@inch: + +<!-- ##### MACRO PRESSURE_INCH_TO_KPA ##### --> +<para> + +</para> + +@inch: + +<!-- ##### MACRO PRESSURE_INCH_TO_MB ##### --> +<para> + +</para> + +@inch: + +<!-- ##### MACRO PRESSURE_INCH_TO_MM ##### --> +<para> + +</para> + +@inch: + +<!-- ##### MACRO PRESSURE_MBAR_TO_INCH ##### --> +<para> + +</para> + +@mbar: + +<!-- ##### MACRO RADIANS_TO_DEGREES ##### --> +<para> + +</para> + +@rad: + +<!-- ##### MACRO RADIANS_TO_HOURS ##### --> +<para> + +</para> + +@rad: + +<!-- ##### MACRO TEMP_C_TO_F ##### --> +<para> + +</para> + +@c: + +<!-- ##### MACRO TEMP_F_TO_C ##### --> +<para> + +</para> + +@f: + +<!-- ##### MACRO TEMP_F_TO_K ##### --> +<para> + +</para> + +@f: + +<!-- ##### MACRO VISIBILITY_SM_TO_KM ##### --> +<para> + +</para> + +@sm: + +<!-- ##### MACRO VISIBILITY_SM_TO_M ##### --> +<para> + +</para> + +@sm: + +<!-- ##### MACRO WEATHER_LOCATION_CODE_LEN ##### --> +<para> + +</para> + + +<!-- ##### MACRO WINDSPEED_KNOTS_TO_BFT ##### --> +<para> + +</para> + +@knots: + +<!-- ##### MACRO WINDSPEED_KNOTS_TO_KPH ##### --> +<para> + +</para> + +@knots: + +<!-- ##### MACRO WINDSPEED_KNOTS_TO_MPH ##### --> +<para> + +</para> + +@knots: + +<!-- ##### MACRO WINDSPEED_KNOTS_TO_MS ##### --> +<para> + +</para> + +@knots: + +<!-- ##### MACRO WINDSPEED_MS_TO_KNOTS ##### --> +<para> + +</para> + +@ms: + +<!-- ##### STRUCT WeatherConditions ##### --> +<para> + +</para> + +@significant: +@phenomenon: +@qualifier: + +<!-- ##### TYPEDEF WeatherHumidity ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF WeatherPressure ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF WeatherTemperature ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF WeatherUpdate ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF WeatherVisibility ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF WeatherWindSpeed ##### --> +<para> + +</para> + + +<!-- ##### MACRO _ ##### --> +<para> + +</para> + +@str: + +<!-- ##### FUNCTION bom_start_open ##### --> +<para> + +</para> + +@info: + +<!-- ##### FUNCTION calc_sun ##### --> +<para> + +</para> + +@info: +@Returns: + +<!-- ##### FUNCTION free_forecast_list ##### --> +<para> + +</para> + +@info: + +<!-- ##### FUNCTION mateweather_gettext ##### --> +<para> + +</para> + +@str: +@Returns: + +<!-- ##### FUNCTION mateweather_location_get_type ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION mateweather_location_level_get_type ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION mateweather_location_to_weather_location ##### --> +<para> + +</para> + +@gloc: +@name: +@Returns: + +<!-- ##### FUNCTION mateweather_parser_free ##### --> +<para> + +</para> + +@parser: + +<!-- ##### FUNCTION mateweather_parser_get_localized_value ##### --> +<para> + +</para> + +@parser: +@Returns: + +<!-- ##### FUNCTION mateweather_parser_get_value ##### --> +<para> + +</para> + +@parser: +@Returns: + +<!-- ##### FUNCTION mateweather_parser_new ##### --> +<para> + +</para> + +@use_regions: +@Returns: + +<!-- ##### FUNCTION mateweather_timezone_get_type ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION mateweather_timezones_parse_xml ##### --> +<para> + +</para> + +@parser: +@Returns: + +<!-- ##### FUNCTION iwin_start_open ##### --> +<para> + +</para> + +@info: + +<!-- ##### FUNCTION metar_parse ##### --> +<para> + +</para> + +@metar: +@info: +@Returns: + +<!-- ##### FUNCTION metar_start_open ##### --> +<para> + +</para> + +@info: + +<!-- ##### FUNCTION metoffice_start_open ##### --> +<para> + +</para> + +@info: + +<!-- ##### FUNCTION request_done ##### --> +<para> + +</para> + +@info: +@ok: + +<!-- ##### FUNCTION requests_init ##### --> +<para> + +</para> + +@info: +@Returns: + +<!-- ##### FUNCTION weather_conditions_string ##### --> +<para> + +</para> + +@cond: +@Returns: + +<!-- ##### FUNCTION weather_sky_string ##### --> +<para> + +</para> + +@sky: +@Returns: + +<!-- ##### FUNCTION weather_wind_direction_string ##### --> +<para> + +</para> + +@wind: +@Returns: + +<!-- ##### FUNCTION wx_start_open ##### --> +<para> + +</para> + +@info: + diff --git a/doc/tmpl/location-entry.sgml b/doc/tmpl/location-entry.sgml new file mode 100644 index 0000000..8c84c10 --- /dev/null +++ b/doc/tmpl/location-entry.sgml @@ -0,0 +1,73 @@ +<!-- ##### SECTION Title ##### --> +MateWeatherLocationEntry + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT MateWeatherLocationEntry ##### --> +<para> + +</para> + + +<!-- ##### ARG MateWeatherLocationEntry:location ##### --> +<para> + +</para> + +<!-- ##### ARG MateWeatherLocationEntry:top ##### --> +<para> + +</para> + +<!-- ##### FUNCTION mateweather_location_entry_new ##### --> +<para> + +</para> + +@top: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_entry_set_location ##### --> +<para> + +</para> + +@entry: +@loc: + + +<!-- ##### FUNCTION mateweather_location_entry_get_location ##### --> +<para> + +</para> + +@entry: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_entry_set_city ##### --> +<para> + +</para> + +@entry: +@city_name: +@code: +@Returns: + + diff --git a/doc/tmpl/mateweather-enum-types.sgml b/doc/tmpl/mateweather-enum-types.sgml new file mode 100644 index 0000000..f94cf37 --- /dev/null +++ b/doc/tmpl/mateweather-enum-types.sgml @@ -0,0 +1,34 @@ +<!-- ##### SECTION Title ##### --> +mateweather-enum-types + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION mateweather_location_level_get_type ##### --> +<para> + +</para> + +@Returns: + + +<!-- ##### MACRO MATEWEATHER_TYPE_LOCATION_LEVEL ##### --> +<para> + +</para> + + + diff --git a/doc/tmpl/mateweather-location.sgml b/doc/tmpl/mateweather-location.sgml new file mode 100644 index 0000000..e64ff4c --- /dev/null +++ b/doc/tmpl/mateweather-location.sgml @@ -0,0 +1,210 @@ +<!-- ##### SECTION Title ##### --> +mateweather-location + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT MateWeatherLocation ##### --> +<para> + +</para> + + +<!-- ##### ENUM MateWeatherLocationLevel ##### --> +<para> + +</para> + +@MATEWEATHER_LOCATION_WORLD: +@MATEWEATHER_LOCATION_REGION: +@MATEWEATHER_LOCATION_COUNTRY: +@MATEWEATHER_LOCATION_ADM1: +@MATEWEATHER_LOCATION_ADM2: +@MATEWEATHER_LOCATION_CITY: +@MATEWEATHER_LOCATION_WEATHER_STATION: + +<!-- ##### FUNCTION mateweather_location_new_world ##### --> +<para> + +</para> + +@use_regions: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_ref ##### --> +<para> + +</para> + +@loc: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_unref ##### --> +<para> + +</para> + +@loc: + + +<!-- ##### FUNCTION mateweather_location_get_name ##### --> +<para> + +</para> + +@loc: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_get_sort_name ##### --> +<para> + +</para> + +@loc: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_get_level ##### --> +<para> + +</para> + +@loc: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_get_parent ##### --> +<para> + +</para> + +@loc: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_get_children ##### --> +<para> + +</para> + +@loc: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_free_children ##### --> +<para> + +</para> + +@loc: +@children: + + +<!-- ##### FUNCTION mateweather_location_has_coords ##### --> +<para> + +</para> + +@loc: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_get_coords ##### --> +<para> + +</para> + +@loc: +@latitude: +@longitude: + + +<!-- ##### FUNCTION mateweather_location_get_distance ##### --> +<para> + +</para> + +@loc: +@loc2: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_get_country ##### --> +<para> + +</para> + +@loc: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_get_timezone ##### --> +<para> + +</para> + +@loc: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_get_timezones ##### --> +<para> + +</para> + +@loc: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_free_timezones ##### --> +<para> + +</para> + +@loc: +@zones: + + +<!-- ##### FUNCTION mateweather_location_get_code ##### --> +<para> + +</para> + +@loc: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_get_city_name ##### --> +<para> + +</para> + +@loc: +@Returns: + + +<!-- ##### FUNCTION mateweather_location_get_weather ##### --> +<para> + +</para> + +@loc: +@Returns: + + diff --git a/doc/tmpl/mateweather-mateconf.sgml b/doc/tmpl/mateweather-mateconf.sgml new file mode 100644 index 0000000..238ab34 --- /dev/null +++ b/doc/tmpl/mateweather-mateconf.sgml @@ -0,0 +1,136 @@ +<!-- ##### SECTION Title ##### --> +mateweather-mateconf + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT MateWeatherMateConf ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION mateweather_mateconf_new ##### --> +<para> + +</para> + +@prefix: +@Returns: + + +<!-- ##### FUNCTION mateweather_mateconf_free ##### --> +<para> + +</para> + +@ctx: + + +<!-- ##### FUNCTION mateweather_mateconf_get_client ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION mateweather_mateconf_get_location ##### --> +<para> + +</para> + +@ctx: +@Returns: + + +<!-- ##### FUNCTION mateweather_mateconf_get_full_key ##### --> +<para> + +</para> + +@ctx: +@key: +@Returns: + + +<!-- ##### FUNCTION mateweather_mateconf_set_bool ##### --> +<para> + +</para> + +@ctx: +@key: +@the_bool: +@opt_error: + + +<!-- ##### FUNCTION mateweather_mateconf_set_int ##### --> +<para> + +</para> + +@ctx: +@key: +@the_int: +@opt_error: + + +<!-- ##### FUNCTION mateweather_mateconf_set_string ##### --> +<para> + +</para> + +@ctx: +@key: +@the_string: +@opt_error: + + +<!-- ##### FUNCTION mateweather_mateconf_get_bool ##### --> +<para> + +</para> + +@ctx: +@key: +@opt_error: +@Returns: + + +<!-- ##### FUNCTION mateweather_mateconf_get_int ##### --> +<para> + +</para> + +@ctx: +@key: +@opt_error: +@Returns: + + +<!-- ##### FUNCTION mateweather_mateconf_get_string ##### --> +<para> + +</para> + +@ctx: +@key: +@opt_error: +@Returns: + + diff --git a/doc/tmpl/mateweather-prefs.sgml b/doc/tmpl/mateweather-prefs.sgml new file mode 100644 index 0000000..20d078c --- /dev/null +++ b/doc/tmpl/mateweather-prefs.sgml @@ -0,0 +1,169 @@ +<!-- ##### SECTION Title ##### --> +mateweather-prefs + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### MACRO MATECONF_TEMP_UNIT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO MATECONF_SPEED_UNIT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO MATECONF_PRESSURE_UNIT ##### --> +<para> + +</para> + + + +<!-- ##### MACRO MATECONF_DISTANCE_UNIT ##### --> +<para> + +</para> + + + +<!-- ##### STRUCT MateWeatherPrefs ##### --> +<para> + +</para> + +@location: +@update_interval: +@update_enabled: +@detailed: +@radar_enabled: +@use_custom_radar_url: +@radar: +@temperature_unit: +@use_temperature_default: +@speed_unit: +@use_speed_default: +@pressure_unit: +@use_pressure_default: +@distance_unit: +@use_distance_default: + +<!-- ##### FUNCTION mateweather_prefs_load ##### --> +<para> + +</para> + +@prefs: +@ctx: + + +<!-- ##### FUNCTION mateweather_prefs_temp_enum_to_string ##### --> +<para> + +</para> + +@temp: +@Returns: + + +<!-- ##### FUNCTION mateweather_prefs_speed_enum_to_string ##### --> +<para> + +</para> + +@speed: +@Returns: + + +<!-- ##### FUNCTION mateweather_prefs_pressure_enum_to_string ##### --> +<para> + +</para> + +@pressure: +@Returns: + + +<!-- ##### FUNCTION mateweather_prefs_distance_enum_to_string ##### --> +<para> + +</para> + +@distance: +@Returns: + + +<!-- ##### FUNCTION mateweather_prefs_parse_temperature ##### --> +<para> + +</para> + +@str: +@is_default: +@Returns: + + +<!-- ##### FUNCTION mateweather_prefs_parse_speed ##### --> +<para> + +</para> + +@str: +@is_default: +@Returns: + + +<!-- ##### FUNCTION mateweather_prefs_get_temp_display_name ##### --> +<para> + +</para> + +@temp: +@Returns: + + +<!-- ##### FUNCTION mateweather_prefs_get_speed_display_name ##### --> +<para> + +</para> + +@speed: +@Returns: + + +<!-- ##### FUNCTION mateweather_prefs_get_pressure_display_name ##### --> +<para> + +</para> + +@pressure: +@Returns: + + +<!-- ##### FUNCTION mateweather_prefs_get_distance_display_name ##### --> +<para> + +</para> + +@distance: +@Returns: + + diff --git a/doc/tmpl/mateweather-timezone.sgml b/doc/tmpl/mateweather-timezone.sgml new file mode 100644 index 0000000..9438b25 --- /dev/null +++ b/doc/tmpl/mateweather-timezone.sgml @@ -0,0 +1,87 @@ +<!-- ##### SECTION Title ##### --> +mateweather-timezone + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT MateWeatherTimezone ##### --> +<para> + +</para> + + +<!-- ##### FUNCTION mateweather_timezone_get_name ##### --> +<para> + +</para> + +@zone: +@Returns: + + +<!-- ##### FUNCTION mateweather_timezone_get_tzid ##### --> +<para> + +</para> + +@zone: +@Returns: + + +<!-- ##### FUNCTION mateweather_timezone_get_offset ##### --> +<para> + +</para> + +@zone: +@Returns: + + +<!-- ##### FUNCTION mateweather_timezone_has_dst ##### --> +<para> + +</para> + +@zone: +@Returns: + + +<!-- ##### FUNCTION mateweather_timezone_get_dst_offset ##### --> +<para> + +</para> + +@zone: +@Returns: + + +<!-- ##### FUNCTION mateweather_timezone_ref ##### --> +<para> + +</para> + +@zone: +@Returns: + + +<!-- ##### FUNCTION mateweather_timezone_unref ##### --> +<para> + +</para> + +@zone: + + diff --git a/doc/tmpl/mateweather-xml.sgml b/doc/tmpl/mateweather-xml.sgml new file mode 100644 index 0000000..2a33dcd --- /dev/null +++ b/doc/tmpl/mateweather-xml.sgml @@ -0,0 +1,27 @@ +<!-- ##### SECTION Title ##### --> +mateweather-xml + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION mateweather_xml_load_locations ##### --> +<para> + +</para> + +@Returns: + + diff --git a/doc/tmpl/parser.sgml b/doc/tmpl/parser.sgml new file mode 100644 index 0000000..de1e4ee --- /dev/null +++ b/doc/tmpl/parser.sgml @@ -0,0 +1,74 @@ +<!-- ##### SECTION Title ##### --> +parser + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT MateWeatherParser ##### --> +<para> + +</para> + +@xml: +@locales: +@use_regions: +@year_start: +@year_end: + +<!-- ##### FUNCTION mateweather_parser_new ##### --> +<para> + +</para> + +@use_regions: +@Returns: + + +<!-- ##### FUNCTION mateweather_parser_free ##### --> +<para> + +</para> + +@parser: + + +<!-- ##### FUNCTION mateweather_parser_get_value ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION mateweather_parser_get_localized_value ##### --> +<para> + +</para> + +@parser: +@Returns: + + +<!-- ##### FUNCTION mateweather_timezones_parse_xml ##### --> +<para> + +</para> + +@parser: +@Returns: + + diff --git a/doc/tmpl/timezone-menu.sgml b/doc/tmpl/timezone-menu.sgml new file mode 100644 index 0000000..7ab4304 --- /dev/null +++ b/doc/tmpl/timezone-menu.sgml @@ -0,0 +1,62 @@ +<!-- ##### SECTION Title ##### --> +MateWeatherTimezoneMenu + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### STRUCT MateWeatherTimezoneMenu ##### --> +<para> + +</para> + + +<!-- ##### ARG MateWeatherTimezoneMenu:top ##### --> +<para> + +</para> + +<!-- ##### ARG MateWeatherTimezoneMenu:tzid ##### --> +<para> + +</para> + +<!-- ##### FUNCTION mateweather_timezone_menu_new ##### --> +<para> + +</para> + +@top: +@Returns: + + +<!-- ##### FUNCTION mateweather_timezone_menu_set_tzid ##### --> +<para> + +</para> + +@menu: +@tzid: + + +<!-- ##### FUNCTION mateweather_timezone_menu_get_tzid ##### --> +<para> + +</para> + +@menu: +@Returns: + + diff --git a/doc/tmpl/weather-priv.sgml b/doc/tmpl/weather-priv.sgml new file mode 100644 index 0000000..0393cc8 --- /dev/null +++ b/doc/tmpl/weather-priv.sgml @@ -0,0 +1,430 @@ +<!-- ##### SECTION Title ##### --> +weather-priv + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### SECTION Stability_Level ##### --> + + +<!-- ##### FUNCTION mateweather_gettext ##### --> +<para> + +</para> + +@str: +@Returns: + + +<!-- ##### MACRO _ ##### --> +<para> + +</para> + +@str: + + +<!-- ##### MACRO N_ ##### --> +<para> + +</para> + +@str: + + +<!-- ##### MACRO WEATHER_LOCATION_CODE_LEN ##### --> +<para> + +</para> + + + +<!-- ##### FUNCTION mateweather_location_to_weather_location ##### --> +<para> + +</para> + +@gloc: +@name: +@Returns: + + +<!-- ##### STRUCT WeatherConditions ##### --> +<para> + +</para> + +@significant: +@phenomenon: +@qualifier: + +<!-- ##### TYPEDEF WeatherTemperature ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF WeatherHumidity ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF WeatherWindSpeed ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF WeatherPressure ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF WeatherVisibility ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF WeatherUpdate ##### --> +<para> + +</para> + + +<!-- ##### STRUCT WeatherInfo ##### --> +<para> + +</para> + +@forecast_type: +@temperature_unit: +@speed_unit: +@pressure_unit: +@distance_unit: +@valid: +@network_error: +@sunValid: +@tempMinMaxValid: +@location: +@update: +@sky: +@cond: +@temp: +@temp_min: +@temp_max: +@dew: +@wind: +@windspeed: +@pressure: +@visibility: +@sunrise: +@sunset: +@forecast: +@forecast_list: +@radar_buffer: +@radar_url: +@radar_loader: +@radar: +@session: +@requests_pending: +@finish_cb: +@cb_data: + +<!-- ##### FUNCTION weather_wind_direction_string ##### --> +<para> + +</para> + +@wind: +@Returns: + + +<!-- ##### FUNCTION weather_sky_string ##### --> +<para> + +</para> + +@sky: +@Returns: + + +<!-- ##### FUNCTION weather_conditions_string ##### --> +<para> + +</para> + +@cond: +@Returns: + + +<!-- ##### MACRO DATA_SIZE ##### --> +<para> + +</para> + + + +<!-- ##### MACRO CONST_DIGITS ##### --> +<para> + +</para> + + + +<!-- ##### MACRO CONST_ALPHABET ##### --> +<para> + +</para> + + + +<!-- ##### MACRO TEMP_F_TO_C ##### --> +<para> + +</para> + +@f: + + +<!-- ##### MACRO TEMP_F_TO_K ##### --> +<para> + +</para> + +@f: + + +<!-- ##### MACRO TEMP_C_TO_F ##### --> +<para> + +</para> + +@c: + + +<!-- ##### MACRO WINDSPEED_KNOTS_TO_KPH ##### --> +<para> + +</para> + +@knots: + + +<!-- ##### MACRO WINDSPEED_KNOTS_TO_MPH ##### --> +<para> + +</para> + +@knots: + + +<!-- ##### MACRO WINDSPEED_KNOTS_TO_MS ##### --> +<para> + +</para> + +@knots: + + +<!-- ##### MACRO WINDSPEED_MS_TO_KNOTS ##### --> +<para> + +</para> + +@ms: + + +<!-- ##### MACRO WINDSPEED_KNOTS_TO_BFT ##### --> +<para> + +</para> + +@knots: + + +<!-- ##### MACRO PRESSURE_INCH_TO_KPA ##### --> +<para> + +</para> + +@inch: + + +<!-- ##### MACRO PRESSURE_INCH_TO_HPA ##### --> +<para> + +</para> + +@inch: + + +<!-- ##### MACRO PRESSURE_INCH_TO_MM ##### --> +<para> + +</para> + +@inch: + + +<!-- ##### MACRO PRESSURE_INCH_TO_MB ##### --> +<para> + +</para> + +@inch: + + +<!-- ##### MACRO PRESSURE_INCH_TO_ATM ##### --> +<para> + +</para> + +@inch: + + +<!-- ##### MACRO PRESSURE_MBAR_TO_INCH ##### --> +<para> + +</para> + +@mbar: + + +<!-- ##### MACRO VISIBILITY_SM_TO_KM ##### --> +<para> + +</para> + +@sm: + + +<!-- ##### MACRO VISIBILITY_SM_TO_M ##### --> +<para> + +</para> + +@sm: + + +<!-- ##### MACRO DEGREES_TO_RADIANS ##### --> +<para> + +</para> + +@deg: + + +<!-- ##### MACRO RADIANS_TO_DEGREES ##### --> +<para> + +</para> + +@rad: + + +<!-- ##### MACRO RADIANS_TO_HOURS ##### --> +<para> + +</para> + +@rad: + + +<!-- ##### FUNCTION metar_start_open ##### --> +<para> + +</para> + +@info: + + +<!-- ##### FUNCTION iwin_start_open ##### --> +<para> + +</para> + +@info: + + +<!-- ##### FUNCTION metoffice_start_open ##### --> +<para> + +</para> + +@info: + + +<!-- ##### FUNCTION bom_start_open ##### --> +<para> + +</para> + +@info: + + +<!-- ##### FUNCTION wx_start_open ##### --> +<para> + +</para> + +@info: + + +<!-- ##### FUNCTION metar_parse ##### --> +<para> + +</para> + +@metar: +@info: +@Returns: + + +<!-- ##### FUNCTION requests_init ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION request_done ##### --> +<para> + +</para> + +@info: +@ok: + + +<!-- ##### FUNCTION calc_sun ##### --> +<para> + +</para> + +@info: +@Returns: + + +<!-- ##### FUNCTION free_forecast_list ##### --> +<para> + +</para> + +@info: + + 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: + + |