Adding some inline documentation to shell management API

This commit is contained in:
Lombiq
2013-12-27 01:27:04 +01:00
committed by Zoltán Lehóczky
parent 2b793ad2b0
commit 9a07d8b419
2 changed files with 24 additions and 1 deletions

View File

@@ -4,12 +4,26 @@ using Orchard.Environment.Extensions.Models;
namespace Orchard.MultiTenancy.Services {
public interface ITenantService : IDependency {
/// <summary>
/// Retrieves all tenants' shell settings.
/// </summary>
/// <returns>All tenants' shell settings.</returns>
IEnumerable<ShellSettings> GetTenants();
/// <summary>
/// Creates a new tenant.
/// </summary>
/// <param name="settings">Shell settings of the tenant.</param>
void CreateTenant(ShellSettings settings);
/// <summary>
/// Updates the shell settings of a tenant.
/// </summary>
/// <param name="settings">Shell settings of the tenant.</param>
void UpdateTenant(ShellSettings settings);
/// <summary>
/// Returns a list of all installed themes
/// Returns a list of all installed themes.
/// </summary>
IEnumerable<ExtensionDescriptor> GetInstalledThemes();
}

View File

@@ -2,7 +2,16 @@ using System.Collections.Generic;
namespace Orchard.Environment.Configuration {
public interface IShellSettingsManager {
/// <summary>
/// Retrieves all shell settings stored.
/// </summary>
/// <returns>All shell settings.</returns>
IEnumerable<ShellSettings> LoadSettings();
/// <summary>
/// Persists shell settings to the storage.
/// </summary>
/// <param name="settings">The shell settings to store.</param>
void SaveSettings(ShellSettings settings);
}
}