diff options
author | Vincent Untz <vuntz@gnome.org> | 2010-07-02 11:42:45 +0200 |
---|---|---|
committer | Vincent Untz <vuntz@gnome.org> | 2010-07-02 11:45:31 +0200 |
commit | c301fd226bf9b20c7bd9f52243744fdc27470bbd (patch) | |
tree | cb5044e9bc87ef1cef82211ce8aafc5156e6393f /doc | |
parent | 8cbf22ba7777b2c18d857cd69df13d81e5fcfd72 (diff) | |
download | libgweather-c301fd226bf9b20c7bd9f52243744fdc27470bbd.tar.gz |
Port to GTK+ 3.0, add introspection support and bump version to 2.90.1
The library should be parallel-installable with the GTK+ 2.0 version.
The python bindings were removed, and replaced by introspection support,
since it's likely that the bindings would have caused issues with GTK+
3.0.
Diffstat (limited to 'doc')
-rw-r--r-- | doc/Makefile.am | 4 | ||||
-rw-r--r-- | doc/libgweather-3.0-docs.sgml (renamed from doc/libgweather-docs.sgml) | 34 | ||||
-rw-r--r-- | doc/libgweather-3.0-overrides.txt (renamed from doc/libgweather-overrides.txt) | 0 | ||||
-rw-r--r-- | doc/libgweather-3.0-sections.txt (renamed from doc/libgweather-sections.txt) | 125 | ||||
-rw-r--r-- | doc/libgweather-3.0.types (renamed from doc/libgweather.types) | 5 | ||||
-rw-r--r-- | doc/tmpl/gweather-gconf.sgml | 3 | ||||
-rw-r--r-- | doc/tmpl/gweather-location.sgml | 19 | ||||
-rw-r--r-- | doc/tmpl/gweather-prefs.sgml | 3 | ||||
-rw-r--r-- | doc/tmpl/gweather-timezone.sgml | 28 | ||||
-rw-r--r-- | doc/tmpl/gweather-xml.sgml | 12 | ||||
-rw-r--r-- | doc/tmpl/location-entry.sgml | 19 | ||||
-rw-r--r-- | doc/tmpl/timezone-menu.sgml | 10 | ||||
-rw-r--r-- | doc/tmpl/weather.sgml | 36 |
13 files changed, 224 insertions, 74 deletions
diff --git a/doc/Makefile.am b/doc/Makefile.am index 8b21afd..4c30709 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -4,7 +4,7 @@ AUTOMAKE_OPTIONS = 1.6 # The name of the module, e.g. 'glib'. -DOC_MODULE=libgweather +DOC_MODULE=libgweather-3.0 # Uncomment for versioned docs and specify the version of the module, e.g. '2'. #DOC_MODULE_VERSION=2 @@ -69,7 +69,7 @@ expand_content_files= # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS) # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib) GTKDOC_CFLAGS = -I$(top_srcdir) $(GTK_CFLAGS) $(LIBXML_CFLAGS) $(LIBSOUP_CFLAGS) $(GCONF_CFLAGS) -DGWEATHER_I_KNOW_THIS_IS_UNSTABLE -GTKDOC_LIBS = $(top_builddir)/libgweather/libgweather.la $(GTK_LIBS) $(LIBXML_LIBS) $(LIBSOUP_LIBS) $(GCONF_LIBS) +GTKDOC_LIBS = $(top_builddir)/libgweather/libgweather-3.la $(GTK_LIBS) $(LIBXML_LIBS) $(LIBSOUP_LIBS) $(GCONF_LIBS) # This includes the standard gtk-doc make rules, copied by gtkdocize. include $(top_srcdir)/gtk-doc.make diff --git a/doc/libgweather-docs.sgml b/doc/libgweather-3.0-docs.sgml index 08c3b05..2dbb507 100644 --- a/doc/libgweather-docs.sgml +++ b/doc/libgweather-3.0-docs.sgml @@ -1,25 +1,39 @@ <?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"> -<book id="index" xmlns:xi="http://www.w3.org/2001/XInclude"> + "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"> <bookinfo> - <title>libgweather Reference Manual</title> + <title>libgweather-3.0 Reference Manual</title> <releaseinfo> - for libgweather [VERSION] + for libgweather-3.0 [VERSION]. The latest version of this documentation can be found on-line at - <ulink role="online-location" url="http://[SERVER]/libgweather/index.html">http://[SERVER]/libgweather/</ulink>. + <ulink role="online-location" url="http://[SERVER]/libgweather-3.0/index.html">http://[SERVER]/libgweather-3.0/</ulink>. </releaseinfo> </bookinfo> <chapter> <title>[Insert title here]</title> - <xi:include href="xml/gweather-location.xml"/> + <xi:include href="xml/timezone-menu.xml"/> <xi:include href="xml/location-entry.xml"/> - <xi:include href="xml/gweather-timezone.xml"/> - <xi:include href="xml/timezone-menu.xml"/> + <xi:include href="xml/gweather-location.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/gweather-gconf.xml"/> + <xi:include href="xml/gweather-xml.xml"/> + <xi:include href="xml/gweather-timezone.xml"/> + </chapter> + <chapter id="object-tree"> + <title>Object Hierarchy</title> + <xi:include href="xml/tree_index.sgml"/> + </chapter> + <index id="api-index-full"> + <title>API Index</title> + <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> + </index> + + <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> </book> diff --git a/doc/libgweather-overrides.txt b/doc/libgweather-3.0-overrides.txt index e69de29..e69de29 100644 --- a/doc/libgweather-overrides.txt +++ b/doc/libgweather-3.0-overrides.txt diff --git a/doc/libgweather-sections.txt b/doc/libgweather-3.0-sections.txt index 2da85f9..2b9105d 100644 --- a/doc/libgweather-sections.txt +++ b/doc/libgweather-3.0-sections.txt @@ -2,6 +2,7 @@ <FILE>timezone-menu</FILE> <TITLE>GWeatherTimezoneMenu</TITLE> GWeatherTimezoneMenu +GWeatherTimezoneMenuClass gweather_timezone_menu_new gweather_timezone_menu_set_tzid gweather_timezone_menu_get_tzid @@ -19,9 +20,11 @@ GWEATHER_TIMEZONE_MENU_GET_CLASS <FILE>location-entry</FILE> <TITLE>GWeatherLocationEntry</TITLE> GWeatherLocationEntry +GWeatherLocationEntryClass gweather_location_entry_new gweather_location_entry_set_location gweather_location_entry_get_location +gweather_location_entry_has_custom_text gweather_location_entry_set_city <SUBSECTION Standard> GWEATHER_LOCATION_ENTRY @@ -34,65 +37,11 @@ GWEATHER_LOCATION_ENTRY_GET_CLASS </SECTION> <SECTION> -<FILE>gweather-timezone</FILE> -GWeatherTimezone -gweather_timezone_get_name -gweather_timezone_get_tzid -gweather_timezone_get_offset -gweather_timezone_has_dst -gweather_timezone_get_dst_offset -gweather_timezone_ref -gweather_timezone_unref -<SUBSECTION Standard> -gweather_timezone_get_type -GWEATHER_TYPE_TIMEZONE -</SECTION> - -<SECTION> -<FILE>gweather-xml</FILE> -gweather_xml_load_locations -</SECTION> - -<SECTION> -<FILE>gweather-gconf</FILE> -GWeatherGConf -gweather_gconf_new -gweather_gconf_free -gweather_gconf_get_client -gweather_gconf_get_location -gweather_gconf_get_full_key -gweather_gconf_set_bool -gweather_gconf_set_int -gweather_gconf_set_string -gweather_gconf_get_bool -gweather_gconf_get_int -gweather_gconf_get_string -</SECTION> - -<SECTION> -<FILE>gweather-prefs</FILE> -GCONF_TEMP_UNIT -GCONF_SPEED_UNIT -GCONF_PRESSURE_UNIT -GCONF_DISTANCE_UNIT -GWeatherPrefs -gweather_prefs_load -gweather_prefs_temp_enum_to_string -gweather_prefs_speed_enum_to_string -gweather_prefs_pressure_enum_to_string -gweather_prefs_distance_enum_to_string -gweather_prefs_parse_temperature -gweather_prefs_parse_speed -gweather_prefs_get_temp_display_name -gweather_prefs_get_speed_display_name -gweather_prefs_get_pressure_display_name -gweather_prefs_get_distance_display_name -</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 @@ -112,9 +61,6 @@ 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> @@ -168,6 +114,8 @@ WeatherWindDirection WeatherSky WeatherConditionPhenomenon WeatherConditionQualifier +WeatherMoonPhase +WeatherMoonLatitude weather_info_get_value_update weather_info_get_value_sky weather_info_get_value_conditions @@ -181,5 +129,64 @@ weather_info_get_value_pressure weather_info_get_value_visibility weather_info_get_value_sunrise weather_info_get_value_sunset +weather_info_get_value_moonphase +weather_info_get_upcoming_moonphases +</SECTION> + +<SECTION> +<FILE>gweather-prefs</FILE> +GCONF_TEMP_UNIT +GCONF_SPEED_UNIT +GCONF_PRESSURE_UNIT +GCONF_DISTANCE_UNIT +GWeatherPrefs +gweather_prefs_load +gweather_prefs_temp_enum_to_string +gweather_prefs_speed_enum_to_string +gweather_prefs_pressure_enum_to_string +gweather_prefs_distance_enum_to_string +gweather_prefs_parse_temperature +gweather_prefs_parse_speed +gweather_prefs_get_temp_display_name +gweather_prefs_get_speed_display_name +gweather_prefs_get_pressure_display_name +gweather_prefs_get_distance_display_name +</SECTION> + +<SECTION> +<FILE>gweather-gconf</FILE> +GWeatherGConf +gweather_gconf_new +gweather_gconf_free +gweather_gconf_get_client +gweather_gconf_get_location +gweather_gconf_get_full_key +gweather_gconf_set_bool +gweather_gconf_set_int +gweather_gconf_set_string +gweather_gconf_get_bool +gweather_gconf_get_int +gweather_gconf_get_string +</SECTION> + +<SECTION> +<FILE>gweather-xml</FILE> +gweather_xml_load_locations +gweather_xml_free_locations +</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 +gweather_timezone_has_dst +gweather_timezone_get_dst_offset +gweather_timezone_ref +gweather_timezone_unref +gweather_timezone_get_utc </SECTION> diff --git a/doc/libgweather.types b/doc/libgweather-3.0.types index ae55363..c4d6cac 100644 --- a/doc/libgweather.types +++ b/doc/libgweather-3.0.types @@ -1,5 +1,4 @@ -gweather_location_level_get_type -gweather_timezone_get_type -gweather_timezone_menu_get_type gweather_location_entry_get_type gweather_location_get_type +gweather_timezone_get_type +gweather_timezone_menu_get_type diff --git a/doc/tmpl/gweather-gconf.sgml b/doc/tmpl/gweather-gconf.sgml index 771d86c..205ae72 100644 --- a/doc/tmpl/gweather-gconf.sgml +++ b/doc/tmpl/gweather-gconf.sgml @@ -17,6 +17,9 @@ gweather-gconf <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### SECTION Image ##### --> + + <!-- ##### STRUCT GWeatherGConf ##### --> <para> diff --git a/doc/tmpl/gweather-location.sgml b/doc/tmpl/gweather-location.sgml index 8465e39..c4e38e5 100644 --- a/doc/tmpl/gweather-location.sgml +++ b/doc/tmpl/gweather-location.sgml @@ -17,6 +17,9 @@ gweather-location <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### SECTION Image ##### --> + + <!-- ##### STRUCT GWeatherLocation ##### --> <para> @@ -36,6 +39,22 @@ gweather-location @GWEATHER_LOCATION_CITY: @GWEATHER_LOCATION_WEATHER_STATION: +<!-- ##### FUNCTION gweather_location_get_type ##### --> +<para> + +</para> + +@void: +@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 4ef170b..162348a 100644 --- a/doc/tmpl/gweather-prefs.sgml +++ b/doc/tmpl/gweather-prefs.sgml @@ -17,6 +17,9 @@ gweather-prefs <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### SECTION Image ##### --> + + <!-- ##### MACRO GCONF_TEMP_UNIT ##### --> <para> diff --git a/doc/tmpl/gweather-timezone.sgml b/doc/tmpl/gweather-timezone.sgml index 58ebd47..70078ca 100644 --- a/doc/tmpl/gweather-timezone.sgml +++ b/doc/tmpl/gweather-timezone.sgml @@ -17,12 +17,31 @@ gweather-timezone <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### SECTION Image ##### --> + + <!-- ##### STRUCT GWeatherTimezone ##### --> <para> </para> +<!-- ##### FUNCTION gweather_timezone_get_type ##### --> +<para> + +</para> + +@void: +@Returns: + + +<!-- ##### MACRO GWEATHER_TYPE_TIMEZONE ##### --> +<para> + +</para> + + + <!-- ##### FUNCTION gweather_timezone_get_name ##### --> <para> @@ -85,3 +104,12 @@ gweather-timezone @zone: +<!-- ##### FUNCTION gweather_timezone_get_utc ##### --> +<para> + +</para> + +@void: +@Returns: + + diff --git a/doc/tmpl/gweather-xml.sgml b/doc/tmpl/gweather-xml.sgml index 4314356..6c072d2 100644 --- a/doc/tmpl/gweather-xml.sgml +++ b/doc/tmpl/gweather-xml.sgml @@ -17,11 +17,23 @@ gweather-xml <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### SECTION Image ##### --> + + <!-- ##### FUNCTION gweather_xml_load_locations ##### --> <para> </para> +@void: @Returns: +<!-- ##### FUNCTION gweather_xml_free_locations ##### --> +<para> + +</para> + +@locations: + + diff --git a/doc/tmpl/location-entry.sgml b/doc/tmpl/location-entry.sgml index 46f58ae..e3f04fd 100644 --- a/doc/tmpl/location-entry.sgml +++ b/doc/tmpl/location-entry.sgml @@ -17,6 +17,9 @@ GWeatherLocationEntry <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### SECTION Image ##### --> + + <!-- ##### STRUCT GWeatherLocationEntry ##### --> <para> @@ -33,6 +36,13 @@ GWeatherLocationEntry </para> +<!-- ##### STRUCT GWeatherLocationEntryClass ##### --> +<para> + +</para> + +@parent_class: + <!-- ##### FUNCTION gweather_location_entry_new ##### --> <para> @@ -60,6 +70,15 @@ GWeatherLocationEntry @Returns: +<!-- ##### FUNCTION gweather_location_entry_has_custom_text ##### --> +<para> + +</para> + +@entry: +@Returns: + + <!-- ##### FUNCTION gweather_location_entry_set_city ##### --> <para> diff --git a/doc/tmpl/timezone-menu.sgml b/doc/tmpl/timezone-menu.sgml index b52e065..dc1a350 100644 --- a/doc/tmpl/timezone-menu.sgml +++ b/doc/tmpl/timezone-menu.sgml @@ -17,6 +17,9 @@ GWeatherTimezoneMenu <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### SECTION Image ##### --> + + <!-- ##### STRUCT GWeatherTimezoneMenu ##### --> <para> @@ -33,6 +36,13 @@ GWeatherTimezoneMenu </para> +<!-- ##### STRUCT GWeatherTimezoneMenuClass ##### --> +<para> + +</para> + +@parent_class: + <!-- ##### FUNCTION gweather_timezone_menu_new ##### --> <para> diff --git a/doc/tmpl/weather.sgml b/doc/tmpl/weather.sgml index 3df6757..80d733f 100644 --- a/doc/tmpl/weather.sgml +++ b/doc/tmpl/weather.sgml @@ -17,6 +17,9 @@ weather <!-- ##### SECTION Stability_Level ##### --> +<!-- ##### SECTION Image ##### --> + + <!-- ##### STRUCT WeatherLocation ##### --> <para> @@ -541,6 +544,18 @@ weather @QUALIFIER_FREEZING: @QUALIFIER_LAST: +<!-- ##### TYPEDEF WeatherMoonPhase ##### --> +<para> + +</para> + + +<!-- ##### TYPEDEF WeatherMoonLatitude ##### --> +<para> + +</para> + + <!-- ##### FUNCTION weather_info_get_value_update ##### --> <para> @@ -681,3 +696,24 @@ weather @Returns: +<!-- ##### FUNCTION weather_info_get_value_moonphase ##### --> +<para> + +</para> + +@info: +@value: +@lat: +@Returns: + + +<!-- ##### FUNCTION weather_info_get_upcoming_moonphases ##### --> +<para> + +</para> + +@info: +@phases: +@Returns: + + |