X-Git-Url: https://git.distorted.org.uk/~mdw/disorder/blobdiff_plain/0b7c89091fed1feb9a45a594c133a5d122dea692..28dc2d220aee492d34c35e3e0756248a16d55b5a:/lib/cache.h

diff --git a/lib/cache.h b/lib/cache.h
index 48aba1c..26fa3dd 100644
--- a/lib/cache.h
+++ b/lib/cache.h
@@ -1,6 +1,6 @@
 /*
  * This file is part of DisOrder
- * Copyright (C) 2006 Richard Kettlewell
+ * Copyright (C) 2006-2008 Richard Kettlewell
  *
  * This program is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -17,14 +17,22 @@
  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
  * USA
  */
+/** @file lib/cache.h
+ * @brief Object caching
+ *
+ * There is a single cache for the whole process.  Objects of different types
+ * are distinguished.  Objects might be thrown out of the cache at any point.
+ */
 
 #ifndef CACHE_H
 #define CACHE_H
 
 /* Defines a cache mapping keys to typed data items */
 
+/** @brief Type of a cache object */
 struct cache_type {
-  int lifetime;                         /* Lifetime of a cache entry */
+  /** @brief Lifetime for objects of this type (seconds) */
+  int lifetime;
 };
 
 void cache_put(const struct cache_type *type,