diff options
author | Dan Winship <danw@src.gnome.org> | 2008-11-26 04:04:08 +0000 |
---|---|---|
committer | Dan Winship <danw@src.gnome.org> | 2008-11-26 04:04:08 +0000 |
commit | 912775b00334afc7808d8f7a743b4e8f3d39336c (patch) | |
tree | fca0d75b07c1a13a583f212c909b4b6e9cfdc0f6 /doc | |
parent | c96050dda6d77314f2d7576e7e0caed8882ed629 (diff) | |
download | libgweather-912775b00334afc7808d8f7a743b4e8f3d39336c.tar.gz |
Make the memory-management here less lame. #562274
* libgweather/gweather-location.c:
(gweather_location_get_children)
(gweather_location_free_children): Make the memory-management here
less lame. #562274
* libgweather/gweather-timezone.c:
* libgweather/location-entry.c:
* libgweather/timezone-menu.c: Add some docs. #562261
* doc/Makefile.am (IGNORE_HFILES): set this
* doc/libgweather-sections.txt: update
* doc/libgweather-docs.sgml: fix (some)
svn path=/trunk/; revision=527
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 2 | ||||
-rw-r--r-- | doc/libgweather-docs.sgml | 16 | ||||
-rw-r--r-- | doc/libgweather-sections.txt | 78 | ||||
-rw-r--r-- | doc/tmpl/gweather-enum-types.sgml | 2 | ||||
-rw-r--r-- | doc/tmpl/gweather-gconf.sgml | 2 | ||||
-rw-r--r-- | doc/tmpl/gweather-location.sgml | 17 | ||||
-rw-r--r-- | doc/tmpl/gweather-prefs.sgml | 2 | ||||
-rw-r--r-- | doc/tmpl/gweather-timezone.sgml | 17 | ||||
-rw-r--r-- | doc/tmpl/gweather-xml.sgml | 2 | ||||
-rw-r--r-- | doc/tmpl/libgweather-unused.sgml | 493 | ||||
-rw-r--r-- | doc/tmpl/location-entry.sgml | 2 | ||||
-rw-r--r-- | doc/tmpl/parser.sgml | 2 | ||||
-rw-r--r-- | doc/tmpl/timezone-menu.sgml | 2 | ||||
-rw-r--r-- | doc/tmpl/weather-priv.sgml | 2 | ||||
-rw-r--r-- | doc/tmpl/weather.sgml | 35 |
15 files changed, 505 insertions, 169 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index e72ac4d..9edb7f6 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -48,7 +48,7 @@ CFILE_GLOB=$(top_srcdir)/libgweather/*.c # Header files to ignore when scanning. # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h -IGNORE_HFILES= +IGNORE_HFILES=gweather-enum-types.h parser.h weather-priv.h # Images to copy into HTML directory. # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png diff --git a/doc/libgweather-docs.sgml b/doc/libgweather-docs.sgml index f8911e7..08c3b05 100644 --- a/doc/libgweather-docs.sgml +++ b/doc/libgweather-docs.sgml @@ -1,10 +1,7 @@ <?xml version="1.0"?> <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> -]> -<book id="index"> + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> +<book id="index" xmlns:xi="http://www.w3.org/2001/XInclude"> <bookinfo> <title>libgweather Reference Manual</title> <releaseinfo> @@ -16,16 +13,13 @@ <chapter> <title>[Insert title here]</title> - <xi:include href="xml/timezone-menu.xml"/> + <xi:include href="xml/gweather-location.xml"/> <xi:include href="xml/location-entry.xml"/> - <xi:include href="xml/gweather-enum-types.xml"/> <xi:include href="xml/gweather-timezone.xml"/> - <xi:include href="xml/parser.xml"/> + <xi:include href="xml/timezone-menu.xml"/> + <xi:include href="xml/weather.xml"/> <xi:include href="xml/gweather-xml.xml"/> <xi:include href="xml/gweather-gconf.xml"/> <xi:include href="xml/gweather-prefs.xml"/> - <xi:include href="xml/weather-priv.xml"/> - <xi:include href="xml/gweather-location.xml"/> - <xi:include href="xml/weather.xml"/> </chapter> </book> diff --git a/doc/libgweather-sections.txt b/doc/libgweather-sections.txt index 725e6f0..2da85f9 100644 --- a/doc/libgweather-sections.txt +++ b/doc/libgweather-sections.txt @@ -34,16 +34,8 @@ GWEATHER_LOCATION_ENTRY_GET_CLASS </SECTION> <SECTION> -<FILE>gweather-enum-types</FILE> -gweather_location_level_get_type -GWEATHER_TYPE_LOCATION_LEVEL -</SECTION> - -<SECTION> <FILE>gweather-timezone</FILE> GWeatherTimezone -gweather_timezone_get_type -GWEATHER_TYPE_TIMEZONE gweather_timezone_get_name gweather_timezone_get_tzid gweather_timezone_get_offset @@ -51,16 +43,9 @@ gweather_timezone_has_dst gweather_timezone_get_dst_offset gweather_timezone_ref gweather_timezone_unref -</SECTION> - -<SECTION> -<FILE>parser</FILE> -GWeatherParser -gweather_parser_new -gweather_parser_free -gweather_parser_get_value -gweather_parser_get_localized_value -gweather_timezones_parse_xml +<SUBSECTION Standard> +gweather_timezone_get_type +GWEATHER_TYPE_TIMEZONE </SECTION> <SECTION> @@ -105,63 +90,9 @@ gweather_prefs_get_distance_display_name </SECTION> <SECTION> -<FILE>weather-priv</FILE> -gweather_gettext -_ -N_ -WEATHER_LOCATION_CODE_LEN -gweather_location_to_weather_location -WeatherConditions -WeatherTemperature -WeatherHumidity -WeatherWindSpeed -WeatherPressure -WeatherVisibility -WeatherUpdate -WeatherInfo -weather_wind_direction_string -weather_sky_string -weather_conditions_string -DATA_SIZE -CONST_DIGITS -CONST_ALPHABET -TEMP_F_TO_C -TEMP_F_TO_K -TEMP_C_TO_F -WINDSPEED_KNOTS_TO_KPH -WINDSPEED_KNOTS_TO_MPH -WINDSPEED_KNOTS_TO_MS -WINDSPEED_MS_TO_KNOTS -WINDSPEED_KNOTS_TO_BFT -PRESSURE_INCH_TO_KPA -PRESSURE_INCH_TO_HPA -PRESSURE_INCH_TO_MM -PRESSURE_INCH_TO_MB -PRESSURE_INCH_TO_ATM -PRESSURE_MBAR_TO_INCH -VISIBILITY_SM_TO_KM -VISIBILITY_SM_TO_M -DEGREES_TO_RADIANS -RADIANS_TO_DEGREES -RADIANS_TO_HOURS -metar_start_open -iwin_start_open -metoffice_start_open -bom_start_open -wx_start_open -metar_parse -requests_init -request_done -calc_sun -free_forecast_list -</SECTION> - -<SECTION> <FILE>gweather-location</FILE> GWeatherLocation GWeatherLocationLevel -gweather_location_get_type -GWEATHER_TYPE_LOCATION gweather_location_new_world gweather_location_ref gweather_location_unref @@ -181,6 +112,9 @@ gweather_location_free_timezones gweather_location_get_code gweather_location_get_city_name gweather_location_get_weather +<SUBSECTION Standard> +gweather_location_get_type +GWEATHER_TYPE_LOCATION </SECTION> <SECTION> diff --git a/doc/tmpl/gweather-enum-types.sgml b/doc/tmpl/gweather-enum-types.sgml index 051f38d..401043f 100644 --- a/doc/tmpl/gweather-enum-types.sgml +++ b/doc/tmpl/gweather-enum-types.sgml @@ -9,13 +9,11 @@ gweather-enum-types </para> - <!-- ##### SECTION See_Also ##### --> <para> </para> - <!-- ##### SECTION Stability_Level ##### --> diff --git a/doc/tmpl/gweather-gconf.sgml b/doc/tmpl/gweather-gconf.sgml index 95fe209..771d86c 100644 --- a/doc/tmpl/gweather-gconf.sgml +++ b/doc/tmpl/gweather-gconf.sgml @@ -9,13 +9,11 @@ gweather-gconf </para> - <!-- ##### SECTION See_Also ##### --> <para> </para> - <!-- ##### SECTION Stability_Level ##### --> diff --git a/doc/tmpl/gweather-location.sgml b/doc/tmpl/gweather-location.sgml index 387d54a..8465e39 100644 --- a/doc/tmpl/gweather-location.sgml +++ b/doc/tmpl/gweather-location.sgml @@ -9,13 +9,11 @@ gweather-location </para> - <!-- ##### SECTION See_Also ##### --> <para> </para> - <!-- ##### SECTION Stability_Level ##### --> @@ -38,21 +36,6 @@ gweather-location @GWEATHER_LOCATION_CITY: @GWEATHER_LOCATION_WEATHER_STATION: -<!-- ##### FUNCTION gweather_location_get_type ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### MACRO GWEATHER_TYPE_LOCATION ##### --> -<para> - -</para> - - - <!-- ##### FUNCTION gweather_location_new_world ##### --> <para> diff --git a/doc/tmpl/gweather-prefs.sgml b/doc/tmpl/gweather-prefs.sgml index 2d550dd..4ef170b 100644 --- a/doc/tmpl/gweather-prefs.sgml +++ b/doc/tmpl/gweather-prefs.sgml @@ -9,13 +9,11 @@ gweather-prefs </para> - <!-- ##### SECTION See_Also ##### --> <para> </para> - <!-- ##### SECTION Stability_Level ##### --> diff --git a/doc/tmpl/gweather-timezone.sgml b/doc/tmpl/gweather-timezone.sgml index 22c773e..58ebd47 100644 --- a/doc/tmpl/gweather-timezone.sgml +++ b/doc/tmpl/gweather-timezone.sgml @@ -9,13 +9,11 @@ gweather-timezone </para> - <!-- ##### SECTION See_Also ##### --> <para> </para> - <!-- ##### SECTION Stability_Level ##### --> @@ -25,21 +23,6 @@ gweather-timezone </para> -<!-- ##### FUNCTION gweather_timezone_get_type ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### MACRO GWEATHER_TYPE_TIMEZONE ##### --> -<para> - -</para> - - - <!-- ##### FUNCTION gweather_timezone_get_name ##### --> <para> diff --git a/doc/tmpl/gweather-xml.sgml b/doc/tmpl/gweather-xml.sgml index 44b1519..4314356 100644 --- a/doc/tmpl/gweather-xml.sgml +++ b/doc/tmpl/gweather-xml.sgml @@ -9,13 +9,11 @@ gweather-xml </para> - <!-- ##### SECTION See_Also ##### --> <para> </para> - <!-- ##### SECTION Stability_Level ##### --> diff --git a/doc/tmpl/libgweather-unused.sgml b/doc/tmpl/libgweather-unused.sgml index e69de29..d8905bb 100644 --- a/doc/tmpl/libgweather-unused.sgml +++ b/doc/tmpl/libgweather-unused.sgml @@ -0,0 +1,493 @@ +<!-- ##### SECTION ./tmpl/gweather-enum-types.sgml:Long_Description ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gweather-enum-types.sgml:See_Also ##### --> +<para> + +</para> + + +<!-- ##### SECTION ./tmpl/gweather-enum-types.sgml:Short_Description ##### --> + + + +<!-- ##### SECTION ./tmpl/gweather-enum-types.sgml:Stability_Level ##### --> + + + +<!-- ##### SECTION ./tmpl/gweather-enum-types.sgml:Title ##### --> +gweather-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 GWEATHER_TYPE_LOCATION ##### --> +<para> + +</para> + + +<!-- ##### MACRO GWEATHER_TYPE_LOCATION_LEVEL ##### --> +<para> + +</para> + + +<!-- ##### MACRO GWEATHER_TYPE_TIMEZONE ##### --> +<para> + +</para> + + +<!-- ##### STRUCT GWeatherParser ##### --> +<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 gweather_gettext ##### --> +<para> + +</para> + +@str: +@Returns: + +<!-- ##### FUNCTION gweather_location_get_type ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION gweather_location_level_get_type ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION gweather_location_to_weather_location ##### --> +<para> + +</para> + +@gloc: +@name: +@Returns: + +<!-- ##### FUNCTION gweather_parser_free ##### --> +<para> + +</para> + +@parser: + +<!-- ##### FUNCTION gweather_parser_get_localized_value ##### --> +<para> + +</para> + +@parser: +@Returns: + +<!-- ##### FUNCTION gweather_parser_get_value ##### --> +<para> + +</para> + +@parser: +@Returns: + +<!-- ##### FUNCTION gweather_parser_new ##### --> +<para> + +</para> + +@use_regions: +@Returns: + +<!-- ##### FUNCTION gweather_timezone_get_type ##### --> +<para> + +</para> + +@Returns: + +<!-- ##### FUNCTION gweather_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 index 79d5096..84b90ec 100644 --- a/doc/tmpl/location-entry.sgml +++ b/doc/tmpl/location-entry.sgml @@ -9,13 +9,11 @@ GWeatherLocationEntry </para> - <!-- ##### SECTION See_Also ##### --> <para> </para> - <!-- ##### SECTION Stability_Level ##### --> diff --git a/doc/tmpl/parser.sgml b/doc/tmpl/parser.sgml index 798e5ce..c46df97 100644 --- a/doc/tmpl/parser.sgml +++ b/doc/tmpl/parser.sgml @@ -9,13 +9,11 @@ parser </para> - <!-- ##### SECTION See_Also ##### --> <para> </para> - <!-- ##### SECTION Stability_Level ##### --> diff --git a/doc/tmpl/timezone-menu.sgml b/doc/tmpl/timezone-menu.sgml index 10819ae..b52e065 100644 --- a/doc/tmpl/timezone-menu.sgml +++ b/doc/tmpl/timezone-menu.sgml @@ -9,13 +9,11 @@ GWeatherTimezoneMenu </para> - <!-- ##### SECTION See_Also ##### --> <para> </para> - <!-- ##### SECTION Stability_Level ##### --> diff --git a/doc/tmpl/weather-priv.sgml b/doc/tmpl/weather-priv.sgml index bd94b72..c0099a8 100644 --- a/doc/tmpl/weather-priv.sgml +++ b/doc/tmpl/weather-priv.sgml @@ -9,13 +9,11 @@ weather-priv </para> - <!-- ##### SECTION See_Also ##### --> <para> </para> - <!-- ##### SECTION Stability_Level ##### --> diff --git a/doc/tmpl/weather.sgml b/doc/tmpl/weather.sgml index a3a49c1..3df5ca6 100644 --- a/doc/tmpl/weather.sgml +++ b/doc/tmpl/weather.sgml @@ -9,13 +9,11 @@ weather </para> - <!-- ##### SECTION See_Also ##### --> <para> </para> - <!-- ##### SECTION Stability_Level ##### --> @@ -154,39 +152,6 @@ weather </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: <!-- ##### USER_FUNCTION WeatherInfoFunc ##### --> <para> |