luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-26 07:26:15 +01:00
Code Issues Packages Projects Releases Wiki Activity

docs: Move the GCache SECTION

Browse Source 
Move it to the struct docs.

Signed-off-by: Philip Withnall <pwithnall@gnome.org>

Helps: #3037
This commit is contained in:
Philip Withnall 2023-11-14 14:43:01 +00:00
parent e42bfcb9ae
commit a11d3604c2
1 changed files with 11 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
glib/deprecated/gcache.c
View File

@ -42,19 +42,18 @@
#include "gtestutils.h" #include "gtestutils.h"
/** /**
* SECTION:caches * GCache:
* @title: Caches
* @short_description: caches allow sharing of complex data structures
* to save resources
* *
* A #GCache allows sharing of complex data structures, in order to * A `GCache` allows sharing of complex data structures, in order to
* save system resources. * save system resources.
* *
* GCache uses keys and values. A GCache key describes the properties * `GCache` uses keys and values. A `GCache` key describes the properties
* of a particular resource. A GCache value is the actual resource. * of a particular resource. A `GCache` value is the actual resource.
* *
* GCache has been marked as deprecated, since this API is rarely * `GCache` has been marked as deprecated, since this API is rarely
* used and not very actively maintained. * used and not very actively maintained.
*
* Deprecated:2.32: Use a #GHashTable instead
*/ */
typedef struct _GCacheNode GCacheNode; typedef struct _GCacheNode GCacheNode;
@ -66,15 +65,6 @@ struct _GCacheNode
gint ref_count; gint ref_count;
}; };
/**
* GCache:
*
* The #GCache struct is an opaque data structure containing
* information about a #GCache. It should only be accessed via the
* following functions.
*
* Deprecated:2.32: Use a #GHashTable instead
*/
struct _GCache struct _GCache
{ {
/* Called to create a value from a key */ /* Called to create a value from a key */
@ -147,6 +137,7 @@ g_cache_node_destroy (GCacheNode *node)
* value corresponding to the key. * value corresponding to the key.
* *
* Returns: a new #GCache value corresponding to the key. * Returns: a new #GCache value corresponding to the key.
* Deprecated:2.32: Use a #GHashTable instead
*/ */
/** /**
@ -157,6 +148,8 @@ g_cache_node_destroy (GCacheNode *node)
* functions passed to g_cache_new(). The functions are passed a * functions passed to g_cache_new(). The functions are passed a
* pointer to the #GCache key or #GCache value and should free any * pointer to the #GCache key or #GCache value and should free any
* memory and other resources associated with it. * memory and other resources associated with it.
*
* Deprecated:2.32: Use a #GHashTable instead
*/ */
/** /**
@ -170,6 +163,7 @@ g_cache_node_destroy (GCacheNode *node)
* should return a duplicate of the key. * should return a duplicate of the key.
* *
* Returns: a copy of the #GCache key * Returns: a copy of the #GCache key
* Deprecated:2.32: Use a #GHashTable instead
*/ */
GCache* GCache*
g_cache_new (GCacheNewFunc value_new_func, g_cache_new (GCacheNewFunc value_new_func,