[libgweather] docs: Document deprecated API



commit ddaf74b32ebe5c32340d9c7be5bf2950d9aa48b5
Author: Javier Jardón <jjardon gnome org>
Date:   Wed Feb 19 16:16:53 2014 +0000

    docs: Document deprecated API

 libgweather/gweather-location.c |   14 +++++++++++++-
 libgweather/weather.c           |    7 ++++++-
 2 files changed, 19 insertions(+), 2 deletions(-)
---
diff --git a/libgweather/gweather-location.c b/libgweather/gweather-location.c
index 1bff142..2526a19 100644
--- a/libgweather/gweather-location.c
+++ b/libgweather/gweather-location.c
@@ -314,7 +314,19 @@ gweather_location_get_world (void)
     return global_world;
 }
 
-/* deprecated */
+/**
+ * gweather_location_new_world:
+ * @use_regions: whether or not to divide the world into regions
+ *
+ * Creates a new #GWeatherLocation of type %GWEATHER_LOCATION_WORLD,
+ * representing a hierarchy containing all of the locations from
+ * Locations.xml.
+ *
+ * Returns: (allow-none): a %GWEATHER_LOCATION_WORLD location, or
+ *   %NULL if Locations.xml could not be found or could not be parsed.
+ *
+ * Deprecated: 3.10: Use gweather_location_get_world() instead.
+ */
 GWeatherLocation *
 gweather_location_new_world (gboolean use_regions)
 {
diff --git a/libgweather/weather.c b/libgweather/weather.c
index 4140f1c..830797a 100644
--- a/libgweather/weather.c
+++ b/libgweather/weather.c
@@ -2204,7 +2204,12 @@ _gweather_info_new_clone (GWeatherInfo *other)
     return g_object_new (GWEATHER_TYPE_INFO, "location", other->priv->glocation, NULL);
 }
 
-/* deprecated */
+/**
+ * gweather_info_get_forecast:
+ * @info: a #GWeatherInfo
+ *
+ * Deprecated: 3.10: Use gweather_info_get_forecast_list() instead.
+ */
 char *
 gweather_info_get_forecast (GWeatherInfo *info)
 {


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]