From 01b2bc5a57068b8957ee63b73fa48714d71f9205 Mon Sep 17 00:00:00 2001 From: Vincent Sanders Date: Sun, 23 Nov 2014 15:43:03 +0000 Subject: Improve doxygen comments and add todo for cache and backing store --- content/backing_store.h | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) (limited to 'content/backing_store.h') diff --git a/content/backing_store.h b/content/backing_store.h index 077f050ed..312a2b02e 100644 --- a/content/backing_store.h +++ b/content/backing_store.h @@ -16,8 +16,9 @@ * along with this program. If not, see . */ -/** \file - * Low-level source data cache backing store interface +/** + * \file + * Low-level source data cache backing store interface. */ #ifndef NETSURF_CONTENT_LLCACHE_PRIVATE_H_ @@ -33,7 +34,8 @@ enum backing_store_flags { BACKING_STORE_META = 1, }; -/** low level cache backing store operation table +/** + * low level cache backing store operation table * * The low level cache (source objects) has the capability to make * objects and their metadata (headers etc) persistant by writing to a @@ -60,10 +62,12 @@ struct gui_llcache_table { * * The object is placed in the persistent store and may be * retrieved with the fetch method. + * * The backing store will take a reference to the * passed data, subsequently the caller should explicitly * release the allocation using the release method and not * free the data itself. + * * The caller may not assume that the persistent storage has * been completely written on return. * @@ -83,6 +87,7 @@ struct gui_llcache_table { * length in \a datalen. Alternatively the backing store will * allocate its own buffer if \a data is NULL, this memory is * managed by the backing store. + * * The caller must assume nothing about the backing store * allocated buffers and the storage and *must* be freed by * calling the release method. -- cgit v1.2.3