add Colm's explanation of the cache_info structure from his explaination on dev@

Message-ID: <20060124223004.GA26461@dochas.stdlib.net>

git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@372096 13f79535-47bb-0310-9956-ffa450edef68

diff --git a/modules/cache/mod_cache.h b/modules/cache/mod_cache.h
index 2ac47dd2bf7796e38907ea6fe6777c57558fc56c..9f0776c6641ae1fa26edbddbfc78c0e2e27c62ff 100644 (file)
--- a/modules/cache/mod_cache.h
+++ b/modules/cache/mod_cache.h
@@ -159,10 +159,21 @@ typedef struct {
 /* cache info information */
 typedef struct cache_info cache_info;
 struct cache_info {
-    int status;
-    apr_time_t date;
+    /** 
+     * HTTP status code of the cached entity. Though not neccessarily the
+     * status code finally issued to the request. 
+     */
+    int status; 
+    /** 
+     * the original time corresponding to the 'Date:' header of the request 
+     * served 
+     */
+    apr_time_t date; 
+    /** a time when the cached entity is due to expire */
     apr_time_t expire;
+    /** r->request_time from the same request */
     apr_time_t request_time;
+    /** apr_time_now() at the time the entity was acutally cached */
     apr_time_t response_time;
 };