Skip to content

Commit

Permalink
Documentation for Composite.Core.IO added.
Browse files Browse the repository at this point in the history
  • Loading branch information
@IngvarKofoed
IngvarKofoed committed Mar 11, 2011
1 parent 240f7dd commit 452c93c
Show file tree
Hide file tree
Showing 30 changed files with 1,336 additions and 1,198 deletions.
66 changes: 35 additions & 31 deletions Composite/Core/Configuration/C1Configuration.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,18 @@
namespace Composite.Core.Configuration
{
/// <summary>
/// IOLayer - documentation pending
/// This class is a almost one to one version of System.Configuration.Configuration. Using this implementation instead
/// of System.Configuration.Configuration, will ensure that your code will work both on Standard Windows deployment
/// and Windows Azure deployment.
/// See System.Configuration.Configuration for more documentation on the methods of this class.
/// See <see cref="Composite.Core.IO.Plugins.IOProvider.IC1Configuration"/>.
/// </summary>
public class C1Configuration : ImplementationContainer<C1ConfigurationImplementation>
{
/// <summary>
/// IOLayer - documentation pending
/// Creates a C1Configuration
/// </summary>
/// <param name="path"></param>
/// <param name="path">Path to configuration file.</param>
public C1Configuration(string path)
: base(() => ImplementationFactory.CurrentFactory.CreateC1Configuration(path))
{
Expand All @@ -21,7 +25,7 @@ public C1Configuration(string path)


/// <summary>
/// IOLayer - documentation pending
/// Gets the path to the configuration file.
/// </summary>
public string FilePath
{
Expand All @@ -34,7 +38,7 @@ public string FilePath


/// <summary>
/// IOLayer - documentation pending
/// Returns true if the configuration file exists.
/// </summary>
public bool HasFile
{
Expand All @@ -47,7 +51,7 @@ public bool HasFile


/// <summary>
/// IOLayer - documentation pending
/// Returns the app setttings section.
/// </summary>
public AppSettingsSection AppSettings
{
Expand All @@ -60,7 +64,7 @@ public AppSettingsSection AppSettings


/// <summary>
/// IOLayer - documentation pending
/// Returns the connection string section.
/// </summary>
public ConnectionStringsSection ConnectionStrings
{
Expand All @@ -73,7 +77,7 @@ public ConnectionStringsSection ConnectionStrings


/// <summary>
/// IOLayer - documentation pending
/// Returns the configuration sections.
/// </summary>
public ConfigurationSectionCollection Sections
{
Expand All @@ -86,7 +90,7 @@ public ConfigurationSectionCollection Sections


/// <summary>
/// IOLayer - documentation pending
/// Returns the configuration section group.
/// </summary>
public ConfigurationSectionGroup RootSectionGroup
{
Expand All @@ -99,7 +103,7 @@ public ConfigurationSectionGroup RootSectionGroup


/// <summary>
/// IOLayer - documentation pending
/// Returns the configuration slection groups.
/// </summary>
public ConfigurationSectionGroupCollection SectionGroups
{
Expand All @@ -112,10 +116,10 @@ public ConfigurationSectionGroupCollection SectionGroups


/// <summary>
/// IOLayer - documentation pending
/// Gets a named configuration section.
/// </summary>
/// <param name="sectionName"></param>
/// <returns></returns>
/// <param name="sectionName">Name of section to get.</param>
/// <returns>Returns the configuration section.</returns>
public ConfigurationSection GetSection(string sectionName)
{
return this.Implementation.GetSection(sectionName);
Expand All @@ -124,10 +128,10 @@ public ConfigurationSection GetSection(string sectionName)


/// <summary>
/// IOLayer - documentation pending
/// Gets a named configuration section group.
/// </summary>
/// <param name="sectionGroupName"></param>
/// <returns></returns>
/// <param name="sectionGroupName">Name of configuration section group to get.</param>
/// <returns>Returns the configuration section group.</returns>
public ConfigurationSectionGroup GetSectionGroup(string sectionGroupName)
{
return this.Implementation.GetSectionGroup(sectionGroupName);
Expand All @@ -136,7 +140,7 @@ public ConfigurationSectionGroup GetSectionGroup(string sectionGroupName)


/// <summary>
/// IOLayer - documentation pending
/// Saves the configuration.
/// </summary>
public void Save()
{
Expand All @@ -146,9 +150,9 @@ public void Save()


/// <summary>
/// IOLayer - documentation pending
/// Saves the configuration.
/// </summary>
/// <param name="saveMode"></param>
/// <param name="saveMode">Save mode to use when saving the configuration.</param>
public void Save(ConfigurationSaveMode saveMode)
{
this.Implementation.Save(saveMode);
Expand All @@ -157,10 +161,10 @@ public void Save(ConfigurationSaveMode saveMode)


/// <summary>
/// IOLayer - documentation pending
/// Saves the configuration.
/// </summary>
/// <param name="saveMode"></param>
/// <param name="forceSaveAll"></param>
/// <param name="saveMode">Save mode to use when saving the configuration.</param>
/// <param name="forceSaveAll">Saves all sections, even non touched.</param>
public void Save(ConfigurationSaveMode saveMode, bool forceSaveAll)
{
this.Implementation.Save(saveMode, forceSaveAll);
Expand All @@ -169,9 +173,9 @@ public void Save(ConfigurationSaveMode saveMode, bool forceSaveAll)


/// <summary>
/// IOLayer - documentation pending
/// Saves the configuration to a new file.
/// </summary>
/// <param name="filename"></param>
/// <param name="filename">Path to new configuration filename.</param>
public void SaveAs(string filename)
{
this.Implementation.SaveAs(filename);
Expand All @@ -180,10 +184,10 @@ public void SaveAs(string filename)


/// <summary>
/// IOLayer - documentation pending
/// Saves the configuration to a new file.
/// </summary>
/// <param name="filename"></param>
/// <param name="saveMode"></param>
/// <param name="filename">Path to new configuration filename.</param>
/// <param name="saveMode">Save mode to use when saving the configuration.</param>
public void SaveAs(string filename, ConfigurationSaveMode saveMode)
{
this.Implementation.SaveAs(filename, saveMode);
Expand All @@ -192,11 +196,11 @@ public void SaveAs(string filename, ConfigurationSaveMode saveMode)


/// <summary>
/// IOLayer - documentation pending
/// Saves the configuration to a new file.
/// </summary>
/// <param name="filename"></param>
/// <param name="saveMode"></param>
/// <param name="forceSaveAll"></param>
/// <param name="filename">Path to new configuration filename.</param>
/// <param name="saveMode">Save mode to use when saving the configuration.</param>
/// <param name="forceSaveAll">Saves all sections, even non touched.</param>
public void SaveAs(string filename, ConfigurationSaveMode saveMode, bool forceSaveAll)
{
this.Implementation.SaveAs(filename, saveMode, forceSaveAll);
Expand Down
1 change: 1 addition & 0 deletions Composite/Core/IO/C1Directory.cs
View file
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ namespace Composite.Core.IO
/// of System.IO.Directory, will ensure that your code will work both on Standard Windows deployment
/// and Windows Azure deployment.
/// See System.IO.Directory for more documentation on the methods of this class.
/// See <see cref="Composite.Core.IO.Plugins.IOProvider.IC1Directory"/>.
/// </summary>
public static class C1Directory
{
Expand Down
Loading

0 comments on commit 452c93c

Please sign in to comment.