X-Git-Url: http://www.chiark.greenend.org.uk/ucgi/~mdw/git/disorder/blobdiff_plain/0b7c89091fed1feb9a45a594c133a5d122dea692..f5fd9a6b25366f98a20468ca9bda64c4313db09e:/lib/cache.h

diff --git a/lib/cache.h b/lib/cache.h
index 48aba1c..ac9bc01 100644
--- a/lib/cache.h
+++ b/lib/cache.h
@@ -1,21 +1,25 @@
 /*
  * 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
+ * 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
- * the Free Software Foundation; either version 2 of the License, or
+ * the Free Software Foundation, either version 3 of the License, or
  * (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful, but
- * WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
- * General Public License for more details.
- *
+ * 
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU General Public License for more details.
+ * 
  * You should have received a copy of the GNU General Public License
- * along with this program; if not, write to the Free Software
- * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
- * USA
+ * along with this program.  If not, see <http://www.gnu.org/licenses/>.
+ */
+/** @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
@@ -23,8 +27,10 @@
 
 /* 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,