GNOME.org
 

[libgweather] Fix and update documentation

commit e635731a99ddd13bbf82b08862af12da42e1ec18
Author: Giovanni Campagna <gcampagna src gnome org>
Date:   Sun Dec 2 19:47:24 2012 +0100

    Fix and update documentation
    
    Add missing symbols to the right section and rename sections according
    the conventions from the gtk-doc manual.

 doc/libgweather-docs.sgml       |   11 ++---
 doc/libgweather-sections.txt    |   90 ++++++++++++++++++++++++++++++---------
 doc/libgweather.types           |    1 +
 libgweather/gweather-location.c |    2 +-
 libgweather/gweather-timezone.c |    6 +-
 libgweather/gweather-weather.h  |    2 -
 libgweather/location-entry.c    |    2 +-
 libgweather/timezone-menu.c     |    2 +-
 libgweather/weather-iwin.c      |    2 +-
 libgweather/weather.c           |   15 ++++--
 10 files changed, 93 insertions(+), 40 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
diff --git a/libgweather/gweather-location.c b/libgweather/gweather-location.c
index a2a5f4d..8cfd6bf 100644
--- a/libgweather/gweather-location.c
+++ b/libgweather/gweather-location.c
@@ -831,7 +831,7 @@ gweather_location_ref_world (GWeatherLocation *loc)
 }
 
 /**
- * gweather_location_equals:
+ * gweather_location_equal:
  * @one: a #GWeatherLocation
  * @two: another #GWeatherLocation
  *
diff --git a/libgweather/gweather-timezone.c b/libgweather/gweather-timezone.c
index 2e49e5c..6b7f5dd 100644
--- a/libgweather/gweather-timezone.c
+++ b/libgweather/gweather-timezone.c
@@ -30,7 +30,7 @@
 #include "weather-priv.h"
 
 /**
- * SECTION:gweather-timezone
+ * SECTION:gweathertimezone
  * @Title: GWeatherTimezone
  *
  * A timezone.
@@ -361,7 +361,7 @@ gweather_timezone_get_tzid (GWeatherTimezone *zone)
  * @zone: a #GWeatherTimezone
  *
  * Gets @zone's standard offset from UTC, in minutes. Eg, a value of
- * %120 would indicate "GMT+2".
+ * 120 would indicate "GMT+2".
  *
  * Return value: @zone's standard offset, in minutes
  **/
@@ -392,7 +392,7 @@ gweather_timezone_has_dst (GWeatherTimezone *zone)
  * @zone: a #GWeatherTimezone
  *
  * Gets @zone's daylight/summer time offset from UTC, in minutes. Eg,
- * a value of %120 would indicate "GMT+2". This is only meaningful if
+ * a value of 120 would indicate "GMT+2". This is only meaningful if
  * gweather_timezone_has_dst() returns %TRUE.
  *
  * Return value: @zone's daylight/summer time offset, in minutes
diff --git a/libgweather/gweather-weather.h b/libgweather/gweather-weather.h
index ed8146b..a5f9d1f 100644
--- a/libgweather/gweather-weather.h
+++ b/libgweather/gweather-weather.h
@@ -74,8 +74,6 @@ struct _GWeatherInfoClass {
     void (*updated) (GWeatherInfo *info);
 };
 
-typedef void (*GWeatherInfoFunc) (GWeatherInfo *info, gpointer data);
-
 GType                    gweather_info_get_type            (void) G_GNUC_CONST;
 GWeatherInfo *           gweather_info_new                 (GWeatherLocation *location,
 							    GWeatherForecastType forecast_type);
diff --git a/libgweather/location-entry.c b/libgweather/location-entry.c
index 864ccdf..594b796 100644
--- a/libgweather/location-entry.c
+++ b/libgweather/location-entry.c
@@ -29,7 +29,7 @@
 #include "weather-priv.h"
 
 /**
- * SECTION:location-entry
+ * SECTION:gweatherlocationentry
  * @Title: GWeatherLocationEntry
  *
  * A subclass of #GtkEntry that provides autocompletion on
diff --git a/libgweather/timezone-menu.c b/libgweather/timezone-menu.c
index f34fa3c..01a7045 100644
--- a/libgweather/timezone-menu.c
+++ b/libgweather/timezone-menu.c
@@ -29,7 +29,7 @@
 #include <string.h>
 
 /**
- * SECTION:timezone-menu
+ * SECTION:gtimezonemenu
  * @Title: GWeatherTimezoneMenu
  *
  * A #GtkComboBox subclass for choosing a #GWeatherTimezone
diff --git a/libgweather/weather-iwin.c b/libgweather/weather-iwin.c
index 2c255f8..eb55939 100644
--- a/libgweather/weather-iwin.c
+++ b/libgweather/weather-iwin.c
@@ -29,7 +29,7 @@
 #define GWEATHER_I_KNOW_THIS_IS_UNSTABLE
 #include "weather-priv.h"
 
-/**
+/*
  *  Humans don't deal well with .MONDAY...SUNNY AND BLAH BLAH.TUESDAY...THEN THIS AND THAT.WEDNESDAY...RAINY BLAH BLAH.
  *  This function makes it easier to read.
  */
diff --git a/libgweather/weather.c b/libgweather/weather.c
index e360440..d39ad66 100644
--- a/libgweather/weather.c
+++ b/libgweather/weather.c
@@ -47,13 +47,18 @@
 
 
 /**
- * SECTION:gweather-info
+ * SECTION:gweatherinfo
  * @Title: GWeatherInfo
+ *
+ * #GWeatherInfo provides a handy way to access weather conditions
+ * and forecasts from a #GWeatherLocation, aggregating multiple
+ * different web services.
+ *
+ * It includes also astronomical data such as sunrise times and
+ * moon phases.
  */
 
 
-static void _weather_internal_check (void);
-
 #define TEMPERATURE_UNIT "temperature-unit"
 #define DISTANCE_UNIT    "distance-unit"
 #define SPEED_UNIT       "speed-unit"
@@ -1869,7 +1874,7 @@ gweather_info_class_init (GWeatherInfoClass *klass)
  * @forecast_type: the type of forecast requested
  *
  * Builds a new #GWeatherInfo that will provide weather information about
- * @location. The returned info will not be ready until the ::updated signal
+ * @location. The returned info will not be ready until the #GWeatherInfo::updated signal
  * is emitted.
  *
  * Returns: (transfer full): a new #GWeatherInfo
@@ -1895,7 +1900,7 @@ gweather_info_new (GWeatherLocation    *location,
  * @location: (allow-none): the desidered #GWeatherLocation (NULL for default)
  * @forecast_type: the type of forecast requested
  *
- * Similar to g_weather_info_new(), but also has a @world parameter, that allow controlling
+ * Similar to gweather_info_new(), but also has a @world parameter, that allow controlling
  * the hierarchy of #GWeatherLocation to which @location (or the default one taken from
  * GSettings) belongs.
  *
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]