From dc7485c090c91c999a88b54d6e76f8cb8f0b4dd9 Mon Sep 17 00:00:00 2001 From: Per Hedbor <ph@opera.com> Date: Thu, 28 Aug 2014 13:57:29 +0200 Subject: [PATCH] [autodoc] Some toplevel documentatioon for Cache. --- lib/modules/Cache.pmod/module.pmod | 10 ++++++++++ 1 file changed, 10 insertions(+) create mode 100644 lib/modules/Cache.pmod/module.pmod diff --git a/lib/modules/Cache.pmod/module.pmod b/lib/modules/Cache.pmod/module.pmod new file mode 100644 index 0000000000..4d6342e145 --- /dev/null +++ b/lib/modules/Cache.pmod/module.pmod @@ -0,0 +1,10 @@ +//! Common Caching implementation +//! +//! This module serves as a front-end to different kinds of caching +//! systems. It uses two helper objects to actually store data, and to +//! determine expiration policies. +//! +//! To create a new cache, do @[Cache.cache]( @[Cache.Storage.Base] storage_type, @[Cache.Policy.Base] expiration_policy ) +//! +//! +//! The cache store instances of @[Cache.Data]. -- GitLab