[tepl] MetadataStore: add comments to delimit code sections



commit 9b0c70b2914e20a844202529e4f2e7575865357a
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Thu Apr 16 15:00:03 2020 +0200

    MetadataStore: add comments to delimit code sections

 tepl/tepl-metadata-store.c | 21 +++++++++++++++++++++
 1 file changed, 21 insertions(+)
---
diff --git a/tepl/tepl-metadata-store.c b/tepl/tepl-metadata-store.c
index 5487ce5..af07363 100644
--- a/tepl/tepl-metadata-store.c
+++ b/tepl/tepl-metadata-store.c
@@ -129,6 +129,9 @@ static TeplMetadataStore *singleton = NULL;
 
 G_DEFINE_TYPE_WITH_PRIVATE (TeplMetadataStore, tepl_metadata_store, G_TYPE_OBJECT)
 
+/******************************************************************************/
+/* DocumentMetadata struct */
+
 static DocumentMetadata *
 document_metadata_new (void)
 {
@@ -163,6 +166,9 @@ document_metadata_free (DocumentMetadata *document_metadata)
        }
 }
 
+/******************************************************************************/
+/* ParsingData struct */
+
 static ParsingData *
 parsing_data_new (TeplMetadataStore *store)
 {
@@ -209,6 +215,9 @@ parsing_data_free (ParsingData *parsing_data)
        }
 }
 
+/******************************************************************************/
+/* overridden vfuncs, class_init, init */
+
 static void
 tepl_metadata_store_get_property (GObject    *object,
                                  guint       prop_id,
@@ -289,6 +298,9 @@ tepl_metadata_store_init (TeplMetadataStore *store)
        store->priv->max_number_of_locations = DEFAULT_MAX_NUMBER_OF_LOCATIONS;
 }
 
+/******************************************************************************/
+/* Simple public functions */
+
 /**
  * tepl_metadata_store_get_singleton:
  *
@@ -374,6 +386,9 @@ tepl_metadata_store_set_max_number_of_locations (TeplMetadataStore *store,
        store->priv->max_number_of_locations = max_number_of_locations;
 }
 
+/******************************************************************************/
+/* XML parsing, store_file loading */
+
 /* <metadata> */
 static void
 parse_metadata_element (GMarkupParseContext  *context,
@@ -813,6 +828,9 @@ _tepl_metadata_store_is_loaded (TeplMetadataStore *store)
        return store->priv->is_loaded;
 }
 
+/******************************************************************************/
+/* store_file saving */
+
 static void
 entries_to_string (DocumentMetadata *document_metadata,
                   GString          *string)
@@ -1020,6 +1038,9 @@ tepl_metadata_store_save (TeplMetadataStore  *store,
        return ok;
 }
 
+/******************************************************************************/
+/* Remaining private API */
+
 /*
  * _tepl_metadata_store_get_metadata_for_location:
  * @store: the #TeplMetadataStore.


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