[tepl] FileMetadata docs: change a subsection to a section and move it above



commit 7c1ec6ab2b5de3c90cf0eecaa57194e621a45d81
Author: Sébastien Wilmet <swilmet gnome org>
Date:   Wed Apr 15 15:42:44 2020 +0200

    FileMetadata docs: change a subsection to a section and move it above

 tepl/tepl-file-metadata.c | 24 ++++++++++++------------
 1 file changed, 12 insertions(+), 12 deletions(-)
---
diff --git a/tepl/tepl-file-metadata.c b/tepl/tepl-file-metadata.c
index e62cda4..ea9167d 100644
--- a/tepl/tepl-file-metadata.c
+++ b/tepl/tepl-file-metadata.c
@@ -41,6 +41,18 @@
  * save the metadata on disk or to the #TeplMetadataStore, call
  * tepl_file_metadata_save_async().
  *
+ * # Separation of concerns
+ *
+ * To implement file metadata in an application, one strategy is to separate
+ * concerns:
+ * - Individual features or plugins call tepl_file_metadata_get() and
+ *   tepl_file_metadata_set().
+ * - The code that manages file loading and saving takes care of calling
+ *   tepl_file_metadata_load_async() and tepl_file_metadata_save_async() at
+ *   appropriate times (see the following use-cases as inspiration), and
+ *   orchestrates or signals individual features or plugins to
+ *   activate/deactivate themselves also at appropriate times.
+ *
  * # Application use-cases
  *
  * This section documents some use-cases that applications may want to support.
@@ -158,18 +170,6 @@
  *
  * FIXME: currently not well supported by #TeplFileMetadata, need to add
  * `save_subset_async/finish()` taking an array or list of keys to save.
- *
- * ## Separation of concerns
- *
- * To implement file metadata in an application, one strategy is to separate
- * concerns:
- * - Individual features or plugins call tepl_file_metadata_get() and
- *   tepl_file_metadata_set().
- * - The code that manages file loading and saving takes care of calling
- *   tepl_file_metadata_load_async() and tepl_file_metadata_save_async() at
- *   appropriate times (see the previous use-cases as inspiration), and
- *   orchestrates or signals individual features or plugins to
- *   activate/deactivate themselves also at appropriate times.
  */
 
 /* API design - additional notes:


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