[libsoup/wip/docs-updates: 4/9] docs: Document SoupCache properties




commit 64dffe06ca87b8aed5cbeae10ff4091e3a7ad961
Author: Patrick Griffis <pgriffis igalia com>
Date:   Thu Apr 14 12:29:55 2022 -0500

    docs: Document SoupCache properties

 libsoup/cache/soup-cache.c | 8 ++++++++
 1 file changed, 8 insertions(+)
---
diff --git a/libsoup/cache/soup-cache.c b/libsoup/cache/soup-cache.c
index 42de3045..96771657 100644
--- a/libsoup/cache/soup-cache.c
+++ b/libsoup/cache/soup-cache.c
@@ -1039,6 +1039,10 @@ soup_cache_class_init (SoupCacheClass *cache_class)
 
        cache_class->get_cacheability = get_cacheability;
 
+        /**
+         * SoupCache:cache-dir:
+         * The directory to store the cache files.
+         */
         properties[PROP_CACHE_DIR] =
                 g_param_spec_string ("cache-dir",
                                      "Cache directory",
@@ -1047,6 +1051,10 @@ soup_cache_class_init (SoupCacheClass *cache_class)
                                      G_PARAM_READWRITE | G_PARAM_CONSTRUCT_ONLY |
                                      G_PARAM_STATIC_STRINGS);
 
+        /**
+         * SoupCache:cache-type:
+         * Whether the cache is private or shared.
+         */
         properties[PROP_CACHE_TYPE] =
                 g_param_spec_enum ("cache-type",
                                    "Cache type",


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