minor: Add method doc to IImproveAssetCache

master-beforevarregion
Justin Clark-Casey (justincc) 2014-01-18 00:15:38 +00:00
parent 97fbb8ed45
commit d381da81d6
1 changed files with 25 additions and 1 deletions

View File

@ -31,10 +31,34 @@ namespace OpenSim.Framework
{ {
public interface IImprovedAssetCache public interface IImprovedAssetCache
{ {
/// <summary>
/// Cache the specified asset.
/// </summary>
/// <param name='asset'></param>
void Cache(AssetBase asset); void Cache(AssetBase asset);
/// <summary>
/// Get an asset by its id.
/// </summary>
/// <param name='id'></param>
/// <returns>null if the asset does not exist.</returns>
AssetBase Get(string id); AssetBase Get(string id);
/// <summary>
/// Check whether an asset with the specified id exists in the cache.
/// </summary>
/// <param name='id'></param>
bool Check(string id); bool Check(string id);
/// <summary>
/// Expire an asset from the cache.
/// </summary>
/// <param name='id'></param>
void Expire(string id); void Expire(string id);
/// <summary>
/// Clear the cache.
/// </summary>
void Clear(); void Clear();
} }
} }