[libgweather/ebassi/gtk4: 47/56] docs: Remove gtk-doc sections
- From: Emmanuele Bassi <ebassi src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libgweather/ebassi/gtk4: 47/56] docs: Remove gtk-doc sections
- Date: Wed, 13 Oct 2021 12:02:16 +0000 (UTC)
commit 8285d6d9ec1f17ed3975e0f49ee35ae34bc3d4f4
Author: Emmanuele Bassi <ebassi gnome org>
Date: Tue Oct 12 17:58:16 2021 +0100
docs: Remove gtk-doc sections
We're using gi-docgen, and we rely on types.
libgweather/gweather-location-entry.c | 7 +++----
libgweather/gweather-location.c | 10 ----------
libgweather/gweather-location.h | 10 ++++++++++
libgweather/gweather-timezone-menu.c | 5 ++---
libgweather/gweather-timezone.c | 5 ++---
libgweather/gweather-version.h.in | 8 --------
libgweather/gweather-weather.c | 9 +++------
7 files changed, 20 insertions(+), 34 deletions(-)
---
diff --git a/libgweather/gweather-location-entry.c b/libgweather/gweather-location-entry.c
index f41208ef..d0a4e2b4 100644
--- a/libgweather/gweather-location-entry.c
+++ b/libgweather/gweather-location-entry.c
@@ -15,11 +15,10 @@
#include <geocode-glib/geocode-glib.h>
/**
- * SECTION:gweatherlocationentry
- * @Title: GWeatherLocationEntry
+ * GWeatherLocationEntry:
*
- * A subclass of #GtkSearchEntry that provides autocompletion on
- * #GWeatherLocation<!-- -->s
+ * A subclass of [class@Gtk.SearchEntry] that provides autocompletion on
+ * [struct@GWeather.Location]s.
*/
struct _GWeatherLocationEntryPrivate {
diff --git a/libgweather/gweather-location.c b/libgweather/gweather-location.c
index 1f06b411..47c402fa 100644
--- a/libgweather/gweather-location.c
+++ b/libgweather/gweather-location.c
@@ -36,16 +36,6 @@ _iter_up(GWeatherLocation *loc)
}
#define ITER_UP(start, _p) for ((_p) = gweather_location_ref (start); (_p); (_p) = _iter_up(_p))
-/**
- * SECTION:gweatherlocation
- * @Title: GWeatherLocation
- *
- * A #GWeatherLocation represents a "location" of some type known to
- * libgweather; anything from a single weather station to the entire
- * world. See #GWeatherLocationLevel for information about how the
- * hierarchy of locations works.
- */
-
static GWeatherLocation *
location_new (GWeatherLocationLevel level)
{
diff --git a/libgweather/gweather-location.h b/libgweather/gweather-location.h
index 2ac74e7d..061f87c1 100644
--- a/libgweather/gweather-location.h
+++ b/libgweather/gweather-location.h
@@ -15,6 +15,16 @@
G_BEGIN_DECLS
+/**
+ * GWeatherLocation:
+ *
+ * A `GWeatherLocation` represents a "location" of some type known to
+ * libgweather; anything from a single weather station to the entire
+ * world.
+ *
+ * See [enum@GWeather.LocationLevel] for information about how the
+ * hierarchy of locations works.
+ */
typedef struct _GWeatherLocation GWeatherLocation;
typedef gboolean (* GWeatherFilterFunc) (GWeatherLocation* location, gpointer user_data);
diff --git a/libgweather/gweather-timezone-menu.c b/libgweather/gweather-timezone-menu.c
index 01a2851a..c2f5b99e 100644
--- a/libgweather/gweather-timezone-menu.c
+++ b/libgweather/gweather-timezone-menu.c
@@ -13,10 +13,9 @@
#include <string.h>
/**
- * SECTION:gweathertimezonemenu
- * @Title: GWeatherTimezoneMenu
+ * GWeatherTimezoneMenu:
*
- * A #GtkComboBox subclass for choosing a #GWeatherTimezone
+ * A [class@Gtk.ComboBox] subclass for choosing a [struct@GWeather.Timezone].
*/
G_DEFINE_TYPE (GWeatherTimezoneMenu, gweather_timezone_menu, GTK_TYPE_COMBO_BOX)
diff --git a/libgweather/gweather-timezone.c b/libgweather/gweather-timezone.c
index 27c43217..afb04589 100644
--- a/libgweather/gweather-timezone.c
+++ b/libgweather/gweather-timezone.c
@@ -13,10 +13,9 @@
#include <string.h>
/**
- * SECTION:gweathertimezone
- * @Title: GWeatherTimezone
+ * GWeatherTimezone:
*
- * A timezone.
+ * The representation of a timezone.
*
* Timezones are global to the GWeather world (as obtained by
* gweather_location_get_world()); they can be gotten by passing
diff --git a/libgweather/gweather-version.h.in b/libgweather/gweather-version.h.in
index 499af718..799e4010 100644
--- a/libgweather/gweather-version.h.in
+++ b/libgweather/gweather-version.h.in
@@ -36,14 +36,6 @@
# define GWEATHER_DEPRECATED_FOR(f) G_DEPRECATED_FOR(f) _GWEATHER_EXTERN
#endif
-/**
- * SECTION:gweatherversion
- * @short_description: libgweather version checking
- *
- * LibGweather provides macros to check the version of the library
- * at compile-time
- */
-
/**
* GWEATHER_MAJOR_VERSION:
*
diff --git a/libgweather/gweather-weather.c b/libgweather/gweather-weather.c
index 4a33def9..3e8b60a6 100644
--- a/libgweather/gweather-weather.c
+++ b/libgweather/gweather-weather.c
@@ -28,11 +28,10 @@
/**
- * SECTION:gweatherinfo
- * @Title: GWeatherInfo
+ * GWeatherInfo:
*
- * #GWeatherInfo provides a handy way to access weather conditions
- * and forecasts from a #GWeatherLocation, aggregating multiple
+ * `GWeatherInfo` provides a handy way to access weather conditions
+ * and forecasts from a [struct@GWeather.Location], aggregating multiple
* different web services.
*
* It includes also astronomical data such as sunrise times and
@@ -47,8 +46,6 @@
#define RADAR_KEY "radar"
#define DEFAULT_LOCATION "default-location"
-#include "gweather-private.h"
-
enum {
PROP_0,
PROP_LOCATION,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]