diff options
Diffstat (limited to 'src/misc/cache/lv_cache_private.h')
| -rw-r--r-- | src/misc/cache/lv_cache_private.h | 30 |
1 files changed, 15 insertions, 15 deletions
diff --git a/src/misc/cache/lv_cache_private.h b/src/misc/cache/lv_cache_private.h index 619d2b8ac..c8ac24993 100644 --- a/src/misc/cache/lv_cache_private.h +++ b/src/misc/cache/lv_cache_private.h @@ -68,7 +68,7 @@ typedef void (*lv_cache_destroy_cb_t)(lv_cache_t * cache, void * user_data); /** * The cache get function, used by the cache class to get a cache entry by its key. - * @return NULL if the key is not found. + * @return `NULL` if the key is not found. */ typedef lv_cache_entry_t * (*lv_cache_get_cb_t)(lv_cache_t * cache, const void * key, void * user_data); @@ -120,28 +120,27 @@ struct lv_cache_ops_t { * The cache entry struct */ struct lv_cache_t { - const lv_cache_class_t * clz; /**< The cache class. There are two built-in classes: + const lv_cache_class_t * clz; /**< Cache class. There are two built-in classes: * - lv_cache_class_lru_rb_count for LRU-based cache with count-based eviction policy. - * - lv_cache_class_lru_rb_size for LRU-based cache with size-based eviction policy. - */ + * - lv_cache_class_lru_rb_size for LRU-based cache with size-based eviction policy. */ - uint32_t node_size; /**< The size of a node */ + uint32_t node_size; /**< Size of a node */ - uint32_t max_size; /**< The maximum size of the cache */ - uint32_t size; /**< The current size of the cache */ + uint32_t max_size; /**< Maximum size of the cache */ + uint32_t size; /**< Current size of the cache */ - lv_cache_ops_t ops; /**< The cache operations struct lv_cache_ops_t */ + lv_cache_ops_t ops; /**< Cache operations struct lv_cache_ops_t */ - lv_mutex_t lock; /**< The cache lock used to protect the cache in multithreading environments */ + lv_mutex_t lock; /**< Cache lock used to protect the cache in multithreading environments */ - const char * name; /**< The name of the cache */ + const char * name; /**< Name of the cache */ }; /** - * The cache class struct for building custom cache classes, and there are two built-in classes. + * Cache class struct for building custom cache classes * + * Examples: * - lv_cache_class_lru_rb_count for LRU-based cache with count-based eviction policy. - * * - lv_cache_class_lru_rb_size for LRU-based cache with size-based eviction policy. */ struct lv_cache_class_t { @@ -167,9 +166,10 @@ struct lv_cache_slot_size_t; typedef struct lv_cache_slot_size_t lv_cache_slot_size_t; /** - * The cache entry slot struct - * To add new fields to the cache entry, add them to a new struct and add it to the first field of the cache data struct. - * And this one is a size slot for the cache entry. + * Cache entry slot struct + * + * To add new fields to the cache entry, add them to a new struct and add it to the first + * field of the cache data struct. And this one is a size slot for the cache entry. */ struct lv_cache_slot_size_t { size_t size; |