| Index: trunk/phase3/includes/cache/ObjectFileCache.php |
| — | — | @@ -1,6 +1,16 @@ |
| 2 | 2 | <?php |
| | 3 | +/** |
| | 4 | + * Contain the ObjectFileCache class |
| | 5 | + * @file |
| | 6 | + * @ingroup Cache |
| | 7 | + */ |
| 3 | 8 | class ObjectFileCache extends FileCacheBase { |
| 4 | | - |
| | 9 | + /** |
| | 10 | + * Construct an ObjectFileCache from a key and a type |
| | 11 | + * @param $key string |
| | 12 | + * @param $type string |
| | 13 | + * @return ObjectFileCache |
| | 14 | + */ |
| 5 | 15 | public static function newFromKey( $key, $type ) { |
| 6 | 16 | $cache = new self(); |
| 7 | 17 | |
| — | — | @@ -15,7 +25,7 @@ |
| 16 | 26 | return $cache; |
| 17 | 27 | } |
| 18 | 28 | |
| 19 | | - /* |
| | 29 | + /** |
| 20 | 30 | * Get the type => extension mapping |
| 21 | 31 | * @return array |
| 22 | 32 | */ |
| Index: trunk/phase3/includes/cache/FileCacheBase.php |
| — | — | @@ -1,6 +1,6 @@ |
| 2 | 2 | <?php |
| 3 | 3 | /** |
| 4 | | - * Contain the HTMLFileCache class |
| | 4 | + * Contain the FileCacheBase class |
| 5 | 5 | * @file |
| 6 | 6 | * @ingroup Cache |
| 7 | 7 | */ |
| — | — | @@ -128,7 +128,7 @@ |
| 129 | 129 | return $text; |
| 130 | 130 | } |
| 131 | 131 | |
| 132 | | - /* |
| | 132 | + /** |
| 133 | 133 | * Clear the cache for this page |
| 134 | 134 | * @return void |
| 135 | 135 | */ |
| — | — | @@ -138,7 +138,7 @@ |
| 139 | 139 | wfRestoreWarnings(); |
| 140 | 140 | } |
| 141 | 141 | |
| 142 | | - /* |
| | 142 | + /** |
| 143 | 143 | * Create parent directors of $this->cachePath() |
| 144 | 144 | * @TODO: why call wfMkdirParents() twice? |
| 145 | 145 | * @return void |
| — | — | @@ -152,7 +152,7 @@ |
| 153 | 153 | wfMkdirParents( $mydir2, null, __METHOD__ ); |
| 154 | 154 | } |
| 155 | 155 | |
| 156 | | - /* |
| | 156 | + /** |
| 157 | 157 | * Return relative multi-level hash subdirectory with the trailing |
| 158 | 158 | * slash or the empty string if $wgFileCacheDepth is off |
| 159 | 159 | * @return string |
| Index: trunk/phase3/includes/cache/HTMLFileCache.php |
| — | — | @@ -5,7 +5,12 @@ |
| 6 | 6 | * @ingroup Cache |
| 7 | 7 | */ |
| 8 | 8 | class HTMLFileCache extends FileCacheBase { |
| 9 | | - |
| | 9 | + /** |
| | 10 | + * Construct an ObjectFileCache from a Title and an action |
| | 11 | + * @param $title Title |
| | 12 | + * @param $action string |
| | 13 | + * @return HTMLFileCache |
| | 14 | + */ |
| 10 | 15 | public static function newFromTitle( Title $title, $action ) { |
| 11 | 16 | $cache = new self(); |
| 12 | 17 | |
| — | — | @@ -20,7 +25,7 @@ |
| 21 | 26 | return $cache; |
| 22 | 27 | } |
| 23 | 28 | |
| 24 | | - /* |
| | 29 | + /** |
| 25 | 30 | * Cacheable actions |
| 26 | 31 | * @return array |
| 27 | 32 | */ |