[libshumate] misc: Fix various documentation warnings
- From: Corentin Noël <corentinnoel src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [libshumate] misc: Fix various documentation warnings
- Date: Thu, 13 Jan 2022 19:45:54 +0000 (UTC)
commit c055e0857f313c4fd7fc974e221dfda246e2bab9
Author: Corentin Noël <corentin noel collabora com>
Date: Thu Jan 13 20:45:37 2022 +0100
misc: Fix various documentation warnings
shumate/shumate-data-source.c | 7 ++++---
shumate/shumate-file-cache.c | 2 +-
shumate/shumate-map-source.c | 4 ++--
shumate/shumate-tile-downloader.c | 2 +-
shumate/shumate-vector-renderer.h | 4 ++--
5 files changed, 10 insertions(+), 9 deletions(-)
---
diff --git a/shumate/shumate-data-source.c b/shumate/shumate-data-source.c
index 84c54d9..35b859c 100644
--- a/shumate/shumate-data-source.c
+++ b/shumate/shumate-data-source.c
@@ -88,8 +88,8 @@ shumate_data_source_init (ShumateDataSource *self)
*
* Some data sources may return data multiple times. For example,
* [class@TileDownloader] may return data from a cache, then return updated
- * data from the network. [signal@received-data] is emitted each time
- * data is received, then @callback is called after the last update.
+ * data from the network. [signal@ShumateDataSource::received-data] is emitted
+ * each time data is received, then @callback is called after the last update.
*/
void
shumate_data_source_get_tile_data_async (ShumateDataSource *self,
@@ -116,7 +116,8 @@ shumate_data_source_get_tile_data_async (ShumateDataSource *self,
* Gets the final result of a request started with
* shumate_data_source_get_tile_data_async().
*
- * Returns: (transfer full)(nullable): The requested data, or %NULL if an error occurred
+ * Returns: (transfer full) (nullable): The requested data, or %NULL if an
+ * error occurred
*/
GBytes *
shumate_data_source_get_tile_data_finish (ShumateDataSource *self,
diff --git a/shumate/shumate-file-cache.c b/shumate/shumate-file-cache.c
index 3818176..367dc4f 100644
--- a/shumate/shumate-file-cache.c
+++ b/shumate/shumate-file-cache.c
@@ -22,7 +22,7 @@
* ShumateFileCache:
*
* A cache that stores and retrieves tiles from the file system. It is mainly
- * used by [class@NetworkTileSource], but can also be used by custom map
+ * used by [class@TileDownloader], but can also be used by custom data
* sources.
*
* The cache will be filled up to a certain size limit. When this limit is
diff --git a/shumate/shumate-map-source.c b/shumate/shumate-map-source.c
index ebde962..a6ceada 100644
--- a/shumate/shumate-map-source.c
+++ b/shumate/shumate-map-source.c
@@ -24,8 +24,8 @@
* with images from various sources: a web API, for example, or a test pattern
* generated on demand.
*
- * The most common map source is [class@NetworkTileSource], which fetches tiles
- * from an API.
+ * The most common map source is [class@RasterRenderer], which fetches tiles
+ * using a [class@TileDownloader].
*/
#include "shumate-map-source.h"
diff --git a/shumate/shumate-tile-downloader.c b/shumate/shumate-tile-downloader.c
index 5b3adda..41b3b8d 100644
--- a/shumate/shumate-tile-downloader.c
+++ b/shumate/shumate-tile-downloader.c
@@ -52,7 +52,7 @@ static GParamSpec *properties [N_PROPS];
* Creates a new [class@TileDownloader] that fetches tiles from an API and
* caches them on disk.
*
- * See [property@url-template] for the format of the URL template.
+ * See [property@TileDownloader:url-template] for the format of the URL template.
*
* Returns: (transfer full): a newly constructed [class@TileDownloader]
*/
diff --git a/shumate/shumate-vector-renderer.h b/shumate/shumate-vector-renderer.h
index 9cbde4e..1583e15 100644
--- a/shumate/shumate-vector-renderer.h
+++ b/shumate/shumate-vector-renderer.h
@@ -66,7 +66,7 @@ ShumateVectorRenderer *shumate_vector_renderer_new_full_from_url (const char
* SHUMATE_STYLE_ERROR:
*
* Error domain for errors that may occur when parsing a map style. Errors in
- * this domain will be from the [enum@StyleError] enum.
+ * this domain will be from the [error@StyleError] enum.
*/
#define SHUMATE_STYLE_ERROR shumate_style_error_quark ()
GQuark shumate_style_error_quark (void);
@@ -79,7 +79,7 @@ GQuark shumate_style_error_quark (void);
* @SHUMATE_STYLE_ERROR_INVALID_EXPRESSION: An invalid or unrecognized expression was encountered.
* @SHUMATE_STYLE_ERROR_SUPPORT_OMITTED: Libshumate was compiled without vector tile support.
*
- * Error codes in the [error@StyleError] domain.
+ * Error codes that occurs while parsing the style in [class@VectorRenderer].
*/
typedef enum {
SHUMATE_STYLE_ERROR_FAILED,
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]