summaryrefslogtreecommitdiff
path: root/content/backing_store.h
diff options
context:
space:
mode:
authorVincent Sanders <vince@kyllikki.org>2014-11-23 15:43:03 +0000
committerVincent Sanders <vince@kyllikki.org>2014-11-23 15:43:03 +0000
commit01b2bc5a57068b8957ee63b73fa48714d71f9205 (patch)
treed7570fd2d00b594ca8c836f24608ddb60b570977 /content/backing_store.h
parent246a1fec0523346e9fdfb9b7d937cfbd947cd663 (diff)
downloadnetsurf-01b2bc5a57068b8957ee63b73fa48714d71f9205.tar.gz
netsurf-01b2bc5a57068b8957ee63b73fa48714d71f9205.tar.bz2
Improve doxygen comments and add todo for cache and backing store
Diffstat (limited to 'content/backing_store.h')
-rw-r--r--content/backing_store.h11
1 files changed, 8 insertions, 3 deletions
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 <http://www.gnu.org/licenses/>.
*/
-/** \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.