[libshumate/tintou/map-source-registry] docs: Add more documentation



commit 8ac73492afcd37c318f14da2b9044b409abeb3c3
Author: Corentin Noël <corentin noel collabora com>
Date:   Thu Jun 10 13:34:35 2021 +0200

    docs: Add more documentation
    
    Also fixes warnings

 docs/reference/libshumate-sections.txt | 102 +++++++++++----------------------
 docs/reference/libshumate.types        |   3 +-
 shumate/shumate-map-source.c           |   2 +-
 shumate/shumate-network-tile-source.h  |   1 +
 4 files changed, 38 insertions(+), 70 deletions(-)
---
diff --git a/docs/reference/libshumate-sections.txt b/docs/reference/libshumate-sections.txt
index 67fa521..ce98127 100644
--- a/docs/reference/libshumate-sections.txt
+++ b/docs/reference/libshumate-sections.txt
@@ -32,6 +32,41 @@ ShumateMapSourceClass
 ShumateMapSourcePrivate
 </SECTION>
 
+<SECTION>
+<FILE>shumate-map-source-registry</FILE>
+<TITLE>ShumateMapSourceRegistry</TITLE>
+ShumateMapSourceRegistry
+shumate_map_source_registry_new
+shumate_map_source_registry_new_with_defaults
+shumate_map_source_registry_populate_defaults
+shumate_map_source_registry_get_by_id
+shumate_map_source_registry_add
+shumate_map_source_registry_remove
+SHUMATE_MAP_SOURCE_OSM_MAPNIK
+SHUMATE_MAP_SOURCE_OSM_CYCLE_MAP
+SHUMATE_MAP_SOURCE_OSM_TRANSPORT_MAP
+SHUMATE_MAP_SOURCE_OSM_AERIAL_MAP
+SHUMATE_MAP_SOURCE_OSM_MAPQUEST
+SHUMATE_MAP_SOURCE_MFF_RELIEF
+SHUMATE_MAP_SOURCE_OAM
+SHUMATE_MAP_SOURCE_OSM_OSMARENDER
+SHUMATE_MAP_SOURCE_OWM_CLOUDS
+SHUMATE_MAP_SOURCE_OWM_PRECIPITATION
+SHUMATE_MAP_SOURCE_OWM_PRESSURE
+SHUMATE_MAP_SOURCE_OWM_TEMPERATURE
+SHUMATE_MAP_SOURCE_OWM_WIND
+<SUBSECTION Standard>
+SHUMATE_MAP_SOURCE_REGISTRY
+SHUMATE_IS_MAP_SOURCE_REGISTRY
+SHUMATE_TYPE_MAP_SOURCE_REGISTRY
+shumate_map_source_factory_get_type
+SHUMATE_MAP_SOURCE_REGISTRY_CLASS
+SHUMATE_IS_MAP_SOURCE_REGISTRY_CLASS
+SHUMATE_MAP_SOURCE_REGISTRY_GET_CLASS
+<SUBSECTION Private>
+ShumateMapSourceRegistryClass
+</SECTION>
+
 <SECTION>
 <FILE>shumate-marker</FILE>
 <TITLE>ShumateMarker</TITLE>
@@ -332,42 +367,6 @@ ShumateScaleClass
 ShumateScalePrivate
 </SECTION>
 
-<SECTION>
-<FILE>shumate-map-source-factory</FILE>
-<TITLE>ShumateMapSourceFactory</TITLE>
-ShumateMapSourceFactory
-shumate_map_source_factory_dup_default
-shumate_map_source_factory_create
-shumate_map_source_factory_create_cached_source
-shumate_map_source_factory_create_error_source
-shumate_map_source_factory_register
-shumate_map_source_factory_get_registered
-SHUMATE_MAP_SOURCE_OSM_MAPNIK
-SHUMATE_MAP_SOURCE_OSM_CYCLE_MAP
-SHUMATE_MAP_SOURCE_OSM_TRANSPORT_MAP
-SHUMATE_MAP_SOURCE_OSM_AERIAL_MAP
-SHUMATE_MAP_SOURCE_OSM_MAPQUEST
-SHUMATE_MAP_SOURCE_MFF_RELIEF
-SHUMATE_MAP_SOURCE_OAM
-SHUMATE_MAP_SOURCE_OSM_OSMARENDER
-SHUMATE_MAP_SOURCE_OWM_CLOUDS
-SHUMATE_MAP_SOURCE_OWM_PRECIPITATION
-SHUMATE_MAP_SOURCE_OWM_PRESSURE
-SHUMATE_MAP_SOURCE_OWM_TEMPERATURE
-SHUMATE_MAP_SOURCE_OWM_WIND
-<SUBSECTION Standard>
-SHUMATE_MAP_SOURCE_FACTORY
-SHUMATE_IS_MAP_SOURCE_FACTORY
-SHUMATE_TYPE_MAP_SOURCE_FACTORY
-shumate_map_source_factory_get_type
-SHUMATE_MAP_SOURCE_FACTORY_CLASS
-SHUMATE_IS_MAP_SOURCE_FACTORY_CLASS
-SHUMATE_MAP_SOURCE_FACTORY_GET_CLASS
-<SUBSECTION Private>
-ShumateMapSourceFactoryClass
-ShumateMapSourceFactoryPrivate
-</SECTION>
-
 <SECTION>
 <FILE>shumate-license</FILE>
 <TITLE>ShumateLicense</TITLE>
@@ -470,37 +469,6 @@ ShumateMemoryCacheClass
 ShumateMemoryCachePrivate
 </SECTION>
 
-<SECTION>
-<FILE>shumate-map-source-desc</FILE>
-<TITLE>ShumateMapSourceDesc</TITLE>
-ShumateMapSourceDesc
-ShumateMapSourceConstructor
-SHUMATE_MAP_SOURCE_CONSTRUCTOR
-shumate_map_source_desc_new_full
-shumate_map_source_desc_get_id
-shumate_map_source_desc_get_name
-shumate_map_source_desc_get_license
-shumate_map_source_desc_get_license_uri
-shumate_map_source_desc_get_uri_format
-shumate_map_source_desc_get_min_zoom_level
-shumate_map_source_desc_get_max_zoom_level
-shumate_map_source_desc_get_tile_size
-shumate_map_source_desc_get_projection
-shumate_map_source_desc_get_data
-shumate_map_source_desc_get_constructor
-<SUBSECTION Standard>
-SHUMATE_MAP_SOURCE_DESC
-SHUMATE_IS_MAP_SOURCE_DESC
-SHUMATE_TYPE_MAP_SOURCE_DESC
-shumate_map_source_desc_get_type
-SHUMATE_MAP_SOURCE_DESC_CLASS
-SHUMATE_IS_MAP_SOURCE_DESC_CLASS
-SHUMATE_MAP_SOURCE_DESC_GET_CLASS
-<SUBSECTION Private>
-ShumateMapSourceDescClass
-ShumateMapSourceDescPrivate
-</SECTION>
-
 <SECTION>
 <FILE>shumate-path-layer</FILE>
 <TITLE>ShumatePathLayer</TITLE>
diff --git a/docs/reference/libshumate.types b/docs/reference/libshumate.types
index e491458..d6116df 100644
--- a/docs/reference/libshumate.types
+++ b/docs/reference/libshumate.types
@@ -4,8 +4,7 @@ shumate_layer_get_type
 shumate_license_get_type
 shumate_location_get_type
 shumate_map_layer_get_type
-shumate_map_source_desc_get_type
-shumate_map_source_factory_get_type
+shumate_map_source_registry_get_type
 shumate_map_source_get_type
 shumate_marker_get_type
 shumate_marker_layer_get_type
diff --git a/shumate/shumate-map-source.c b/shumate/shumate-map-source.c
index cdbc3d9..0f1008a 100644
--- a/shumate/shumate-map-source.c
+++ b/shumate/shumate-map-source.c
@@ -25,7 +25,7 @@
  * #ShumateTile objects with images from various sources: a web API, for
  * example, or a test pattern generated on demand.
  *
- * The most common map source is #ShumateNetworkMapSource, which fetches tiles
+ * The most common map source is #ShumateNetworkTileSource, which fetches tiles
  * from an API.
  */
 
diff --git a/shumate/shumate-network-tile-source.h b/shumate/shumate-network-tile-source.h
index f8c93b4..76e3fe9 100644
--- a/shumate/shumate-network-tile-source.h
+++ b/shumate/shumate-network-tile-source.h
@@ -45,6 +45,7 @@ GQuark shumate_network_source_error_quark (void);
  * @SHUMATE_NETWORK_SOURCE_ERROR_FAILED: An unspecified error occurred during the operation.
  * @SHUMATE_NETWORK_SOURCE_ERROR_BAD_RESPONSE: An unsuccessful HTTP response was received from the server.
  * @SHUMATE_NETWORK_SOURCE_ERROR_COULD_NOT_CONNECT: The server could not be reached.
+ * @SHUMATE_NETWORK_SOURCE_ERROR_MALFORMED_URL: The provided URL isn't valid
  * @SHUMATE_NETWORK_SOURCE_ERROR_OFFLINE: The tile source has been marked as offline.
  *
  * Error codes in the #SHUMATE_NETWORK_SOURCE_ERROR domain.


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