summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorGiovanni Campagna <gcampagna@src.gnome.org>2012-12-02 19:47:24 +0100
committerGiovanni Campagna <gcampagna@src.gnome.org>2012-12-02 20:07:43 +0100
commite635731a99ddd13bbf82b08862af12da42e1ec18 (patch)
tree50cd2a970f8102396e87a6e379cc5ef5e116f988 /doc
parent9e675cf0c45420ee074db061349d0994c2ceba63 (diff)
downloadlibgweather-e635731a99ddd13bbf82b08862af12da42e1ec18.tar.gz
Fix and update documentation
Add missing symbols to the right section and rename sections according the conventions from the gtk-doc manual.
Diffstat (limited to 'doc')
-rw-r--r--doc/libgweather-docs.sgml11
-rw-r--r--doc/libgweather-sections.txt90
-rw-r--r--doc/libgweather.types1
3 files changed, 76 insertions, 26 deletions
diff --git a/doc/libgweather-docs.sgml b/doc/libgweather-docs.sgml
index aab7ea8..5838df5 100644
--- a/doc/libgweather-docs.sgml
+++ b/doc/libgweather-docs.sgml
@@ -16,12 +16,11 @@
<chapter>
<title>libgweather-3.0 Reference Manual</title>
- <xi:include href="xml/timezone-menu.xml"/>
- <xi:include href="xml/location-entry.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-timezone.xml"/>
+ <xi:include href="xml/gweatherlocation.xml"/>
+ <xi:include href="xml/gweathertimezone.xml"/>
+ <xi:include href="xml/gweatherinfo.xml"/>
+ <xi:include href="xml/gweatherlocationentry.xml"/>
+ <xi:include href="xml/gweathertimezonemenu.xml"/>
</chapter>
<chapter id="object-tree">
diff --git a/doc/libgweather-sections.txt b/doc/libgweather-sections.txt
index ac27685..c9f9f89 100644
--- a/doc/libgweather-sections.txt
+++ b/doc/libgweather-sections.txt
@@ -1,5 +1,5 @@
<SECTION>
-<FILE>timezone-menu</FILE>
+<FILE>gweathertimezonemenu</FILE>
<TITLE>GWeatherTimezoneMenu</TITLE>
GWeatherTimezoneMenu
GWeatherTimezoneMenuClass
@@ -17,7 +17,7 @@ GWEATHER_TIMEZONE_MENU_GET_CLASS
</SECTION>
<SECTION>
-<FILE>location-entry</FILE>
+<FILE>gweatherlocationentry</FILE>
<TITLE>GWeatherLocationEntry</TITLE>
GWeatherLocationEntry
GWeatherLocationEntryClass
@@ -37,45 +37,86 @@ GWEATHER_LOCATION_ENTRY_GET_CLASS
</SECTION>
<SECTION>
-<FILE>gweather-location</FILE>
+<FILE>gweatherlocation</FILE>
<TITLE>GWeatherLocation</TITLE>
GWeatherLocation
GWeatherLocationLevel
gweather_location_new_world
gweather_location_ref
gweather_location_unref
-gweather_location_get_name
-gweather_location_get_sort_name
+
+<SUBSECTION>
+gweather_location_serialize
+gweather_location_deserialize
+gweather_location_equal
+gweather_location_find_by_station_code
+
+<SUBSECTION>
gweather_location_get_level
gweather_location_get_parent
gweather_location_get_children
-gweather_location_free_children
+gweather_location_ref_world
+
+<SUBSECTION>
+gweather_location_get_name
+gweather_location_get_sort_name
gweather_location_has_coords
gweather_location_get_coords
gweather_location_get_distance
gweather_location_get_country
gweather_location_get_timezone
gweather_location_get_timezones
-gweather_location_free_timezones
gweather_location_get_code
gweather_location_get_city_name
+
+<SUBSECTION Private>
+gweather_location_free_children
+gweather_location_free_timezones
+
<SUBSECTION Standard>
GWEATHER_TYPE_LOCATION
gweather_location_get_type
</SECTION>
<SECTION>
-<FILE>weather</FILE>
+<FILE>gweatherinfo</FILE>
<TITLE>GWeatherInfo</TITLE>
+
+<SUBSECTION Standard>
GWeatherInfo
-GWeatherInfoFunc
+GWeatherInfoClass
+gweather_info_get_type
+GWEATHER_INFO
+GWEATHER_INFO_CLASS
+GWEATHER_INFO_GET_CLASS
+GWEATHER_IS_INFO
+GWEATHER_IS_INFO_CLASS
+GWEATHER_TYPE_INFO
+GWeatherInfoPrivate
+
+<SUBSECTION>
+GWeatherForecastType
gweather_info_new
+gweather_info_new_for_world
gweather_info_update
gweather_info_abort
gweather_info_is_valid
gweather_info_network_error
gweather_info_get_location
+gweather_info_set_location
+gweather_info_get_forecast_list
+
+<SUBSECTION>
+GWeatherProvider
+gweather_info_get_enabled_providers
+gweather_info_set_enabled_providers
+gweather_info_get_attribution
+
+<SUBSECTION>
gweather_info_get_location_name
+gweather_info_get_icon_name
+gweather_info_get_weather_summary
+gweather_info_get_temp_summary
gweather_info_get_update
gweather_info_get_sky
gweather_info_get_conditions
@@ -91,12 +132,25 @@ gweather_info_get_apparent
gweather_info_get_sunrise
gweather_info_get_sunset
gweather_info_get_forecast
-gweather_info_get_forecast_list
gweather_info_get_radar
-gweather_info_get_temp_summary
-gweather_info_get_weather_summary
-gweather_info_get_icon_name
-gweather_info_next_sun_event
+
+<SUBSECTION>
+GWeatherConditionPhenomenon
+GWeatherConditionQualifier
+GWeatherConditions
+gweather_conditions_to_string
+GWeatherSky
+gweather_sky_to_string
+GWeatherWindDirection
+gweather_wind_direction_to_string
+GWeatherMoonLatitude
+GWeatherMoonPhase
+GWeatherDistanceUnit
+GWeatherPressureUnit
+GWeatherSpeedUnit
+GWeatherTemperatureUnit
+
+<SUBSECTION>
gweather_info_get_value_update
gweather_info_get_value_sky
gweather_info_get_value_conditions
@@ -110,17 +164,13 @@ gweather_info_get_value_pressure
gweather_info_get_value_visibility
gweather_info_get_value_sunrise
gweather_info_get_value_sunset
+gweather_info_next_sun_event
gweather_info_get_value_moonphase
gweather_info_get_upcoming_moonphases
</SECTION>
<SECTION>
-<FILE>gweather-xml</FILE>
-gweather_xml_load_locations
-</SECTION>
-
-<SECTION>
-<FILE>gweather-timezone</FILE>
+<FILE>gweathertimezone</FILE>
GWeatherTimezone
gweather_timezone_get_type
GWEATHER_TYPE_TIMEZONE
diff --git a/doc/libgweather.types b/doc/libgweather.types
index c4d6cac..00a899b 100644
--- a/doc/libgweather.types
+++ b/doc/libgweather.types
@@ -2,3 +2,4 @@ gweather_location_entry_get_type
gweather_location_get_type
gweather_timezone_get_type
gweather_timezone_menu_get_type
+gweather_info_get_type \ No newline at end of file