diff --git a/Composite/Core/Configuration/C1Configuration.cs b/Composite/Core/Configuration/C1Configuration.cs index ce07b1df75..d4f2a42174 100644 --- a/Composite/Core/Configuration/C1Configuration.cs +++ b/Composite/Core/Configuration/C1Configuration.cs @@ -5,14 +5,18 @@ namespace Composite.Core.Configuration { /// - /// 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 . /// public class C1Configuration : ImplementationContainer { /// - /// IOLayer - documentation pending + /// Creates a C1Configuration /// - /// + /// Path to configuration file. public C1Configuration(string path) : base(() => ImplementationFactory.CurrentFactory.CreateC1Configuration(path)) { @@ -21,7 +25,7 @@ public C1Configuration(string path) /// - /// IOLayer - documentation pending + /// Gets the path to the configuration file. /// public string FilePath { @@ -34,7 +38,7 @@ public string FilePath /// - /// IOLayer - documentation pending + /// Returns true if the configuration file exists. /// public bool HasFile { @@ -47,7 +51,7 @@ public bool HasFile /// - /// IOLayer - documentation pending + /// Returns the app setttings section. /// public AppSettingsSection AppSettings { @@ -60,7 +64,7 @@ public AppSettingsSection AppSettings /// - /// IOLayer - documentation pending + /// Returns the connection string section. /// public ConnectionStringsSection ConnectionStrings { @@ -73,7 +77,7 @@ public ConnectionStringsSection ConnectionStrings /// - /// IOLayer - documentation pending + /// Returns the configuration sections. /// public ConfigurationSectionCollection Sections { @@ -86,7 +90,7 @@ public ConfigurationSectionCollection Sections /// - /// IOLayer - documentation pending + /// Returns the configuration section group. /// public ConfigurationSectionGroup RootSectionGroup { @@ -99,7 +103,7 @@ public ConfigurationSectionGroup RootSectionGroup /// - /// IOLayer - documentation pending + /// Returns the configuration slection groups. /// public ConfigurationSectionGroupCollection SectionGroups { @@ -112,10 +116,10 @@ public ConfigurationSectionGroupCollection SectionGroups /// - /// IOLayer - documentation pending + /// Gets a named configuration section. /// - /// - /// + /// Name of section to get. + /// Returns the configuration section. public ConfigurationSection GetSection(string sectionName) { return this.Implementation.GetSection(sectionName); @@ -124,10 +128,10 @@ public ConfigurationSection GetSection(string sectionName) /// - /// IOLayer - documentation pending + /// Gets a named configuration section group. /// - /// - /// + /// Name of configuration section group to get. + /// Returns the configuration section group. public ConfigurationSectionGroup GetSectionGroup(string sectionGroupName) { return this.Implementation.GetSectionGroup(sectionGroupName); @@ -136,7 +140,7 @@ public ConfigurationSectionGroup GetSectionGroup(string sectionGroupName) /// - /// IOLayer - documentation pending + /// Saves the configuration. /// public void Save() { @@ -146,9 +150,9 @@ public void Save() /// - /// IOLayer - documentation pending + /// Saves the configuration. /// - /// + /// Save mode to use when saving the configuration. public void Save(ConfigurationSaveMode saveMode) { this.Implementation.Save(saveMode); @@ -157,10 +161,10 @@ public void Save(ConfigurationSaveMode saveMode) /// - /// IOLayer - documentation pending + /// Saves the configuration. /// - /// - /// + /// Save mode to use when saving the configuration. + /// Saves all sections, even non touched. public void Save(ConfigurationSaveMode saveMode, bool forceSaveAll) { this.Implementation.Save(saveMode, forceSaveAll); @@ -169,9 +173,9 @@ public void Save(ConfigurationSaveMode saveMode, bool forceSaveAll) /// - /// IOLayer - documentation pending + /// Saves the configuration to a new file. /// - /// + /// Path to new configuration filename. public void SaveAs(string filename) { this.Implementation.SaveAs(filename); @@ -180,10 +184,10 @@ public void SaveAs(string filename) /// - /// IOLayer - documentation pending + /// Saves the configuration to a new file. /// - /// - /// + /// Path to new configuration filename. + /// Save mode to use when saving the configuration. public void SaveAs(string filename, ConfigurationSaveMode saveMode) { this.Implementation.SaveAs(filename, saveMode); @@ -192,11 +196,11 @@ public void SaveAs(string filename, ConfigurationSaveMode saveMode) /// - /// IOLayer - documentation pending + /// Saves the configuration to a new file. /// - /// - /// - /// + /// Path to new configuration filename. + /// Save mode to use when saving the configuration. + /// Saves all sections, even non touched. public void SaveAs(string filename, ConfigurationSaveMode saveMode, bool forceSaveAll) { this.Implementation.SaveAs(filename, saveMode, forceSaveAll); diff --git a/Composite/Core/IO/C1Directory.cs b/Composite/Core/IO/C1Directory.cs index acb147e172..9da3efc55b 100644 --- a/Composite/Core/IO/C1Directory.cs +++ b/Composite/Core/IO/C1Directory.cs @@ -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 . /// public static class C1Directory { diff --git a/Composite/Core/IO/C1FileInfo.cs b/Composite/Core/IO/C1FileInfo.cs index d559e81ed5..9608a1d09b 100644 --- a/Composite/Core/IO/C1FileInfo.cs +++ b/Composite/Core/IO/C1FileInfo.cs @@ -7,16 +7,20 @@ namespace Composite.Core.IO { /// - /// IOLayer - documentation pending + /// This class is a almost one to one version of System.IO.FileInfo. Using this implementation instead + /// of System.IO.FileInfo, will ensure that your code will work both on Standard Windows deployment + /// and Windows Azure deployment. + /// See System.IO.FileInfo for more documentation on the methods of this class. + /// See . /// public class C1FileInfo : C1FileSystemInfo { private ImplementationContainer _implementation; /// - /// IOLayer - documentation pending + /// Creates a C1FileInfo. /// - /// + /// Path to file. public C1FileInfo(string fileName) { _implementation = new ImplementationContainer(() => ImplementationFactory.CurrentFactory.CreateC1FileInfo(fileName)); @@ -26,7 +30,7 @@ public C1FileInfo(string fileName) /// - /// IOLayer - documentation pending + /// Returns the directory name of the file. /// public string DirectoryName { @@ -39,7 +43,7 @@ public string DirectoryName /// - /// IOLayer - documentation pending + /// Returns a of the file. /// public C1DirectoryInfo Directory { @@ -52,7 +56,7 @@ public C1DirectoryInfo Directory /// - /// IOLayer - documentation pending + /// Returns the name of the file. /// public string Name { @@ -66,7 +70,7 @@ public string Name /// - /// IOLayer - documentation pending + /// Returns the full path and name of the file. /// public override string FullName { @@ -79,7 +83,7 @@ public override string FullName /// - /// IOLayer - documentation pending + /// Returns true if the file exists. Otherwise false. /// public override bool Exists { @@ -92,7 +96,7 @@ public override bool Exists /// - /// IOLayer - documentation pending + /// Returns the extension of the file. /// public override string Extension { @@ -105,7 +109,7 @@ public override string Extension /// - /// IOLayer - documentation pending + /// Returns true if and only if the file is read only. /// public bool IsReadOnly { @@ -118,7 +122,7 @@ public bool IsReadOnly /// - /// IOLayer - documentation pending + /// Returns the size of the file in bytes. /// public long Length { @@ -131,7 +135,7 @@ public long Length /// - /// IOLayer - documentation pending + /// Gets or sets the file attributes on the file. /// public override FileAttributes Attributes { @@ -148,9 +152,9 @@ public override FileAttributes Attributes /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// + /// Returns a newly created . public C1FileStream Create() { return _implementation.Implementation.Create(); @@ -159,9 +163,9 @@ public C1FileStream Create() /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// + /// Returns a newly created . public C1StreamWriter CreateText() { return _implementation.Implementation.CreateText(); @@ -170,9 +174,9 @@ public C1StreamWriter CreateText() /// - /// IOLayer - documentation pending + /// Creates a file stream for appending. /// - /// + /// Returns a newly created for appending. public C1StreamWriter AppendText() { return _implementation.Implementation.AppendText(); @@ -181,10 +185,10 @@ public C1StreamWriter AppendText() /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// - /// + /// File mode to use. + /// Returns a newly created . public C1FileStream Open(FileMode mode) { return _implementation.Implementation.Open(mode); @@ -193,11 +197,11 @@ public C1FileStream Open(FileMode mode) /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// - /// - /// + /// File mode to use. + /// File access to use. + /// Returns a newly created . public C1FileStream Open(FileMode mode, FileAccess access) { return _implementation.Implementation.Open(mode, access); @@ -206,12 +210,12 @@ public C1FileStream Open(FileMode mode, FileAccess access) /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// - /// - /// - /// + /// File mode to use. + /// File access to use. + /// File share to use. + /// Returns a newly created . public C1FileStream Open(FileMode mode, FileAccess access, FileShare share) { return _implementation.Implementation.Open(mode, access, share); @@ -220,9 +224,9 @@ public C1FileStream Open(FileMode mode, FileAccess access, FileShare share) /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// + /// Returns a newly created for reading. public C1FileStream OpenRead() { return _implementation.Implementation.OpenRead(); @@ -231,9 +235,9 @@ public C1FileStream OpenRead() /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// + /// Returns a newly created . public C1StreamReader OpenText() { return _implementation.Implementation.OpenText(); @@ -242,9 +246,9 @@ public C1StreamReader OpenText() /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// + /// Returns a newly created for writing. public C1FileStream OpenWrite() { return _implementation.Implementation.OpenWrite(); @@ -253,10 +257,10 @@ public C1FileStream OpenWrite() /// - /// IOLayer - documentation pending + /// Copies the file to the given path. /// - /// - /// + /// Destination path. + /// A new for the destination file. public C1FileInfo CopyTo(string destFileName) { return _implementation.Implementation.CopyTo(destFileName); @@ -265,11 +269,11 @@ public C1FileInfo CopyTo(string destFileName) /// - /// IOLayer - documentation pending + /// Copies the file to the given path and overwrites any existing file if specified. /// - /// - /// - /// + /// Destination path. + /// If true, any existing file will be overwritten. + /// A new for the destination file. public C1FileInfo CopyTo(string destFileName, bool overwrite) { return _implementation.Implementation.CopyTo(destFileName, overwrite); @@ -278,9 +282,9 @@ public C1FileInfo CopyTo(string destFileName, bool overwrite) /// - /// IOLayer - documentation pending + /// Moves the file to the given path. /// - /// + /// Destination path. public void MoveTo(string destFileName) { _implementation.Implementation.MoveTo(destFileName); @@ -289,11 +293,11 @@ public void MoveTo(string destFileName) /// - /// IOLayer - documentation pending + /// Replaces the given file with this one. /// - /// - /// - /// + /// Destination path to file to replace. + /// Path to backup file. + /// A new for the destination file. public C1FileInfo Replace(string destinationFileName, string destinationBackupFileName) { return _implementation.Implementation.Replace(destinationFileName, destinationBackupFileName); @@ -302,12 +306,12 @@ public C1FileInfo Replace(string destinationFileName, string destinationBackupFi /// - /// IOLayer - documentation pending + /// Replaces the given file with this one. /// - /// - /// + /// Destination path to file to replace. + /// Path to backup file. /// - /// + /// A new for the destination file. public C1FileInfo Replace(string destinationFileName, string destinationBackupFileName, bool ignoreMetadataErrors) { return _implementation.Implementation.Replace(destinationFileName, destinationBackupFileName, ignoreMetadataErrors); @@ -316,39 +320,17 @@ public C1FileInfo Replace(string destinationFileName, string destinationBackupFi /// - /// IOLayer - documentation pending + /// Deletes the file. /// public override void Delete() { _implementation.Implementation.Delete(); - } - - - - /// - /// IOLayer - documentation pending - /// - public override void Refresh() - { - _implementation.Implementation.Refresh(); - } - - - - /// - /// IOLayer - documentation pending - /// - /// - /// - public override void GetObjectData(SerializationInfo info, StreamingContext context) - { - _implementation.Implementation.GetObjectData(info, context); - } + } /// - /// IOLayer - documentation pending + /// Gets or sets the creation time of the file. /// public override DateTime CreationTime { @@ -365,7 +347,7 @@ public override DateTime CreationTime /// - /// IOLayer - documentation pending + /// Gets or sets the creation utc time of the file. /// public override DateTime CreationTimeUtc { @@ -382,7 +364,7 @@ public override DateTime CreationTimeUtc /// - /// IOLayer - documentation pending + /// Gets or sets the last access time of the file. /// public override DateTime LastAccessTime { @@ -399,7 +381,7 @@ public override DateTime LastAccessTime /// - /// IOLayer - documentation pending + /// Gets or sets the last access utc time of the file. /// public override DateTime LastAccessTimeUtc { @@ -416,7 +398,7 @@ public override DateTime LastAccessTimeUtc /// - /// IOLayer - documentation pending + /// Gets or sets the last write time of the file. /// public override DateTime LastWriteTime { @@ -433,7 +415,7 @@ public override DateTime LastWriteTime /// - /// IOLayer - documentation pending + /// Gets or sets the last write utc time of the file. /// public override DateTime LastWriteTimeUtc { @@ -447,6 +429,27 @@ public override DateTime LastWriteTimeUtc } } + + + /// + /// + public override void Refresh() + { + _implementation.Implementation.Refresh(); + } + + + + /// + /// + /// + /// + public override void GetObjectData(SerializationInfo info, StreamingContext context) + { + _implementation.Implementation.GetObjectData(info, context); + } + + //public FileSecurity GetAccessControl(); //public FileSecurity GetAccessControl(AccessControlSections includeSections); //public void SetAccessControl(FileSecurity fileSecurity); diff --git a/Composite/Core/IO/C1FileStream.cs b/Composite/Core/IO/C1FileStream.cs index fc16437368..a0c6f2a6ec 100644 --- a/Composite/Core/IO/C1FileStream.cs +++ b/Composite/Core/IO/C1FileStream.cs @@ -7,7 +7,11 @@ namespace Composite.Core.IO { /// - /// IOLayer - documentation pending + /// This class is a almost one to one version of System.IO.FileStream. Using this implementation instead + /// of System.IO.FileStream, will ensure that your code will work both on Standard Windows deployment + /// and Windows Azure deployment. + /// See System.IO.FileStream for more documentation on the methods of this class. + /// See . /// public class C1FileStream : Stream, IDisposable { @@ -17,10 +21,10 @@ public class C1FileStream : Stream, IDisposable /// - /// IOLayer - documentation pending + /// Creates a new C1FileStream. /// - /// - /// + /// Path to file. + /// File mode to use. public C1FileStream(string path, FileMode mode) : this(path, mode, (mode == FileMode.Append) ? FileAccess.Write : FileAccess.ReadWrite, FileShare.Read, 4096, FileOptions.None) { @@ -29,11 +33,11 @@ public C1FileStream(string path, FileMode mode) /// - /// IOLayer - documentation pending + /// Creates a new C1FileStream. /// - /// - /// - /// + /// Path to file. + /// File mode to use. + /// File access to use. public C1FileStream(string path, FileMode mode, FileAccess access) : this(path, mode, access, FileShare.Read, 4096, FileOptions.None) { @@ -42,12 +46,12 @@ public C1FileStream(string path, FileMode mode, FileAccess access) /// - /// IOLayer - documentation pending + /// Creates a new C1FileStream. /// - /// - /// - /// - /// + /// Path to file. + /// File mode to use. + /// File access to use. + /// File share to use. public C1FileStream(string path, FileMode mode, FileAccess access, FileShare share) : this(path, mode, access, share, 4096, FileOptions.None) { @@ -56,13 +60,13 @@ public C1FileStream(string path, FileMode mode, FileAccess access, FileShare sha /// - /// IOLayer - documentation pending + /// Creates a new C1FileStream. /// - /// - /// - /// - /// - /// + /// Path to file. + /// File mode to use. + /// File access to use. + /// File share to use. + /// Buffer size to use. public C1FileStream(string path, FileMode mode, FileAccess access, FileShare share, int bufferSize) : this(path, mode, access, share, bufferSize, FileOptions.None) { @@ -71,14 +75,14 @@ public C1FileStream(string path, FileMode mode, FileAccess access, FileShare sha /// - /// IOLayer - documentation pending + /// Creates a new C1FileStream. /// - /// - /// - /// - /// - /// - /// + /// Path to file. + /// File mode to use. + /// File access to use. + /// File share to use. + /// Buffer size to use. + /// File options to use. public C1FileStream(string path, FileMode mode, FileAccess access, FileShare share, int bufferSize, FileOptions options) { _implementation = new ImplementationContainer(() => ImplementationFactory.CurrentFactory.CreateC1FileStream(path, mode, access, share, bufferSize, options)); @@ -88,7 +92,7 @@ public C1FileStream(string path, FileMode mode, FileAccess access, FileShare sha /// - /// IOLayer - documentation pending + /// Name of the file. /// public string Name { @@ -101,7 +105,7 @@ public string Name /// - /// IOLayer - documentation pending + /// Size of the file in bytes. /// public override long Length { @@ -114,9 +118,9 @@ public override long Length /// - /// IOLayer - documentation pending + /// Sets the length of the file in bytes. /// - /// + /// New length of file stream. public override void SetLength(long value) { _implementation.Implementation.SetLength(value); @@ -125,7 +129,7 @@ public override void SetLength(long value) /// - /// IOLayer - documentation pending + /// Gets or sets the current read/write position in the file stream. /// public override long Position { @@ -142,13 +146,13 @@ public override long Position /// - /// IOLayer - documentation pending + /// Reads a block of bytes from the file stream. /// - /// - /// - /// - /// - public override int Read([In, Out] byte[] array, int offset, int count) + /// Target buffer of read bytes. + /// Offset in the buffer to put read bytes. + /// Number of bytes to read. + /// Number of bytes read. + public override int Read(byte[] array, int offset, int count) { return _implementation.Implementation.Read(array, offset, count); } @@ -156,9 +160,9 @@ public override int Read([In, Out] byte[] array, int offset, int count) /// - /// IOLayer - documentation pending + /// Reads a byte form the file stream. /// - /// + /// The read byte value. public override int ReadByte() { return _implementation.Implementation.ReadByte(); @@ -167,11 +171,11 @@ public override int ReadByte() /// - /// IOLayer - documentation pending + /// Writes a block of bytes to the file stream. /// - /// - /// - /// + /// Bytes to write to the file. + /// Offset in buffer to write from. + /// Number of bytes to write. public override void Write(byte[] array, int offset, int count) { _implementation.Implementation.Write(array, offset, count); @@ -180,9 +184,9 @@ public override void Write(byte[] array, int offset, int count) /// - /// IOLayer - documentation pending + /// Writes a byte to the file stream. /// - /// + /// Byte value to write. public override void WriteByte(byte value) { _implementation.Implementation.WriteByte(value); @@ -191,11 +195,11 @@ public override void WriteByte(byte value) /// - /// IOLayer - documentation pending + /// Seeks to a position in the file stream. /// - /// - /// - /// + /// Offset to seek. + /// Origin to seek from. + /// The new position in the stream. public override long Seek(long offset, SeekOrigin origin) { return _implementation.Implementation.Seek(offset, origin); @@ -204,7 +208,7 @@ public override long Seek(long offset, SeekOrigin origin) /// - /// IOLayer - documentation pending + /// Returns true if its possible to read from the stream. /// public override bool CanRead { @@ -217,7 +221,7 @@ public override bool CanRead /// - /// IOLayer - documentation pending + /// Returns true if its possible to seek in the stream. /// public override bool CanSeek { @@ -230,7 +234,7 @@ public override bool CanSeek /// - /// IOLayer - documentation pending + /// Returns true if its possible to write to the stream. /// public override bool CanWrite { @@ -243,7 +247,7 @@ public override bool CanWrite /// - /// IOLayer - documentation pending + /// Flushes the buffered bytes to the file. /// public override void Flush() { @@ -253,7 +257,7 @@ public override void Flush() /// - /// IOLayer - documentation pending + /// Flushes the buffered bytes to the file. /// /// public virtual void Flush(bool flushToDisk) @@ -264,7 +268,7 @@ public virtual void Flush(bool flushToDisk) /// - /// IOLayer - documentation pending + /// Closes the file stream. /// public override void Close() { @@ -275,7 +279,7 @@ public override void Close() /// - /// IOLayer - documentation pending + /// Destructor. /// ~C1FileStream() { @@ -285,7 +289,7 @@ public override void Close() /// - /// IOLayer - documentation pending + /// Disposes the file stream. /// /// protected override void Dispose(bool disposing) diff --git a/Composite/Core/IO/C1FileSystemInfo.cs b/Composite/Core/IO/C1FileSystemInfo.cs index 8f0ae8078d..3d626b6df8 100644 --- a/Composite/Core/IO/C1FileSystemInfo.cs +++ b/Composite/Core/IO/C1FileSystemInfo.cs @@ -6,96 +6,97 @@ namespace Composite.Core.IO { /// - /// IOLayer - documentation pending + /// This class is a almost one to one version of System.IO.FileSystemInfo. Using this implementation instead + /// of System.IO.FileSystemInfo, will ensure that your code will work both on Standard Windows deployment + /// and Windows Azure deployment. + /// See System.IO.FileSystemInfo for more documentation on the methods of this class. /// public abstract class C1FileSystemInfo { /// - /// IOLayer - documentation pending + /// Full path name. /// public abstract string FullName { get; } /// - /// IOLayer - documentation pending + /// Extension. /// public abstract string Extension { get; } /// - /// IOLayer - documentation pending + /// Returns true if the file system item exitst. /// public abstract bool Exists { get; } /// - /// IOLayer - documentation pending + /// File attributes of the file system item. /// public abstract FileAttributes Attributes { get; set; } /// - /// IOLayer - documentation pending + /// Deletes the file system item. /// public abstract void Delete(); /// - /// IOLayer - documentation pending + /// Gets or sets the creation time of the file system item. /// public abstract DateTime CreationTime { get; set; } /// - /// IOLayer - documentation pending + /// Gets or sets the creation utc time of the file system item. /// public abstract DateTime CreationTimeUtc { get; set; } /// - /// IOLayer - documentation pending + /// Gets or sets the last access time of the file system item. /// public abstract DateTime LastAccessTime { get; set; } /// - /// IOLayer - documentation pending + /// Gets or sets the last access utc time of the file system item. /// public abstract DateTime LastAccessTimeUtc { get; set; } /// - /// IOLayer - documentation pending + /// Gets or sets the last write time of the file system item. /// public abstract DateTime LastWriteTime { get; set; } /// - /// IOLayer - documentation pending + /// Gets or sets the last write utc time of the file system item. /// public abstract DateTime LastWriteTimeUtc { get; set; } /// - /// IOLayer - documentation pending /// public abstract void GetObjectData(SerializationInfo info, StreamingContext context); /// - /// IOLayer - documentation pending /// public abstract void Refresh(); } diff --git a/Composite/Core/IO/C1FileSystemWatcher.cs b/Composite/Core/IO/C1FileSystemWatcher.cs index dc0d9ba8ca..1f8bd41287 100644 --- a/Composite/Core/IO/C1FileSystemWatcher.cs +++ b/Composite/Core/IO/C1FileSystemWatcher.cs @@ -5,14 +5,18 @@ namespace Composite.Core.IO { /// - /// IOLayer - documentation pending + /// This class is a almost one to one version of System.IO.FileSystemWatcher. Using this implementation instead + /// of System.IO.FileSystemWatcher, will ensure that your code will work both on Standard Windows deployment + /// and Windows Azure deployment. + /// See System.IO.FileSystemWatcher for more documentation on the methods of this class. + /// See . /// public class C1FileSystemWatcher : ImplementationContainer { /// - /// IOLayer - documentation pending + /// Creates a new file system watcher given the path. /// - /// + /// Path to watch. public C1FileSystemWatcher(string path) : this(path, null) { @@ -21,10 +25,10 @@ public C1FileSystemWatcher(string path) /// - /// IOLayer - documentation pending + /// Creates a new file system watcher given the path. /// - /// - /// + /// Path to watch. + /// Filter to use. public C1FileSystemWatcher(string path, string filter) : base(() => ImplementationFactory.CurrentFactory.CreateC1FileSystemWatcher(path, filter)) { @@ -33,7 +37,7 @@ public C1FileSystemWatcher(string path, string filter) /// - /// IOLayer - documentation pending + /// Gets or sets if events should be raised or not. /// public bool EnableRaisingEvents { @@ -50,7 +54,7 @@ public bool EnableRaisingEvents /// - /// IOLayer - documentation pending + /// Path to watch. /// public string Path { @@ -67,7 +71,7 @@ public string Path /// - /// IOLayer - documentation pending + /// Filter to use. /// public string Filter { @@ -84,7 +88,7 @@ public string Filter /// - /// IOLayer - documentation pending + /// Gets or sets of subdirectories should also be watched. /// public bool IncludeSubdirectories { @@ -101,7 +105,7 @@ public bool IncludeSubdirectories /// - /// IOLayer - documentation pending + /// Adds or removes an event handler when new items are created. /// public event FileSystemEventHandler Created { @@ -118,7 +122,7 @@ public event FileSystemEventHandler Created /// - /// IOLayer - documentation pending + /// Adds or removes an event handler when new items changed. /// public event FileSystemEventHandler Changed { @@ -135,7 +139,7 @@ public event FileSystemEventHandler Changed /// - /// IOLayer - documentation pending + /// Adds or removes an event handler when new items are renamed. /// public event RenamedEventHandler Renamed { @@ -152,7 +156,7 @@ public event RenamedEventHandler Renamed /// - /// IOLayer - documentation pending + /// Adds or removes an event handler when new items are deleted. /// public event FileSystemEventHandler Deleted { @@ -169,7 +173,7 @@ public event FileSystemEventHandler Deleted /// - /// IOLayer - documentation pending + /// Adds or removes an event handler when an error occure. /// public event ErrorEventHandler Error { @@ -186,7 +190,7 @@ public event ErrorEventHandler Error /// - /// IOLayer - documentation pending + /// Gets or sets the notify filter. /// public NotifyFilters NotifyFilter { @@ -203,7 +207,7 @@ public NotifyFilters NotifyFilter /// - /// IOLayer - documentation pending + /// Begins the initialization. /// public void BeginInit() { @@ -213,7 +217,7 @@ public void BeginInit() /// - /// IOLayer - documentation pending + /// Ends the initialization. /// public void EndInit() { @@ -223,7 +227,6 @@ public void EndInit() /// - /// IOLayer - documentation pending /// /// /// @@ -235,7 +238,6 @@ public C1WaitForChangedResult WaitForChanged(WatcherChangeTypes changeType) /// - /// IOLayer - documentation pending /// /// /// diff --git a/Composite/Core/IO/C1StreamReader.cs b/Composite/Core/IO/C1StreamReader.cs index 84013762fe..237cb6d711 100644 --- a/Composite/Core/IO/C1StreamReader.cs +++ b/Composite/Core/IO/C1StreamReader.cs @@ -8,7 +8,11 @@ namespace Composite.Core.IO { /// - /// IOLayer - documentation pending + /// This class is a almost one to one version of System.IO.StreamReader. Using this implementation instead + /// of System.IO.StreamReader, will ensure that your code will work both on Standard Windows deployment + /// and Windows Azure deployment. + /// See System.IO.StreamReader for more documentation on the methods of this class. + /// See . /// public class C1StreamReader : TextReader, IDisposable { @@ -16,9 +20,9 @@ public class C1StreamReader : TextReader, IDisposable /// - /// IOLayer - documentation pending + /// Creates a C1StreamReader. /// - /// + /// Path to file. public C1StreamReader(string path) : this(path, Encoding.UTF8, true, 1024) { @@ -27,10 +31,10 @@ public C1StreamReader(string path) /// - /// IOLayer - documentation pending + /// Creates a C1StreamReader. /// - /// - /// + /// Path to file. + /// If true, the encoding will be deteced by the content of the file. public C1StreamReader(string path, bool detectEncodingFromByteOrderMarks) : this(path, Encoding.UTF8, detectEncodingFromByteOrderMarks, 1024) { @@ -39,10 +43,10 @@ public C1StreamReader(string path, bool detectEncodingFromByteOrderMarks) /// - /// IOLayer - documentation pending + /// Creates a C1StreamReader. /// - /// - /// + /// Path to the file. + /// Encoding to use. public C1StreamReader(string path, Encoding encoding) : this(path, encoding, true, 1024) { @@ -51,11 +55,11 @@ public C1StreamReader(string path, Encoding encoding) /// - /// IOLayer - documentation pending + /// Creates a C1StreamReader. /// - /// - /// - /// + /// Path to the file. + /// Encoding to use. + /// If true, the encoding will be deteced by the content of the file. public C1StreamReader(string path, Encoding encoding, bool detectEncodingFromByteOrderMarks) : this(path, encoding, detectEncodingFromByteOrderMarks, 1024) { @@ -64,12 +68,12 @@ public C1StreamReader(string path, Encoding encoding, bool detectEncodingFromByt /// - /// IOLayer - documentation pending + /// Creates a C1StreamReader. /// - /// - /// - /// - /// + /// Path to the file. + /// Encoding to use. + /// If true, the encoding will be deteced by the content of the file. + /// Buffer size to use. public C1StreamReader(string path, Encoding encoding, bool detectEncodingFromByteOrderMarks, int bufferSize) { _implementation = new ImplementationContainer(() => ImplementationFactory.CurrentFactory.CreateC1StreamReader(path, encoding, detectEncodingFromByteOrderMarks, bufferSize)); @@ -78,9 +82,9 @@ public C1StreamReader(string path, Encoding encoding, bool detectEncodingFromByt /// - /// IOLayer - documentation pending + /// Creates a C1StreamReader. /// - /// + /// Stream to ream from. public C1StreamReader(Stream stream) : this(stream, Encoding.UTF8, true, 1024) { @@ -89,10 +93,10 @@ public C1StreamReader(Stream stream) /// - /// IOLayer - documentation pending + /// Creates a C1StreamReader. /// - /// - /// + /// Stream to ream from. + /// If true, the encoding will be deteced by the content of the file. public C1StreamReader(Stream stream, bool detectEncodingFromByteOrderMarks) : this(stream, Encoding.UTF8, detectEncodingFromByteOrderMarks, 1024) { @@ -101,10 +105,10 @@ public C1StreamReader(Stream stream, bool detectEncodingFromByteOrderMarks) /// - /// IOLayer - documentation pending + /// Creates a C1StreamReader. /// - /// - /// + /// Stream to ream from. + /// Encoding to use. public C1StreamReader(Stream stream, Encoding encoding) : this(stream, encoding, true, 1024) { @@ -113,11 +117,11 @@ public C1StreamReader(Stream stream, Encoding encoding) /// - /// IOLayer - documentation pending + /// Creates a C1StreamReader. /// - /// - /// - /// + /// Stream to ream from. + /// Encoding to use. + /// If true, the encoding will be deteced by the content of the file. public C1StreamReader(Stream stream, Encoding encoding, bool detectEncodingFromByteOrderMarks) : this(stream, encoding, detectEncodingFromByteOrderMarks, 1024) { @@ -126,12 +130,12 @@ public C1StreamReader(Stream stream, Encoding encoding, bool detectEncodingFromB /// - /// IOLayer - documentation pending + /// Creates a C1StreamReader. /// - /// - /// - /// - /// + /// Stream to ream from. + /// Encoding to use. + /// If true, the encoding will be deteced by the content of the file. + /// Buffer size to use. public C1StreamReader(Stream stream, Encoding encoding, bool detectEncodingFromByteOrderMarks, int bufferSize) { _implementation = new ImplementationContainer(() => ImplementationFactory.CurrentFactory.CreateC1StreamReader(stream, encoding, detectEncodingFromByteOrderMarks, bufferSize)); @@ -140,9 +144,9 @@ public C1StreamReader(Stream stream, Encoding encoding, bool detectEncodingFromB /// - /// IOLayer - documentation pending + /// Reads a byte from the stream. /// - /// + /// Returns the read byte. public override int Read() { return _implementation.Implementation.Read(); @@ -151,13 +155,13 @@ public override int Read() /// - /// IOLayer - documentation pending + /// Reads a block from the file. /// - /// - /// - /// - /// - public override int Read([In, Out] char[] buffer, int index, int count) + /// Buffer to read into. + /// Index in buffer to start storing bytes. + /// Number of bytes to read. + /// Returns the number read bytes. + public override int Read(char[] buffer, int index, int count) { return _implementation.Implementation.Read(buffer, index, count); } @@ -165,9 +169,9 @@ public override int Read([In, Out] char[] buffer, int index, int count) /// - /// IOLayer - documentation pending + /// Read a line from the file. /// - /// + /// Returns the read line. public override string ReadLine() { return _implementation.Implementation.ReadLine(); @@ -176,9 +180,9 @@ public override string ReadLine() /// - /// IOLayer - documentation pending + /// Read all the content of the file into a strng. /// - /// + /// The content of the file. public override string ReadToEnd() { return _implementation.Implementation.ReadToEnd(); @@ -187,12 +191,12 @@ public override string ReadToEnd() /// - /// IOLayer - documentation pending + /// Reads a block from the file. /// - /// - /// - /// - /// + /// Buffer to store read chars. + /// Index in buffer to start storing chars. + /// Number of chars to read. + /// Returns the number of read chars. public override int ReadBlock(char[] buffer, int index, int count) { return _implementation.Implementation.ReadBlock(buffer, index, count); @@ -201,9 +205,9 @@ public override int ReadBlock(char[] buffer, int index, int count) /// - /// IOLayer - documentation pending + /// Peeks the current byte. /// - /// + /// The current byte. public override int Peek() { return _implementation.Implementation.Peek(); @@ -212,7 +216,7 @@ public override int Peek() /// - /// IOLayer - documentation pending + /// Returns true if the stream is at the end of stream. /// public bool EndOfStream { @@ -225,7 +229,7 @@ public bool EndOfStream /// - /// IOLayer - documentation pending + /// Closes the stream. /// public override void Close() { @@ -235,7 +239,7 @@ public override void Close() /// - /// IOLayer - documentation pending + /// Returns the base stream. /// public virtual Stream BaseStream { @@ -248,7 +252,7 @@ public virtual Stream BaseStream /// - /// IOLayer - documentation pending + /// Returns the current encoding of the stream. /// public virtual Encoding CurrentEncoding { @@ -261,7 +265,7 @@ public virtual Encoding CurrentEncoding /// - /// IOLayer - documentation pending + /// Destructor. /// ~C1StreamReader() { @@ -271,9 +275,9 @@ public virtual Encoding CurrentEncoding /// - /// IOLayer - documentation pending + /// Disposes the stream. /// - /// + /// Ttrue if the stream is disposing. protected override void Dispose(bool disposing) { if (disposing) diff --git a/Composite/Core/IO/C1StreamWriter.cs b/Composite/Core/IO/C1StreamWriter.cs index 344cbcd575..e23fcc77a0 100644 --- a/Composite/Core/IO/C1StreamWriter.cs +++ b/Composite/Core/IO/C1StreamWriter.cs @@ -7,7 +7,11 @@ namespace Composite.Core.IO { /// - /// IOLayer - documentation pending + /// This class is a almost one to one version of System.IO.StreamWriter. Using this implementation instead + /// of System.IO.StreamWriter, will ensure that your code will work both on Standard Windows deployment + /// and Windows Azure deployment. + /// See System.IO.StreamWriter for more documentation on the methods of this class. + /// See . /// public class C1StreamWriter : TextWriter, IDisposable { @@ -15,9 +19,9 @@ public class C1StreamWriter : TextWriter, IDisposable /// - /// IOLayer - documentation pending + /// Creates a C1StreamWriter. /// - /// + /// Path to file. public C1StreamWriter(string path) : this(path, false, Encoding.UTF8, 1024) { @@ -26,10 +30,10 @@ public C1StreamWriter(string path) /// - /// IOLayer - documentation pending + /// Creates a C1StreamWriter. /// - /// - /// + /// Path to file. + /// If this is true, any writing will be appended to the file. public C1StreamWriter(string path, bool append) : this(path, append, Encoding.UTF8, 1024) { @@ -38,11 +42,11 @@ public C1StreamWriter(string path, bool append) /// - /// IOLayer - documentation pending + /// Creates a C1StreamWriter. /// - /// - /// - /// + /// Path to file. + /// If this is true, any writing will be appended to the file. + /// Encoding to use. public C1StreamWriter(string path, bool append, Encoding encoding) : this(path, append, encoding, 1024) { @@ -51,12 +55,12 @@ public C1StreamWriter(string path, bool append, Encoding encoding) /// - /// IOLayer - documentation pending + /// Creates a C1StreamWriter. /// - /// - /// - /// - /// + /// Path to file. + /// If this is true, any writing will be appended to the file. + /// Encoding to use. + /// Buffer size to use. public C1StreamWriter(string path, bool append, Encoding encoding, int bufferSize) { _implementation = new ImplementationContainer(() => ImplementationFactory.CurrentFactory.CreateC1StreamWriter(path, append, encoding, bufferSize)); @@ -65,9 +69,9 @@ public C1StreamWriter(string path, bool append, Encoding encoding, int bufferSiz /// - /// IOLayer - documentation pending + /// Creates a C1StreamWriter. /// - /// + /// Stream to use. public C1StreamWriter(Stream stream) : this(stream, Encoding.UTF8, 1024) { @@ -76,10 +80,10 @@ public C1StreamWriter(Stream stream) /// - /// IOLayer - documentation pending + /// Creates a C1StreamWriter. /// - /// - /// + /// Stream to use. + /// Encoding to use. public C1StreamWriter(Stream stream, Encoding encoding) : this(stream, encoding, 1024) { @@ -88,11 +92,11 @@ public C1StreamWriter(Stream stream, Encoding encoding) /// - /// IOLayer - documentation pending + /// Creates a C1StreamWriter. /// - /// - /// - /// + /// Stream to use. + /// Encoding to use. + /// Buffer size to use. public C1StreamWriter(Stream stream, Encoding encoding, int bufferSize) { _implementation = new ImplementationContainer(() => ImplementationFactory.CurrentFactory.CreateC1StreamWriter(stream, encoding, bufferSize)); @@ -101,9 +105,9 @@ public C1StreamWriter(Stream stream, Encoding encoding, int bufferSize) /// - /// IOLayer - documentation pending + /// Writes a string to the stream. /// - /// + /// String to write. public override void Write(string value) { _implementation.Implementation.Write(value); @@ -112,10 +116,10 @@ public override void Write(string value) /// - /// IOLayer - documentation pending + /// Writes a formatted string to the stream. /// - /// - /// + /// String with formatting to write. + /// String format argument. public override void Write(string format, object arg0) { _implementation.Implementation.Write(format, arg0); @@ -124,11 +128,11 @@ public override void Write(string format, object arg0) /// - /// IOLayer - documentation pending + /// Writes a formatted string to the stream. /// - /// - /// - /// + /// String with formatting to write. + /// String format argument. + /// String format argument. public override void Write(string format, object arg0, object arg1) { _implementation.Implementation.Write(format, arg0, arg1); @@ -137,12 +141,12 @@ public override void Write(string format, object arg0, object arg1) /// - /// IOLayer - documentation pending + /// Writes a formatted string to the stream. /// - /// - /// - /// - /// + /// String with formatting to write. + /// String format argument. + /// String format argument. + /// String format argument. public override void Write(string format, object arg0, object arg1, object arg2) { _implementation.Implementation.Write(format, arg0, arg1, arg2); @@ -151,10 +155,10 @@ public override void Write(string format, object arg0, object arg1, object arg2) /// - /// IOLayer - documentation pending + /// Writes a formatted string to the stream. /// - /// - /// + /// String with formatting to write. + /// String format arguments. public override void Write(string format, params object[] arg) { _implementation.Implementation.Write(format, arg); @@ -163,9 +167,9 @@ public override void Write(string format, params object[] arg) /// - /// IOLayer - documentation pending + /// Writes a char to the stream. /// - /// + /// The char value to write. public override void Write(char value) { _implementation.Implementation.Write(value); @@ -174,9 +178,9 @@ public override void Write(char value) /// - /// IOLayer - documentation pending + /// Writes a char array to the stream. /// - /// + /// Char array to write. public override void Write(char[] buffer) { _implementation.Implementation.Write(buffer); @@ -185,11 +189,11 @@ public override void Write(char[] buffer) /// - /// IOLayer - documentation pending + /// Writes a char array to the stream. /// - /// - /// - /// + /// Char array to write. + /// Start index in the buffer to start writing from. + /// Number of chars to write. public override void Write(char[] buffer, int index, int count) { _implementation.Implementation.Write(buffer, index, count); @@ -198,9 +202,9 @@ public override void Write(char[] buffer, int index, int count) /// - /// IOLayer - documentation pending + /// Writes a boolean to the stream. /// - /// + /// Boolean value to write. public override void Write(bool value) { _implementation.Implementation.Write(value); @@ -209,9 +213,9 @@ public override void Write(bool value) /// - /// IOLayer - documentation pending + /// Writes an integer to the stream. /// - /// + /// Integer value to write. public override void Write(int value) { _implementation.Implementation.Write(value); @@ -220,9 +224,9 @@ public override void Write(int value) /// - /// IOLayer - documentation pending + /// Writes an unsigned integer to the stream. /// - /// + /// Unsigned integer value to write public override void Write(uint value) { _implementation.Implementation.Write(value); @@ -231,9 +235,9 @@ public override void Write(uint value) /// - /// IOLayer - documentation pending + /// Writes a long to the stream. /// - /// + /// Long value to write. public override void Write(long value) { _implementation.Implementation.Write(value); @@ -242,9 +246,9 @@ public override void Write(long value) /// - /// IOLayer - documentation pending + /// Writes a unsigned long to the stream. /// - /// + /// Unsigned long value to write. public override void Write(ulong value) { _implementation.Implementation.Write(value); @@ -253,9 +257,9 @@ public override void Write(ulong value) /// - /// IOLayer - documentation pending + /// Writes a float to the stream. /// - /// + /// Float value to write. public override void Write(float value) { _implementation.Implementation.Write(value); @@ -264,9 +268,9 @@ public override void Write(float value) /// - /// IOLayer - documentation pending + /// Writes a double to the stream. /// - /// + /// Double value to write. public override void Write(double value) { _implementation.Implementation.Write(value); @@ -275,9 +279,9 @@ public override void Write(double value) /// - /// IOLayer - documentation pending + /// Writes a decimal to the stream. /// - /// + /// Decimal value to write. public override void Write(decimal value) { _implementation.Implementation.Write(value); @@ -286,9 +290,9 @@ public override void Write(decimal value) /// - /// IOLayer - documentation pending + /// Write an object to the stream. /// - /// + /// Object value to write. public override void Write(object value) { _implementation.Implementation.Write(value); @@ -297,7 +301,7 @@ public override void Write(object value) /// - /// IOLayer - documentation pending + /// Writes a line break to the stream. /// public override void WriteLine() { @@ -307,9 +311,9 @@ public override void WriteLine() /// - /// IOLayer - documentation pending + /// Writes a string with a line break to the stream. /// - /// + /// String value to write. public override void WriteLine(string value) { _implementation.Implementation.WriteLine(value); @@ -318,10 +322,10 @@ public override void WriteLine(string value) /// - /// IOLayer - documentation pending + /// Writes a string with a line break to the stream. /// - /// - /// + /// String with formatting to write. + /// String format argument. public override void WriteLine(string format, object arg0) { _implementation.Implementation.WriteLine(format, arg0); @@ -330,11 +334,11 @@ public override void WriteLine(string format, object arg0) /// - /// IOLayer - documentation pending + /// Writes a string with a line break to the stream. /// - /// - /// - /// + /// String with formatting to write. + /// String format argument. + /// String format argument. public override void WriteLine(string format, object arg0, object arg1) { _implementation.Implementation.WriteLine(format, arg0, arg1); @@ -343,12 +347,12 @@ public override void WriteLine(string format, object arg0, object arg1) /// - /// IOLayer - documentation pending + /// Writes a string with a line break to the stream. /// - /// - /// - /// - /// + /// String with formatting to write. + /// String format argument. + /// String format argument. + /// String format argument. public override void WriteLine(string format, object arg0, object arg1, object arg2) { _implementation.Implementation.WriteLine(format, arg0, arg1, arg2); @@ -357,10 +361,10 @@ public override void WriteLine(string format, object arg0, object arg1, object a /// - /// IOLayer - documentation pending + /// Writes a string with a line break to the stream. /// - /// - /// + /// String with formatting to write. + /// String format arguments. public override void WriteLine(string format, params object[] arg) { _implementation.Implementation.WriteLine(format, arg); @@ -369,9 +373,9 @@ public override void WriteLine(string format, params object[] arg) /// - /// IOLayer - documentation pending + /// Writes a char with a line break to the stream. /// - /// + /// Char value to write. public override void WriteLine(char value) { _implementation.Implementation.WriteLine(value); @@ -380,9 +384,9 @@ public override void WriteLine(char value) /// - /// IOLayer - documentation pending + /// Writes a char array with a line break to the stream. /// - /// + /// Char array to write. public override void WriteLine(char[] buffer) { _implementation.Implementation.WriteLine(buffer); @@ -391,11 +395,11 @@ public override void WriteLine(char[] buffer) /// - /// IOLayer - documentation pending + /// Writes a char array with a line break to the stream. /// - /// - /// - /// + /// Char array to write. + /// Index in the char array to start writing from. + /// Number of chars to write. public override void WriteLine(char[] buffer, int index, int count) { _implementation.Implementation.WriteLine(buffer, index, count); @@ -404,9 +408,9 @@ public override void WriteLine(char[] buffer, int index, int count) /// - /// IOLayer - documentation pending + /// Writes a bool with a line break to the stream. /// - /// + /// Bool value to write. public override void WriteLine(bool value) { _implementation.Implementation.WriteLine(value); @@ -415,9 +419,9 @@ public override void WriteLine(bool value) /// - /// IOLayer - documentation pending + /// Writes a integer with a line break to the stream. /// - /// + /// Integer value to write. public override void WriteLine(int value) { _implementation.Implementation.WriteLine(value); @@ -426,9 +430,9 @@ public override void WriteLine(int value) /// - /// IOLayer - documentation pending + /// Writes a unsigned integer with a line break to the stream. /// - /// + /// Unsigned integer to write. public override void WriteLine(uint value) { _implementation.Implementation.WriteLine(value); @@ -437,9 +441,9 @@ public override void WriteLine(uint value) /// - /// IOLayer - documentation pending + /// Writes a long with a line break to the stream. /// - /// + /// Long value to write. public override void WriteLine(long value) { _implementation.Implementation.WriteLine(value); @@ -448,9 +452,9 @@ public override void WriteLine(long value) /// - /// IOLayer - documentation pending + /// Writes a unsigned long with a line break to the stream. /// - /// + /// Unsigned long value to write. public override void WriteLine(ulong value) { _implementation.Implementation.WriteLine(value); @@ -459,9 +463,9 @@ public override void WriteLine(ulong value) /// - /// IOLayer - documentation pending + /// Writes a float with a line break to the stream. /// - /// + /// Float value to write. public override void WriteLine(float value) { _implementation.Implementation.WriteLine(value); @@ -470,9 +474,9 @@ public override void WriteLine(float value) /// - /// IOLayer - documentation pending + /// Writes a double with a line break to the stream. /// - /// + /// Double value to write. public override void WriteLine(double value) { _implementation.Implementation.WriteLine(value); @@ -481,9 +485,9 @@ public override void WriteLine(double value) /// - /// IOLayer - documentation pending + /// Writes a decimal with a line break to the stream. /// - /// + /// Decimal value to write. public override void WriteLine(decimal value) { _implementation.Implementation.WriteLine(value); @@ -492,9 +496,9 @@ public override void WriteLine(decimal value) /// - /// IOLayer - documentation pending + /// Writes an object with a line break to the stream. /// - /// + /// Object value to write. public override void WriteLine(object value) { _implementation.Implementation.WriteLine(value); @@ -503,7 +507,7 @@ public override void WriteLine(object value) /// - /// IOLayer - documentation pending + /// Gets or sets the line break value. /// public override string NewLine { @@ -520,7 +524,7 @@ public override string NewLine /// - /// IOLayer - documentation pending + /// Gets the format provider used. /// public override IFormatProvider FormatProvider { @@ -533,7 +537,7 @@ public override IFormatProvider FormatProvider /// - /// IOLayer - documentation pending + /// Flushes the stream. /// public override void Flush() { @@ -543,7 +547,7 @@ public override void Flush() /// - /// IOLayer - documentation pending + /// Gets or sets whether the stream is auto flushed or not /// public virtual bool AutoFlush { @@ -560,7 +564,7 @@ public virtual bool AutoFlush /// - /// IOLayer - documentation pending + /// Closes the stream. /// public override void Close() { @@ -570,7 +574,7 @@ public override void Close() /// - /// IOLayer - documentation pending + /// The base streawm. /// public virtual Stream BaseStream { @@ -583,7 +587,7 @@ public virtual Stream BaseStream /// - /// IOLayer - documentation pending + /// Gets the encoding used. /// public override Encoding Encoding { @@ -595,7 +599,9 @@ public override Encoding Encoding - /// + /// + /// Desctructor. + /// ~C1StreamWriter() { Dispose(false); @@ -604,9 +610,9 @@ public override Encoding Encoding /// - /// IOLayer - documentation pending + /// Disposes the stream. /// - /// + /// True if the stream is disposing. protected override void Dispose(bool disposing) { if (disposing) diff --git a/Composite/Core/IO/C1WaitForChangedResult.cs b/Composite/Core/IO/C1WaitForChangedResult.cs index d3ba776acb..b65de13f8b 100644 --- a/Composite/Core/IO/C1WaitForChangedResult.cs +++ b/Composite/Core/IO/C1WaitForChangedResult.cs @@ -5,21 +5,36 @@ namespace Composite.Core.IO { /// - /// IOLayer - documentation pending + /// This class is a almost one to one version of System.IO.WaitForChangedResult. Using this implementation instead + /// of System.IO.WaitForChangedResult, will ensure that your code will work both on Standard Windows deployment + /// and Windows Azure deployment. + /// See System.IO.WaitForChangedResult for more documentation on the methods of this class. + /// Used by /// [StructLayout(LayoutKind.Sequential)] public struct C1WaitForChangedResult { - /// + /// + /// Gets or sets the name of the changed file system item. + /// public string Name { get; set; } - /// + + /// + /// Gets or sets the old name of the changed file system item. + /// public string OldName { get; set; } - /// + + /// + /// Gets or sets the type of the change. + /// public WatcherChangeTypes ChangeType { get; set; } - /// + + /// + /// Gets or sets whether the operation timed out. + /// public bool TimedOut { get; set; } } } diff --git a/Composite/Core/IO/Plugins/IOProvider/IC1Configuration.cs b/Composite/Core/IO/Plugins/IOProvider/IC1Configuration.cs index ea7d364623..2897c92181 100644 --- a/Composite/Core/IO/Plugins/IOProvider/IC1Configuration.cs +++ b/Composite/Core/IO/Plugins/IOProvider/IC1Configuration.cs @@ -3,125 +3,125 @@ namespace Composite.Core.IO.Plugins.IOProvider { - /// - /// IOLayer - documentation pending - /// + /// Implementations of this interface is used by C1 through + /// to provide the behavior of . + /// See for more information. public interface IC1Configuration { /// - /// IOLayer - documentation pending + /// Gets the path to the configuration file. /// string FilePath { get; } /// - /// IOLayer - documentation pending + /// Returns true if the configuration file exists. /// bool HasFile { get; } /// - /// IOLayer - documentation pending + /// Returns the app setttings section. /// AppSettingsSection AppSettings { get; } /// - /// IOLayer - documentation pending + /// Returns the connection string section. /// ConnectionStringsSection ConnectionStrings { get; } /// - /// IOLayer - documentation pending + /// Returns the configuration sections. /// ConfigurationSectionCollection Sections { get; } /// - /// IOLayer - documentation pending + /// Returns the configuration section group. /// ConfigurationSectionGroup RootSectionGroup { get; } /// - /// IOLayer - documentation pending + /// Returns the configuration slection groups. /// ConfigurationSectionGroupCollection SectionGroups { get; } /// - /// IOLayer - documentation pending + /// Gets a named configuration section. /// - /// - /// + /// Name of section to get. + /// Returns the configuration section. ConfigurationSection GetSection(string sectionName); /// - /// IOLayer - documentation pending + /// Gets a named configuration section group. /// - /// - /// + /// Name of configuration section group to get. + /// Returns the configuration section group. ConfigurationSectionGroup GetSectionGroup(string sectionGroupName); /// - /// IOLayer - documentation pending + /// Saves the configuration. /// void Save(); /// - /// IOLayer - documentation pending + /// Saves the configuration. /// - /// + /// Save mode to use when saving the configuration. void Save(ConfigurationSaveMode saveMode); /// - /// IOLayer - documentation pending + /// Saves the configuration. /// - /// - /// + /// Save mode to use when saving the configuration. + /// Saves all sections, even non touched. void Save(ConfigurationSaveMode saveMode, bool forceSaveAll); /// - /// IOLayer - documentation pending + /// Saves the configuration to a new file. /// - /// + /// Path to new configuration filename. void SaveAs(string filename); /// - /// IOLayer - documentation pending + /// Saves the configuration to a new file. /// - /// - /// + /// Path to new configuration filename. + /// Save mode to use when saving the configuration. void SaveAs(string filename, ConfigurationSaveMode saveMode); /// - /// IOLayer - documentation pending + /// Saves the configuration to a new file. /// - /// - /// - /// + /// Path to new configuration filename. + /// Save mode to use when saving the configuration. + /// Saves all sections, even non touched. void SaveAs(string filename, ConfigurationSaveMode saveMode, bool forceSaveAll); } } diff --git a/Composite/Core/IO/Plugins/IOProvider/IC1Directory.cs b/Composite/Core/IO/Plugins/IOProvider/IC1Directory.cs index b11a49bf03..336789b927 100644 --- a/Composite/Core/IO/Plugins/IOProvider/IC1Directory.cs +++ b/Composite/Core/IO/Plugins/IOProvider/IC1Directory.cs @@ -5,146 +5,148 @@ namespace Composite.Core.IO.Plugins.IOProvider { /// - /// IOLayer - documentation pending + /// Implementations of this interface is used by C1 through + /// to provide the behavior of . + /// See for more information. /// public interface IC1Directory { /// - /// IOLayer - documentation pending + /// Creates a directory. /// - /// - /// + /// Path to directory to create. + /// Returns a C1DirectoryInfo to the specified path. C1DirectoryInfo CreateDirectory(string path); /// - /// IOLayer - documentation pending + /// Deletes an empty directory on the given path. /// - /// + /// Path of empty directory to delete. void Delete(string path); /// - /// IOLayer - documentation pending + /// Deletes the directory and if specified subdirectories and file on the given path. /// - /// - /// + /// Path of directory to delete. + /// Include subdirectories and files. void Delete(string path, bool recursive); /// - /// IOLayer - documentation pending + /// Moves a file or directory from the given source path to the given destination path. /// - /// - /// + /// Path of file or directory to move. + /// Target path of file or directory to be moved to. void Move(string sourceDirName, string destDirName); /// - /// IOLayer - documentation pending + /// Determines if the directory in the given path exists or not. /// - /// + /// Path to directory to test. /// bool Exists(string path); /// - /// IOLayer - documentation pending + /// Returns the current directory. /// - /// + /// The current directory. string GetCurrentDirectory(); /// - /// IOLayer - documentation pending + /// Sets the current directory /// - /// + /// Path to new current directory. void SetCurrentDirectory(string path); /// - /// IOLayer - documentation pending + /// Gets the parent of the given directory. /// - /// - /// + /// Path of directory to get parent of. + /// The parent of the given directory. C1DirectoryInfo GetParent(string path); /// - /// IOLayer - documentation pending + /// Returns volume and/or root information of the given directory. /// - /// - /// + /// Path of directory to get root information of. + /// Volume and/or root information. string GetDirectoryRoot(string path); /// - /// IOLayer - documentation pending + /// Gets the subdirectories of the given directory. /// - /// - /// + /// Path to directory to get subdirectories. + /// Subdirectories of the given directory. string[] GetDirectories(string path); /// - /// IOLayer - documentation pending + /// Gets the subdirectories of the given directory with the given search pattern. /// - /// - /// - /// + /// Path to directory to get subdirectories. + /// Search pattern to use. + /// Subdirectories of the given directory with the given search parrern. string[] GetDirectories(string path, string searchPattern); /// - /// IOLayer - documentation pending + /// Gets the subdirectories of the given directory with the given search pattern and options. /// - /// - /// - /// - /// + /// Path to directory to get subdirectories. + /// Search pattern to use. + /// Search options to use. + /// Subdirectories of the given directory with the given search parrern and options. string[] GetDirectories(string path, string searchPattern, SearchOption searchOption); /// - /// IOLayer - documentation pending + /// Gets the files in the given directory. /// - /// - /// + /// Path to directory go get files from. + /// Files in the given directory. string[] GetFiles(string path); /// - /// IOLayer - documentation pending + /// Gets the files in the given directory with the given search pattern. /// - /// - /// - /// + /// Path to directory go get files from. + /// Search pattern to use. + /// Files in the given directory with the given search pattern. string[] GetFiles(string path, string searchPattern); /// - /// IOLayer - documentation pending + /// Gets the files in the given directory with the given search pattern and options. /// - /// - /// - /// - /// + /// Path to directory go get files from. + /// Search pattern to use. + /// Search options to use. + /// Files in the given directory with the given search pattern and options. string[] GetFiles(string path, string searchPattern, SearchOption searchOption); /// - /// IOLayer - documentation pending + /// Returns the creation date and time of the given directory. /// - /// - /// + /// Path of directory. + /// Creation date and time of the given directory. DateTime GetCreationTime(string path); /// - /// IOLayer - documentation pending + /// Returns the creation date and utc time of the given directory. /// - /// - /// + /// Path of directory. + /// Creation date and time of the given directory. DateTime GetCreationTimeUtc(string path); } } diff --git a/Composite/Core/IO/Plugins/IOProvider/IC1DirectoryInfo.cs b/Composite/Core/IO/Plugins/IOProvider/IC1DirectoryInfo.cs index f2662c48cd..34585b2a86 100644 --- a/Composite/Core/IO/Plugins/IOProvider/IC1DirectoryInfo.cs +++ b/Composite/Core/IO/Plugins/IOProvider/IC1DirectoryInfo.cs @@ -6,202 +6,202 @@ namespace Composite.Core.IO.Plugins.IOProvider { /// - /// IOLayer - documentation pending + /// Implementations of this interface is used by C1 through + /// to provide the behavior of . + /// See for more information. /// public interface IC1DirectoryInfo { /// - /// IOLayer - documentation pending + /// The name of the directory. /// string Name { get; } /// - /// IOLayer - documentation pending + /// Full path of the directory. /// string FullName { get; } /// - /// IOLayer - documentation pending + /// The extension of the directory. /// string Extension { get; } /// - /// IOLayer - documentation pending + /// Tells if the directory exists or not. /// bool Exists { get; } /// - /// IOLayer - documentation pending + /// The root directory of the directory. /// C1DirectoryInfo Root { get; } /// - /// IOLayer - documentation pending + /// The parent directory of the directory. /// C1DirectoryInfo Parent { get; } /// - /// IOLayer - documentation pending + /// File attributes of the directory. /// FileAttributes Attributes { get; set; } /// - /// IOLayer - documentation pending + /// Returns the subdirectories of the directory. /// - /// + /// Subdirectories of the directory. C1DirectoryInfo[] GetDirectories(); /// - /// IOLayer - documentation pending + /// Returns the subdirectores of the directory given the search pattern. /// - /// - /// + /// Search pattern to use. + /// Subdirectories of the directory. C1DirectoryInfo[] GetDirectories(string searchPattern); /// - /// IOLayer - documentation pending + /// Returns the subdirectores of the directory given the search pattern and options. /// - /// - /// - /// + /// The search pattern to use. + /// The search options to use. + /// Subdirectories of the directory. C1DirectoryInfo[] GetDirectories(string searchPattern, SearchOption searchOption); /// - /// IOLayer - documentation pending + /// Returns the files in the directory. /// - /// + /// Files in the directory. C1FileInfo[] GetFiles(); /// - /// IOLayer - documentation pending + /// Returns the files in the directory given the search pattern. /// - /// - /// + /// The search pattern to use. + /// Files in the directory given the search pattern. C1FileInfo[] GetFiles(string searchPattern); /// - /// IOLayer - documentation pending + /// Returns the files in the directory given the search pattern and options. /// - /// - /// - /// + /// The search pattern to use. + /// The search options to use. + /// Files in the directory given the search pattern and options. C1FileInfo[] GetFiles(string searchPattern, SearchOption searchOption); /// - /// IOLayer - documentation pending + /// Creates the directory. /// void Create(); /// - /// IOLayer - documentation pending + /// Creates a subdirectory. /// - /// + /// Path to directory to create. /// - C1DirectoryInfo CreateSubdirectory(string path); + C1DirectoryInfo CreateSubdirectory(string path); /// - /// IOLayer - documentation pending + /// Moves the directory to the given path. /// - /// + /// Destination directory name. void MoveTo(string destDirName); /// - /// IOLayer - documentation pending + /// Deletes the directory if empty. /// void Delete(); + /// - /// IOLayer - documentation pending + /// Deletes the directory, files and subdirectories if specified. /// - /// - void Delete(bool recursive); + /// If true, a recursive delete will be performced. + void Delete(bool recursive); /// - /// IOLayer - documentation pending + /// The creation time of the directory. /// - void GetObjectData(SerializationInfo info, StreamingContext context); + DateTime CreationTime { get; set; } /// - /// IOLayer - documentation pending + /// The creation utc time of the directory. /// - void Refresh(); - + DateTime CreationTimeUtc { get; set; } /// - /// IOLayer - documentation pending + /// Last access time of the directory. /// - DateTime CreationTime { get; set; } + DateTime LastAccessTime { get; set; } /// - /// IOLayer - documentation pending + /// Last access utc time of the directory. /// - DateTime CreationTimeUtc { get; set; } + DateTime LastAccessTimeUtc { get; set; } /// - /// IOLayer - documentation pending + /// Last write time of the directory. /// - DateTime LastAccessTime { get; set; } + DateTime LastWriteTime { get; set; } /// - /// IOLayer - documentation pending + /// Last write utc time of the directory. /// - DateTime LastAccessTimeUtc { get; set; } + DateTime LastWriteTimeUtc { get; set; } /// - /// IOLayer - documentation pending /// - DateTime LastWriteTime { get; set; } + void GetObjectData(SerializationInfo info, StreamingContext context); /// - /// IOLayer - documentation pending /// - DateTime LastWriteTimeUtc { get; set; } + void Refresh(); } } diff --git a/Composite/Core/IO/Plugins/IOProvider/IC1File.cs b/Composite/Core/IO/Plugins/IOProvider/IC1File.cs index 111609daf3..c9ea92f12f 100644 --- a/Composite/Core/IO/Plugins/IOProvider/IC1File.cs +++ b/Composite/Core/IO/Plugins/IOProvider/IC1File.cs @@ -7,434 +7,439 @@ namespace Composite.Core.IO.Plugins.IOProvider { /// - /// IOLayer - documentation pending + /// Implementations of this interface is used by C1 through + /// to provide the behavior of . + /// See for more information. /// public interface IC1File { /// - /// IOLayer - documentation pending + /// Determins if the given file exists or not. /// - /// - /// + /// Path to the file. + /// Returns true if the file exists, false if not. bool Exists(string path); /// - /// IOLayer - documentation pending + /// This is not a port of the System.IO.File. This method can be used to 'touch' an + /// existing file. This is a way of telling the C1 IO system that the file has been + /// touched and C1 uses this to handle other than standard Windows deployments, like + /// Windows Azure. /// - /// + /// Path to file to touch. void Touch(string path); /// - /// IOLayer - documentation pending + /// Copies a file. /// - /// - /// + /// Source path of file to copy. + /// Target path of the file to be copied to. void Copy(string sourceFileName, string destFileName); /// - /// IOLayer - documentation pending + /// Copies a file. /// - /// - /// - /// + /// Source path of file to copy. + /// Target path of the file to be copied to. + /// If this is true and the target path exists, it will be overwritten without any exceptions. void Copy(string sourceFileName, string destFileName, bool overwrite); /// - /// IOLayer - documentation pending + /// Moves a file. /// - /// - /// + /// Path of file to move. + /// Destination path to move the file to. void Move(string sourceFileName, string destFileName); /// - /// IOLayer - documentation pending + /// Replace a file with another file. /// - /// - /// + /// Path to source file. + /// Path to file to replace. /// void Replace(string sourceFileName, string destinationFileName, string destinationBackupFileName); /// - /// IOLayer - documentation pending + /// Replace a file with another file. /// - /// - /// + /// Path to source file. + /// Path to file to replace. /// /// void Replace(string sourceFileName, string destinationFileName, string destinationBackupFileName, bool ignoreMetadataErrors); /// - /// IOLayer - documentation pending + /// Deletes the given file. /// - /// + /// Path to file to delete. void Delete(string path); /// - /// IOLayer - documentation pending + /// Creates a new file and returns a file stream to it . /// - /// - /// + /// Path to file to create. + /// Returns the newly created stream. C1FileStream Create(string path); /// - /// IOLayer - documentation pending + /// Creates a new file and returns a file stream to it . /// - /// - /// - /// + /// Path to file to create. + /// Buffer size of returned stream. + /// Returns the newly created stream. C1FileStream Create(string path, int bufferSize); /// - /// IOLayer - documentation pending + /// Creates a new file and returns a file stream to it . /// - /// - /// - /// - /// + /// Path to file to create. + /// Buffer size of returned stream. + /// File options of returned stream. + /// Returns the newly created stream. C1FileStream Create(string path, int bufferSize, FileOptions options); /// - /// IOLayer - documentation pending + /// Creates a new file and returns a stream writer to it . /// - /// - /// + /// Path to file to create. + /// Returns the newly created . C1StreamWriter CreateText(string path); /// - /// IOLayer - documentation pending + /// Opens a for appending. /// - /// - /// + /// Path to file to append to. + /// Returns the newly opned . C1StreamWriter AppendText(string path); /// - /// IOLayer - documentation pending + /// Appends content to a file. /// - /// - /// + /// Path to file to append to. + /// Content to append to file. void AppendAllText(string path, string contents); /// - /// IOLayer - documentation pending + /// Appends content to a file. /// - /// - /// - /// + /// Path to file to append to. + /// Content to append to file. + /// Encoding to use when appending. void AppendAllText(string path, string contents, Encoding encoding); /// - /// IOLayer - documentation pending + /// Appends content to a file. /// - /// - /// + /// Path to file to append to. + /// Content to append to file. void AppendAllLines(string path, IEnumerable contents); /// - /// IOLayer - documentation pending + /// Appends content to a file. /// - /// - /// - /// + /// Path to file to append to. + /// Content to append to file. + /// Encoding to use when appending. void AppendAllLines(string path, IEnumerable contents, Encoding encoding); /// - /// IOLayer - documentation pending + /// Opens a file. /// - /// - /// - /// + /// Path to file to open. + /// File mode to use. + /// Returns the newly opened . C1FileStream Open(string path, FileMode mode); /// - /// IOLayer - documentation pending + /// Opens a file. /// - /// - /// - /// - /// + /// Path to file to open. + /// File mode to use. + /// File access to use. + /// Returns the newly opened . C1FileStream Open(string path, FileMode mode, FileAccess access); /// - /// IOLayer - documentation pending + /// Opens a file. /// - /// - /// - /// - /// - /// + /// Path to file to open. + /// File mode to use. + /// File access to use. + /// File share to use. + /// Returns the newly opened . C1FileStream Open(string path, FileMode mode, FileAccess access, FileShare share); /// - /// IOLayer - documentation pending + /// Opens a file for reading. /// - /// - /// + /// Path to file to open. + /// Returns the newly opened . C1FileStream OpenRead(string path); /// - /// IOLayer - documentation pending + /// Opens a file. /// - /// - /// + /// Path to file to open. + /// Returns the newly opened . C1StreamReader OpenText(string path); /// - /// IOLayer - documentation pending + /// Opens a file for writing. /// - /// - /// + /// Path to file to open. + /// Returns the newly opened . C1FileStream OpenWrite(string path); /// - /// IOLayer - documentation pending + /// Read all bytes from a file. /// - /// - /// + /// Path to file to read from. + /// Returns read bytes. byte[] ReadAllBytes(string path); /// - /// IOLayer - documentation pending + /// Read all lines from a file. /// - /// - /// + /// Path to file to read from. + /// Returns read lines. string[] ReadAllLines(string path); /// - /// IOLayer - documentation pending + /// Read all lines from a file. /// - /// - /// - /// + /// Path to file to read from. + /// Encoding to use when reading. + /// Returns read lines. string[] ReadAllLines(string path, Encoding encoding); /// - /// IOLayer - documentation pending + /// Read all text from a file. /// - /// - /// + /// Path to file to read from. + /// The content of the file. string ReadAllText(string path); /// - /// IOLayer - documentation pending + /// Read all text from a file. /// - /// - /// - /// + /// Path to file to read from. + /// Encoding to use when reading. + /// The content of the file. string ReadAllText(string path, Encoding encoding); /// - /// IOLayer - documentation pending + /// Read all lines from a file. /// - /// - /// + /// Path to file to read from. + /// Returns all read lines. IEnumerable ReadLines(string path); /// - /// IOLayer - documentation pending + /// Read all lines from a file. /// - /// - /// - /// + /// Path to file to read from. + /// Encoding to use when reading. + /// Returns all read lines. IEnumerable ReadLines(string path, Encoding encoding); /// - /// IOLayer - documentation pending + /// Writes bytes to a file. /// - /// - /// + /// Path to file to write to. + /// Bytes to write. void WriteAllBytes(string path, byte[] bytes); /// - /// IOLayer - documentation pending + /// Writes lines to a file. /// - /// - /// + /// Path to file to write to. + /// Lines to write. void WriteAllLines(string path, IEnumerable contents); /// - /// IOLayer - documentation pending + /// Writes lines to a file. /// - /// - /// - /// + /// Path to file to write to. + /// Lines to write. + /// Encoding to use when writing. void WriteAllLines(string path, IEnumerable contents, Encoding encoding); /// - /// IOLayer - documentation pending + /// Writes lines to a file. /// - /// - /// + /// Path to file to write to. + /// Lines to write. void WriteAllLines(string path, string[] contents); /// - /// IOLayer - documentation pending + /// Writes lines to a file. /// - /// - /// - /// + /// Path to file to write to. + /// Lines to write. + /// Encoding to use when writing. void WriteAllLines(string path, string[] contents, Encoding encoding); /// - /// IOLayer - documentation pending + /// Writes text to a file. /// - /// - /// + /// Path to file to write to. + /// Text to write. void WriteAllText(string path, string contents); /// - /// IOLayer - documentation pending + /// Writes text to a file. /// - /// - /// - /// + /// Path to file to write to. + /// Text to write. + /// Encoding to use when writing. void WriteAllText(string path, string contents, Encoding encoding); /// - /// IOLayer - documentation pending + /// Gets the file attributes. /// - /// - /// + /// Path to file to get attributes from. + /// Returns the file attributes. See System.IO.FileAttributes FileAttributes GetAttributes(string path); /// - /// IOLayer - documentation pending + /// Sets the file attributes. /// - /// - /// + /// Path to file to set attributes on. + /// File attributes to set. void SetAttributes(string path, FileAttributes fileAttributes); /// - /// IOLayer - documentation pending + /// Gets the creation time of the file. /// - /// - /// + /// Path to file. + /// Returns the creation time of the given file. DateTime GetCreationTime(string path); /// - /// IOLayer - documentation pending + /// Gets the creation utc time of the file. /// - /// - /// + /// Path to file. + /// Returns the creation utc time of the given file. DateTime GetCreationTimeUtc(string path); /// - /// IOLayer - documentation pending + /// Sets the creation time of the file. /// - /// - /// + /// Path to file. + /// New creation time. void SetCreationTime(string path, DateTime creationTime); /// - /// IOLayer - documentation pending + /// Sets the creation utc time of the file. /// - /// - /// + /// Path to file. + /// New creation utc time. void SetCreationTimeUtc(string path, DateTime creationTimeUtc); /// - /// IOLayer - documentation pending + /// Gets the last access time. /// - /// - /// + /// Path to file. + /// Returns the last access time of the file. DateTime GetLastAccessTime(string path); /// - /// IOLayer - documentation pending + /// Gets the last access utc time. /// - /// - /// + /// Path to file. + /// Returns the last access utc time of the file. DateTime GetLastAccessTimeUtc(string path); /// - /// IOLayer - documentation pending + /// Sets the last access time of the file. /// - /// - /// + /// Path to file. + /// New last access time. void SetLastAccessTime(string path, DateTime lastAccessTime); /// - /// IOLayer - documentation pending + /// Sets the last access utc time of the file. /// - /// - /// + /// Path to file. + /// New last access utc time. void SetLastAccessTimeUtc(string path, DateTime lastAccessTimeUtc); /// - /// IOLayer - documentation pending + /// Get last write time of the file. /// - /// - /// + /// Path to file. + /// Returns the last write time of the file. DateTime GetLastWriteTime(string path); /// - /// IOLayer - documentation pending + /// Get last write utc time of the file. /// - /// - /// + /// Path to file. + /// Returns the last write utc time of the file. DateTime GetLastWriteTimeUtc(string path); /// - /// IOLayer - documentation pending + /// Sets the last write time of the file. /// - /// - /// + /// Path to file. + /// New last write time. void SetLastWriteTime(string path, DateTime lastWriteTime); /// - /// IOLayer - documentation pending + /// Sets the last write utc time of the file. /// - /// - /// + /// Path to file. + /// New last write utc time. void SetLastWriteTimeUtc(string path, DateTime lastWriteTimeUtc); } } diff --git a/Composite/Core/IO/Plugins/IOProvider/IC1FileInfo.cs b/Composite/Core/IO/Plugins/IOProvider/IC1FileInfo.cs index 22759c1db9..abc264eb25 100644 --- a/Composite/Core/IO/Plugins/IOProvider/IC1FileInfo.cs +++ b/Composite/Core/IO/Plugins/IOProvider/IC1FileInfo.cs @@ -6,229 +6,229 @@ namespace Composite.Core.IO.Plugins.IOProvider { /// - /// IOLayer - documentation pending + /// Implementations of this interface is used by C1 through + /// to provide the behavior of . + /// See for more information. /// public interface IC1FileInfo { /// - /// IOLayer - documentation pending + /// Returns the directory name of the file. /// string DirectoryName { get; } /// - /// IOLayer - documentation pending + /// Returns a of the file. /// C1DirectoryInfo Directory { get; } /// - /// IOLayer - documentation pending + /// Returns the name of the file. /// string Name { get; } /// - /// IOLayer - documentation pending + /// Returns the full path and name of the file. /// string FullName { get; } /// - /// IOLayer - documentation pending + /// Returns true if the file exists. Otherwise false. /// bool Exists { get; } /// - /// IOLayer - documentation pending + /// Returns the extension of the file. /// string Extension { get; } /// - /// IOLayer - documentation pending + /// Returns true if and only if the file is read only. /// bool IsReadOnly { get; set; } /// - /// IOLayer - documentation pending + /// Returns the size of the file in bytes. /// long Length { get; } /// - /// IOLayer - documentation pending + /// Gets or sets the file attributes on the file. /// FileAttributes Attributes { get; set; } /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// + /// Returns a newly created . C1FileStream Create(); /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// + /// Returns a newly created . C1StreamWriter CreateText(); /// - /// IOLayer - documentation pending + /// Creates a file stream for appending. /// - /// + /// Returns a newly created for appending. C1StreamWriter AppendText(); /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// - /// + /// File mode to use. + /// Returns a newly created . C1FileStream Open(FileMode mode); /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// - /// - /// + /// File mode to use. + /// File access to use. + /// Returns a newly created . C1FileStream Open(FileMode mode, FileAccess access); /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// - /// - /// - /// + /// File mode to use. + /// File access to use. + /// File share to use. + /// Returns a newly created . C1FileStream Open(FileMode mode, FileAccess access, FileShare share); /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// + /// Returns a newly created for reading. C1FileStream OpenRead(); /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// + /// Returns a newly created . C1StreamReader OpenText(); /// - /// IOLayer - documentation pending + /// Creates a file stream . /// - /// + /// Returns a newly created for writing. C1FileStream OpenWrite(); /// - /// IOLayer - documentation pending + /// Copies the file to the given path. /// - /// - /// + /// Destination path. + /// A new for the destination file. C1FileInfo CopyTo(string destFileName); /// - /// IOLayer - documentation pending + /// Copies the file to the given path and overwrites any existing file if specified. /// - /// - /// - /// + /// Destination path. + /// If true, any existing file will be overwritten. + /// A new for the destination file. C1FileInfo CopyTo(string destFileName, bool overwrite); /// - /// IOLayer - documentation pending + /// Moves the file to the given path. /// - /// + /// Destination path. void MoveTo(string destFileName); /// - /// IOLayer - documentation pending + /// Replaces the given file with this one. /// - /// - /// - /// + /// Destination path to file to replace. + /// Path to backup file. + /// A new for the destination file. C1FileInfo Replace(string destinationFileName, string destinationBackupFileName); /// - /// IOLayer - documentation pending + /// Replaces the given file with this one. /// - /// - /// + /// Destination path to file to replace. + /// Path to backup file. /// - /// + /// A new for the destination file. C1FileInfo Replace(string destinationFileName, string destinationBackupFileName, bool ignoreMetadataErrors); /// - /// IOLayer - documentation pending + /// Deletes the file. /// void Delete(); /// - /// IOLayer - documentation pending + /// Gets or sets the creation time of the file. /// - void Refresh(); + DateTime CreationTime { get; set; } /// - /// IOLayer - documentation pending + /// Gets or sets the creation utc time of the file. /// - /// - /// - void GetObjectData(SerializationInfo info, StreamingContext context); + DateTime CreationTimeUtc { get; set; } /// - /// IOLayer - documentation pending + /// Gets or sets the last access time of the file. /// - DateTime CreationTime { get; set; } + DateTime LastAccessTime { get; set; } /// - /// IOLayer - documentation pending + /// Gets or sets the last access utc time of the file. /// - DateTime CreationTimeUtc { get; set; } + DateTime LastAccessTimeUtc { get; set; } /// - /// IOLayer - documentation pending + /// Gets or sets the last write time of the file. /// - DateTime LastAccessTime { get; set; } + DateTime LastWriteTime { get; set; } /// - /// IOLayer - documentation pending + /// Gets or sets the last write utc time of the file. /// - DateTime LastAccessTimeUtc { get; set; } + DateTime LastWriteTimeUtc { get; set; } /// - /// IOLayer - documentation pending /// - DateTime LastWriteTime { get; set; } + void Refresh(); /// - /// IOLayer - documentation pending /// - DateTime LastWriteTimeUtc { get; set; } + /// + /// + void GetObjectData(SerializationInfo info, StreamingContext context); } } diff --git a/Composite/Core/IO/Plugins/IOProvider/IC1FileStream.cs b/Composite/Core/IO/Plugins/IOProvider/IC1FileStream.cs index c247a1aa7d..c721803249 100644 --- a/Composite/Core/IO/Plugins/IOProvider/IC1FileStream.cs +++ b/Composite/Core/IO/Plugins/IOProvider/IC1FileStream.cs @@ -5,110 +5,112 @@ namespace Composite.Core.IO.Plugins.IOProvider { /// - /// IOLayer - documentation pending + /// Implementations of this interface is used by C1 through + /// to provide the behavior of . + /// See for more information. /// public interface IC1FileStream : IDisposable { /// - /// IOLayer - documentation pending + /// Name of the file. /// string Name { get; } /// - /// IOLayer - documentation pending + /// Size of the file in bytes. /// long Length { get; } /// - /// IOLayer - documentation pending + /// Sets the length of the file in bytes. /// - /// + /// New length of file stream. void SetLength(long value); /// - /// IOLayer - documentation pending + /// Gets or sets the current read/write position in the file stream. /// long Position { get; set; } /// - /// IOLayer - documentation pending + /// Reads a block of bytes from the file stream. /// - /// - /// - /// - /// + /// Target buffer of read bytes. + /// Offset in the buffer to put read bytes. + /// Number of bytes to read. + /// Number of bytes read. int Read(byte[] array, int offset, int count); /// - /// IOLayer - documentation pending + /// Reads a byte form the file stream. /// - /// + /// The read byte value. int ReadByte(); /// - /// IOLayer - documentation pending + /// Writes a block of bytes to the file stream. /// - /// - /// - /// + /// Bytes to write to the file. + /// Offset in buffer to write from. + /// Number of bytes to write. void Write(byte[] array, int offset, int count); /// - /// IOLayer - documentation pending + /// Writes a byte to the file stream. /// - /// + /// Byte value to write. void WriteByte(byte value); /// - /// IOLayer - documentation pending + /// Seeks to a position in the file stream. /// - /// - /// - /// + /// Offset to seek. + /// Origin to seek from. + /// The new position in the stream. long Seek(long offset, SeekOrigin origin); /// - /// IOLayer - documentation pending + /// Returns true if its possible to read from the stream. /// bool CanRead { get; } /// - /// IOLayer - documentation pending + /// Returns true if its possible to seek in the stream. /// bool CanSeek { get; } /// - /// IOLayer - documentation pending + /// Returns true if its possible to write to the stream. /// bool CanWrite { get; } /// - /// IOLayer - documentation pending + /// Flushes the buffered bytes to the file. /// void Flush(); /// - /// IOLayer - documentation pending + /// Flushes the buffered bytes to the file. /// /// void Flush(bool flushToDisk); /// - /// IOLayer - documentation pending + /// Closes the file stream. /// void Close(); } diff --git a/Composite/Core/IO/Plugins/IOProvider/IC1FileSystemWatcher.cs b/Composite/Core/IO/Plugins/IOProvider/IC1FileSystemWatcher.cs index 008f722475..53474ba2e5 100644 --- a/Composite/Core/IO/Plugins/IOProvider/IC1FileSystemWatcher.cs +++ b/Composite/Core/IO/Plugins/IOProvider/IC1FileSystemWatcher.cs @@ -4,84 +4,85 @@ namespace Composite.Core.IO.Plugins.IOProvider { /// - /// IOLayer - documentation pending + /// Implementations of this interface is used by C1 through + /// to provide the behavior of . + /// See for more information. /// public interface IC1FileSystemWatcher { /// - /// IOLayer - documentation pending + /// Gets or sets if events should be raised or not. /// bool EnableRaisingEvents { get; set; } /// - /// IOLayer - documentation pending + /// Path to watch. /// string Path { get; set; } /// - /// IOLayer - documentation pending + /// Filter to use. /// string Filter { get; set; } /// - /// IOLayer - documentation pending + /// Gets or sets of subdirectories should also be watched. /// bool IncludeSubdirectories { get; set; } /// - /// IOLayer - documentation pending + /// Adds or removes an event handler when new items are created. /// event FileSystemEventHandler Created; /// - /// IOLayer - documentation pending + /// Adds or removes an event handler when new items changed. /// event FileSystemEventHandler Changed; /// - /// IOLayer - documentation pending + /// Adds or removes an event handler when new items are renamed. /// event RenamedEventHandler Renamed; /// - /// IOLayer - documentation pending + /// Adds or removes an event handler when new items are deleted. /// event FileSystemEventHandler Deleted; /// - /// IOLayer - documentation pending + /// Adds or removes an event handler when an error occure. /// event ErrorEventHandler Error; /// - /// IOLayer - documentation pending + /// Gets or sets the notify filter. /// NotifyFilters NotifyFilter { get; set; } /// - /// IOLayer - documentation pending + /// Begins the initialization. /// void BeginInit(); /// - /// IOLayer - documentation pending + /// Ends the initialization. /// void EndInit(); /// - /// IOLayer - documentation pending /// /// /// @@ -89,7 +90,6 @@ public interface IC1FileSystemWatcher /// - /// IOLayer - documentation pending /// /// /// diff --git a/Composite/Core/IO/Plugins/IOProvider/IC1StreamReader.cs b/Composite/Core/IO/Plugins/IOProvider/IC1StreamReader.cs index ec4ebc55cb..19fd92dbfe 100644 --- a/Composite/Core/IO/Plugins/IOProvider/IC1StreamReader.cs +++ b/Composite/Core/IO/Plugins/IOProvider/IC1StreamReader.cs @@ -6,78 +6,80 @@ namespace Composite.Core.IO.Plugins.IOProvider { /// - /// IOLayer - documentation pending + /// Implementations of this interface is used by C1 through + /// to provide the behavior of . + /// See for more information. /// public interface IC1StreamReader : IDisposable { /// - /// IOLayer - documentation pending + /// Reads a byte from the stream. /// - /// + /// Returns the read byte. int Read(); /// - /// IOLayer - documentation pending + /// Reads a block from the file. /// - /// - /// - /// - /// + /// Buffer to read into. + /// Index in buffer to start storing bytes. + /// Number of bytes to read. + /// Returns the number read bytes. int Read(char[] buffer, int index, int count); /// - /// IOLayer - documentation pending + /// Read a line from the file. /// - /// + /// Returns the read line. string ReadLine(); /// - /// IOLayer - documentation pending + /// Read all the content of the file into a strng. /// - /// + /// The content of the file. string ReadToEnd(); /// - /// IOLayer - documentation pending + /// Reads a block from the file. /// - /// - /// - /// - /// + /// Buffer to store read chars. + /// Index in buffer to start storing chars. + /// Number of chars to read. + /// Returns the number of read chars. int ReadBlock(char[] buffer, int index, int count); /// - /// IOLayer - documentation pending + /// Peeks the current byte. /// - /// + /// The current byte. int Peek(); /// - /// IOLayer - documentation pending + /// Returns true if the stream is at the end of stream. /// bool EndOfStream { get; } /// - /// IOLayer - documentation pending + /// Closes the stream. /// void Close(); /// - /// IOLayer - documentation pending + /// Returns the base stream. /// Stream BaseStream { get; } /// - /// IOLayer - documentation pending + /// Returns the current encoding of the stream. /// Encoding CurrentEncoding { get; } } diff --git a/Composite/Core/IO/Plugins/IOProvider/IC1StreamWriter.cs b/Composite/Core/IO/Plugins/IOProvider/IC1StreamWriter.cs index 6ce6032d53..ff62b9162a 100644 --- a/Composite/Core/IO/Plugins/IOProvider/IC1StreamWriter.cs +++ b/Composite/Core/IO/Plugins/IOProvider/IC1StreamWriter.cs @@ -6,310 +6,312 @@ namespace Composite.Core.IO.Plugins.IOProvider { /// - /// IOLayer - documentation pending + /// Implementations of this interface is used by C1 through + /// to provide the behavior of . + /// See for more information. /// public interface IC1StreamWriter : IDisposable { /// - /// IOLayer - documentation pending + /// Writes a string to the stream. /// - /// + /// String to write. void Write(string value); /// - /// IOLayer - documentation pending + /// Writes a formatted string to the stream. /// - /// - /// + /// String with formatting to write. + /// String format arguments. void Write(string format, params object[] arg); /// - /// IOLayer - documentation pending + /// Writes a formatted string to the stream. /// - /// - /// + /// String with formatting to write. + /// String format argument. void Write(string format, object arg0); /// - /// IOLayer - documentation pending + /// Writes a formatted string to the stream. /// - /// - /// - /// + /// String with formatting to write. + /// String format argument. + /// String format argument. void Write(string format, object arg0, object arg1); /// - /// IOLayer - documentation pending + /// Writes a formatted string to the stream. /// - /// - /// - /// - /// + /// String with formatting to write. + /// String format argument. + /// String format argument. + /// String format argument. void Write(string format, object arg0, object arg1, object arg2); /// - /// IOLayer - documentation pending + /// Writes a char to the stream. /// - /// + /// The char value to write. void Write(char value); /// - /// IOLayer - documentation pending + /// Writes a char array to the stream. /// - /// + /// Char array to write. void Write(char[] buffer); /// - /// IOLayer - documentation pending + /// Writes a char array to the stream. /// - /// - /// - /// + /// Char array to write. + /// Start index in the buffer to start writing from. + /// Number of chars to write. void Write(char[] buffer, int index, int count); /// - /// IOLayer - documentation pending + /// Writes a boolean to the stream. /// - /// + /// Boolean value to write. void Write(bool value); /// - /// IOLayer - documentation pending + /// Writes an integer to the stream. /// - /// + /// Integer value to write. void Write(int value); /// - /// IOLayer - documentation pending + /// Writes an unsigned integer to the stream. /// - /// + /// Unsigned integer value to write void Write(uint value); /// - /// IOLayer - documentation pending + /// Writes a long to the stream. /// - /// + /// Long value to write. void Write(long value); /// - /// IOLayer - documentation pending + /// Writes a unsigned long to the stream. /// - /// + /// Unsigned long value to write. void Write(ulong value); /// - /// IOLayer - documentation pending + /// Writes a float to the stream. /// - /// + /// Float value to write. void Write(float value); /// - /// IOLayer - documentation pending + /// Writes a double to the stream. /// - /// + /// Double value to write. void Write(double value); /// - /// IOLayer - documentation pending + /// Writes a decimal to the stream. /// - /// + /// Decimal value to write. void Write(decimal value); /// - /// IOLayer - documentation pending + /// Write an object to the stream. /// - /// + /// Object value to write. void Write(object value); /// - /// IOLayer - documentation pending + /// Writes a line break to the stream. /// void WriteLine(); /// - /// IOLayer - documentation pending + /// Writes a string with a line break to the stream. /// - /// + /// String value to write. void WriteLine(string value); /// - /// IOLayer - documentation pending + /// Writes a string with a line break to the stream. /// - /// - /// + /// String with formatting to write. + /// String format argument. void WriteLine(string format, object arg0); /// - /// IOLayer - documentation pending + /// Writes a string with a line break to the stream. /// - /// - /// - /// + /// String with formatting to write. + /// String format argument. + /// String format argument. void WriteLine(string format, object arg0, object arg1); /// - /// IOLayer - documentation pending + /// Writes a string with a line break to the stream. /// - /// - /// - /// - /// + /// String with formatting to write. + /// String format argument. + /// String format argument. + /// String format argument. void WriteLine(string format, object arg0, object arg1, object arg2); /// - /// IOLayer - documentation pending + /// Writes a string with a line break to the stream. /// - /// - /// + /// String with formatting to write. + /// String format arguments. void WriteLine(string format, params object[] arg); /// - /// IOLayer - documentation pending + /// Writes a char with a line break to the stream. /// - /// + /// Char value to write. void WriteLine(char value); /// - /// IOLayer - documentation pending + /// Writes a char array with a line break to the stream. /// - /// + /// Char array to write. void WriteLine(char[] buffer); /// - /// IOLayer - documentation pending + /// Writes a char array with a line break to the stream. /// - /// - /// - /// + /// Char array to write. + /// Index in the char array to start writing from. + /// Number of chars to write. void WriteLine(char[] buffer, int index, int count); /// - /// IOLayer - documentation pending + /// Writes a bool with a line break to the stream. /// - /// + /// Bool value to write. void WriteLine(bool value); /// - /// IOLayer - documentation pending + /// Writes a integer with a line break to the stream. /// - /// + /// Integer value to write. void WriteLine(int value); /// - /// IOLayer - documentation pending + /// Writes a unsigned integer with a line break to the stream. /// - /// + /// Unsigned integer to write. void WriteLine(uint value); /// - /// IOLayer - documentation pending + /// Writes a long with a line break to the stream. /// - /// + /// Long value to write. void WriteLine(long value); /// - /// IOLayer - documentation pending + /// Writes a unsigned long with a line break to the stream. /// - /// + /// Unsigned long value to write. void WriteLine(ulong value); /// - /// IOLayer - documentation pending + /// Writes a float with a line break to the stream. /// - /// + /// Float value to write. void WriteLine(float value); /// - /// IOLayer - documentation pending + /// Writes a double with a line break to the stream. /// - /// + /// Double value to write. void WriteLine(double value); /// - /// IOLayer - documentation pending + /// Writes a decimal with a line break to the stream. /// - /// + /// Decimal value to write. void WriteLine(decimal value); /// - /// IOLayer - documentation pending + /// Writes an object with a line break to the stream. /// - /// + /// Object value to write. void WriteLine(object value); /// - /// IOLayer - documentation pending + /// Gets or sets the line break value. /// string NewLine { get; set; } /// - /// IOLayer - documentation pending + /// Gets the format provider used. /// IFormatProvider FormatProvider { get; } /// - /// IOLayer - documentation pending + /// Gets or sets whether the stream is auto flushed or not /// bool AutoFlush { get; set; } /// - /// IOLayer - documentation pending + /// Flushes the stream. /// void Flush(); /// - /// IOLayer - documentation pending + /// Closes the stream. /// void Close(); /// - /// IOLayer - documentation pending + /// The base streawm. /// Stream BaseStream { get; } /// - /// IOLayer - documentation pending + /// Gets the encoding used. /// Encoding Encoding { get; } } diff --git a/Composite/Core/IO/Plugins/IOProvider/IIOProvider.cs b/Composite/Core/IO/Plugins/IOProvider/IIOProvider.cs index 58879795b9..bac1d33fc0 100644 --- a/Composite/Core/IO/Plugins/IOProvider/IIOProvider.cs +++ b/Composite/Core/IO/Plugins/IOProvider/IIOProvider.cs @@ -7,45 +7,131 @@ namespace Composite.Core.IO.Plugins.IOProvider { - /// + /// + /// Implement this interface to overwrite the default behavior of IO in C1. + /// This provides implementations of the following classes: + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// + /// Here is an minimal implementaion example: + /// + /// [ConfigurationElementType(typeof(NonConfigurableIOProvider))] + /// internal class LocalIOProvider : IIOProvider + /// { + /// /* Implementation goes here */ + /// } + /// + /// /// - /// - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [CustomFactory(typeof(IOProviderCustomFactory))] [ConfigurationNameMapper(typeof(IOProviderDefaultNameRetriever))] public interface IIOProvider { - /// + /// + /// Returns a custom implementation of . + /// IC1Directory C1Directory { get; } - /// + + /// + /// Returns a custom implementation of . + /// IC1File C1File { get; } - /// + + /// + /// Returns a custom implementation of . + /// + /// Path to file to use. + /// Returns a custom implementation of . IC1FileInfo CreateFileInfo(string fileName); - /// + + /// + /// Returns a custom implementation of . + /// + /// Path to directory to use. + /// Returns a custom implementation of . IC1DirectoryInfo CreateDirectoryInfo(string path); - /// + + /// + /// Returns a custom implementation of . + /// + /// Path to file. + /// File mode to use. + /// File access to use. + /// File share to use. + /// Buffer size to use. + /// File options to use. + /// Returns a custom implementation of . IC1FileStream CreateFileStream(string path, FileMode mode, FileAccess access, FileShare share, int bufferSize, FileOptions options); - /// + + /// + /// Returns a custom implementation of . + /// + /// Path to file or directory to watch. + /// Filter to use. + /// Returns a custom implementation of . IC1FileSystemWatcher CreateFileSystemWatcher(string path, string filter); - /// + + /// + /// Returns a custom implementation of . + /// + /// Path to file to read from. + /// Encoding to use when reading. + /// If true, encoding will be detected from the file stream. + /// Buffer size to use when reading. + /// Returns a custom implementation of . IC1StreamReader CreateStreamReader(string path, Encoding encoding, bool detectEncodingFromByteOrderMarks, int bufferSize); - /// + + /// + /// Returns a custom implementation of . + /// + /// Stream to read from. + /// Encoding to use when reading. + /// If true, encoding will be detected from the file stream. + /// Buffer size to use when reading. + /// Returns a custom implementation of . IC1StreamReader CreateStreamReader(Stream stream, Encoding encoding, bool detectEncodingFromByteOrderMarks, int bufferSize); - /// + + /// + /// Returns a custom implementation of . + /// + /// Path of file to write to. + /// If true, writte data will be appended to the end of the file. + /// Encoding to use when writing. + /// Buffer size to use when writing. + /// Returns a custom implementation of . IC1StreamWriter CreateStreamWriter(string path, bool append, Encoding encoding, int bufferSize); - /// + + /// + /// Returns a custom implementation of . + /// + /// Stream to write to. + /// Encoding to use when writing. + /// Buffer size to use when writing. + /// Returns a custom implementation of . IC1StreamWriter CreateStreamWriter(Stream stream, Encoding encoding, int bufferSize); - /// + + /// + /// Returns a custom implementation of . + /// + /// Path of configuration file. + /// Returns a custom implementation of . IC1Configuration CreateConfiguration(string path); } } diff --git a/Composite/Core/IO/Plugins/IOProvider/IOProviderData.cs b/Composite/Core/IO/Plugins/IOProvider/IOProviderData.cs index 93ce984cc2..15b72f3dd3 100644 --- a/Composite/Core/IO/Plugins/IOProvider/IOProviderData.cs +++ b/Composite/Core/IO/Plugins/IOProvider/IOProviderData.cs @@ -5,7 +5,7 @@ namespace Composite.Core.IO.Plugins.IOProvider { /// - /// IOLayer - documentation pending + /// Use this to make custom configuration of an implementation. /// [ConfigurationElementType(typeof(NonConfigurableIOProvider))] public class IOProviderData: NameTypeManagerTypeConfigurationElement diff --git a/Composite/Core/IO/Plugins/IOProvider/NonConfigurableIOProvider.cs b/Composite/Core/IO/Plugins/IOProvider/NonConfigurableIOProvider.cs index 13ec38b470..5d32bb504d 100644 --- a/Composite/Core/IO/Plugins/IOProvider/NonConfigurableIOProvider.cs +++ b/Composite/Core/IO/Plugins/IOProvider/NonConfigurableIOProvider.cs @@ -7,9 +7,8 @@ namespace Composite.Core.IO.Plugins.IOProvider { /// + /// This is a default non configurable version of /// - /// - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] [Assembler(typeof(NonConfigurableIOProviderAssembler))] public class NonConfigurableIOProvider : IOProviderData { @@ -18,9 +17,8 @@ public class NonConfigurableIOProvider : IOProviderData /// + /// This is a default non configurable assembler version of /// - /// - [System.ComponentModel.EditorBrowsable(System.ComponentModel.EditorBrowsableState.Never)] public sealed class NonConfigurableIOProviderAssembler : IAssembler { /// diff --git a/Composite/Core/Implementation/C1ConfigurationImplementation.cs b/Composite/Core/Implementation/C1ConfigurationImplementation.cs index 92073abadd..fc0a53a150 100644 --- a/Composite/Core/Implementation/C1ConfigurationImplementation.cs +++ b/Composite/Core/Implementation/C1ConfigurationImplementation.cs @@ -1,22 +1,23 @@ using System; using System.Collections.Generic; +using System.Configuration; using System.Linq; using System.Text; -using System.Configuration; -using Composite.Core.IO.Plugins.IOProvider; using Composite.Core.IO; +using Composite.Core.IO.Plugins.IOProvider; + namespace Composite.Core.Implementation { /// - /// IOLayer - documentation pending + /// Implementation of . /// public class C1ConfigurationImplementation { private IC1Configuration _configuration; /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -29,7 +30,7 @@ public C1ConfigurationImplementation(string path) /// - /// IOLayer - documentation pending + /// See . /// public virtual string FilePath { @@ -42,7 +43,7 @@ public virtual string FilePath /// - /// IOLayer - documentation pending + /// See . /// public virtual bool HasFile { @@ -55,7 +56,7 @@ public virtual bool HasFile /// - /// IOLayer - documentation pending + /// See . /// public virtual AppSettingsSection AppSettings { @@ -68,7 +69,7 @@ public virtual AppSettingsSection AppSettings /// - /// IOLayer - documentation pending + /// See . /// public virtual ConnectionStringsSection ConnectionStrings { @@ -81,7 +82,7 @@ public virtual ConnectionStringsSection ConnectionStrings /// - /// IOLayer - documentation pending + /// See . /// public virtual ConfigurationSectionCollection Sections { @@ -94,7 +95,7 @@ public virtual ConfigurationSectionCollection Sections /// - /// IOLayer - documentation pending + /// See . /// public virtual ConfigurationSectionGroup RootSectionGroup { @@ -107,7 +108,7 @@ public virtual ConfigurationSectionGroup RootSectionGroup /// - /// IOLayer - documentation pending + /// See . /// public virtual ConfigurationSectionGroupCollection SectionGroups { @@ -120,7 +121,7 @@ public virtual ConfigurationSectionGroupCollection SectionGroups /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -132,7 +133,7 @@ public virtual ConfigurationSection GetSection(string sectionName) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -144,7 +145,7 @@ public virtual ConfigurationSectionGroup GetSectionGroup(string sectionGroupName /// - /// IOLayer - documentation pending + /// See . /// public virtual void Save() { @@ -154,7 +155,7 @@ public virtual void Save() /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Save(ConfigurationSaveMode saveMode) @@ -165,7 +166,7 @@ public virtual void Save(ConfigurationSaveMode saveMode) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -177,7 +178,7 @@ public virtual void Save(ConfigurationSaveMode saveMode, bool forceSaveAll) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void SaveAs(string fileName) @@ -188,7 +189,7 @@ public virtual void SaveAs(string fileName) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -200,7 +201,7 @@ public virtual void SaveAs(string fileName, ConfigurationSaveMode saveMode) /// - /// IOLayer - documentation pending + /// See . /// /// /// diff --git a/Composite/Core/Implementation/C1DirectoryImplementation.cs b/Composite/Core/Implementation/C1DirectoryImplementation.cs index 0fdc557121..78373762bb 100644 --- a/Composite/Core/Implementation/C1DirectoryImplementation.cs +++ b/Composite/Core/Implementation/C1DirectoryImplementation.cs @@ -6,12 +6,12 @@ namespace Composite.Core.Implementation { /// - /// IOLayer - documentation pending + /// Implementation of . /// public class C1DirectoryImplementation { /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -23,7 +23,7 @@ public virtual C1DirectoryInfo CreateDirectory(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -35,7 +35,7 @@ public virtual void Move(string sourceDirName, string destinationDirName) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Delete(string path) @@ -46,7 +46,7 @@ public virtual void Delete(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -58,7 +58,7 @@ public virtual void Delete(string path, bool recursive) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -70,7 +70,7 @@ public virtual bool Exists(string path) /// - /// IOLayer - documentation pending + /// See . /// /// [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Design", "CA1024:UsePropertiesWhereAppropriate")] @@ -82,7 +82,7 @@ public virtual string GetCurrentDirectory() /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void SetCurrentDirectory(string path) @@ -93,7 +93,7 @@ public virtual void SetCurrentDirectory(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -105,7 +105,7 @@ public virtual C1DirectoryInfo GetParent(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -117,7 +117,7 @@ public virtual string GetDirectoryRoot(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -129,7 +129,7 @@ public virtual string[] GetDirectories(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -142,7 +142,7 @@ public virtual string[] GetDirectories(string path, string searchPattern) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -156,7 +156,7 @@ public virtual string[] GetDirectories(string path, string searchPattern, Search /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -168,7 +168,7 @@ public virtual string[] GetFiles(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -181,7 +181,7 @@ public virtual string[] GetFiles(string path, string searchPattern) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -195,7 +195,7 @@ public virtual string[] GetFiles(string path, string searchPattern, SearchOption /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -207,7 +207,7 @@ public virtual DateTime GetCreationTime(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// diff --git a/Composite/Core/Implementation/C1DirectoryInfoImplementation.cs b/Composite/Core/Implementation/C1DirectoryInfoImplementation.cs index 0dab4eb923..82e2f56071 100644 --- a/Composite/Core/Implementation/C1DirectoryInfoImplementation.cs +++ b/Composite/Core/Implementation/C1DirectoryInfoImplementation.cs @@ -8,7 +8,7 @@ namespace Composite.Core.Implementation { /// - /// IOLayer - documentation pending + /// Implementation of . /// public class C1DirectoryInfoImplementation { @@ -16,7 +16,7 @@ public class C1DirectoryInfoImplementation /// - /// IOLayer - documentation pending + /// See . /// /// public C1DirectoryInfoImplementation(string path) @@ -27,7 +27,7 @@ public C1DirectoryInfoImplementation(string path) /// - /// IOLayer - documentation pending + /// See . /// public string Name { @@ -40,7 +40,7 @@ public string Name /// - /// IOLayer - documentation pending + /// See . /// public string FullName { @@ -53,7 +53,7 @@ public string FullName /// - /// IOLayer - documentation pending + /// See . /// public string Extension { @@ -66,7 +66,7 @@ public string Extension /// - /// IOLayer - documentation pending + /// See . /// public bool Exists { @@ -79,7 +79,7 @@ public bool Exists /// - /// IOLayer - documentation pending + /// See . /// public C1DirectoryInfo Root { @@ -92,7 +92,7 @@ public C1DirectoryInfo Root /// - /// IOLayer - documentation pending + /// See . /// public C1DirectoryInfo Parent { @@ -105,7 +105,7 @@ public C1DirectoryInfo Parent /// - /// IOLayer - documentation pending + /// See . /// public FileAttributes Attributes { @@ -122,7 +122,7 @@ public FileAttributes Attributes /// - /// IOLayer - documentation pending + /// See . /// /// public C1DirectoryInfo[] GetDirectories() @@ -133,7 +133,7 @@ public C1DirectoryInfo[] GetDirectories() /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -145,7 +145,7 @@ public C1DirectoryInfo[] GetDirectories(string searchPattern) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -158,7 +158,7 @@ public C1DirectoryInfo[] GetDirectories(string searchPattern, SearchOption searc /// - /// IOLayer - documentation pending + /// See . /// /// public C1FileInfo[] GetFiles() @@ -169,7 +169,7 @@ public C1FileInfo[] GetFiles() /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -180,7 +180,7 @@ public C1FileInfo[] GetFiles(string searchPattern) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -193,7 +193,7 @@ public C1FileInfo[] GetFiles(string searchPattern, SearchOption searchOption) /// - /// IOLayer - documentation pending + /// See . /// public void Create() { @@ -203,7 +203,7 @@ public void Create() /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -215,7 +215,7 @@ public C1DirectoryInfo CreateSubdirectory(string path) /// - /// IOLayer - documentation pending + /// See . /// /// public void MoveTo(string destinationDirName) @@ -226,7 +226,7 @@ public void MoveTo(string destinationDirName) /// - /// IOLayer - documentation pending + /// See . /// public void Delete() { @@ -235,7 +235,7 @@ public void Delete() /// - /// IOLayer - documentation pending + /// See . /// /// public void Delete(bool recursive) @@ -246,7 +246,7 @@ public void Delete(bool recursive) /// - /// IOLayer - documentation pending + /// See . /// public DateTime CreationTime { @@ -263,7 +263,7 @@ public DateTime CreationTime /// - /// IOLayer - documentation pending + /// See . /// public DateTime CreationTimeUtc { @@ -280,7 +280,7 @@ public DateTime CreationTimeUtc /// - /// IOLayer - documentation pending + /// See . /// public DateTime LastAccessTime { @@ -297,7 +297,7 @@ public DateTime LastAccessTime /// - /// IOLayer - documentation pending + /// See . /// public DateTime LastAccessTimeUtc { @@ -314,7 +314,7 @@ public DateTime LastAccessTimeUtc /// - /// IOLayer - documentation pending + /// See . /// public DateTime LastWriteTime { @@ -331,7 +331,7 @@ public DateTime LastWriteTime /// - /// IOLayer - documentation pending + /// See . /// public DateTime LastWriteTimeUtc { @@ -348,7 +348,7 @@ public DateTime LastWriteTimeUtc /// - /// IOLayer - documentation pending + /// See . /// public void GetObjectData(SerializationInfo info, StreamingContext context) { @@ -358,7 +358,7 @@ public void GetObjectData(SerializationInfo info, StreamingContext context) /// - /// IOLayer - documentation pending + /// See . /// public void Refresh() { diff --git a/Composite/Core/Implementation/C1FileImplementation.cs b/Composite/Core/Implementation/C1FileImplementation.cs index 49a4da3f48..4f366bce97 100644 --- a/Composite/Core/Implementation/C1FileImplementation.cs +++ b/Composite/Core/Implementation/C1FileImplementation.cs @@ -8,12 +8,12 @@ namespace Composite.Core.Implementation { /// - /// IOLayer - documentation pending + /// Implementation of . /// public class C1FileImplementation { /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -25,7 +25,7 @@ public virtual bool Exists(string path) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Touch(string path) @@ -36,7 +36,7 @@ public virtual void Touch(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -48,7 +48,7 @@ public virtual void Copy(string sourceFileName, string destinationFileName) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -61,7 +61,7 @@ public virtual void Copy(string sourceFileName, string destinationFileName, bool /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -73,7 +73,7 @@ public virtual void Move(string sourceFileName, string destinationFileName) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -86,7 +86,7 @@ public virtual void Replace(string sourceFileName, string destinationFileName, s /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -100,7 +100,7 @@ public virtual void Replace(string sourceFileName, string destinationFileName, s /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Delete(string path) @@ -111,7 +111,7 @@ public virtual void Delete(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -123,7 +123,7 @@ public virtual C1FileStream Create(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -136,7 +136,7 @@ public virtual C1FileStream Create(string path, int bufferSize) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -150,7 +150,7 @@ public virtual C1FileStream Create(string path, int bufferSize, FileOptions opti /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -162,7 +162,7 @@ public virtual C1StreamWriter CreateText(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -174,7 +174,7 @@ public virtual C1StreamWriter AppendText(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -186,7 +186,7 @@ public virtual void AppendAllText(string path, string contents) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -199,7 +199,7 @@ public virtual void AppendAllText(string path, string contents, Encoding encodin /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -211,7 +211,7 @@ public virtual void AppendAllLines(string path, IEnumerable contents) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -224,7 +224,7 @@ public virtual void AppendAllLines(string path, IEnumerable contents, En /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -237,7 +237,7 @@ public virtual C1FileStream Open(string path, FileMode mode) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -251,7 +251,7 @@ public virtual C1FileStream Open(string path, FileMode mode, FileAccess access) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -266,7 +266,7 @@ public virtual C1FileStream Open(string path, FileMode mode, FileAccess access, /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -278,7 +278,7 @@ public virtual C1FileStream OpenRead(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -290,7 +290,7 @@ public virtual C1StreamReader OpenText(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -302,7 +302,7 @@ public virtual C1FileStream OpenWrite(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -314,7 +314,7 @@ public virtual byte[] ReadAllBytes(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -326,7 +326,7 @@ public virtual string[] ReadAllLines(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -339,7 +339,7 @@ public virtual string[] ReadAllLines(string path, Encoding encoding) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -351,7 +351,7 @@ public virtual string ReadAllText(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -364,7 +364,7 @@ public virtual string ReadAllText(string path, Encoding encoding) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -376,7 +376,7 @@ public virtual IEnumerable ReadLines(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -389,7 +389,7 @@ public virtual IEnumerable ReadLines(string path, Encoding encoding) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -402,7 +402,7 @@ public virtual void WriteAllBytes(string path, byte[] bytes) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -414,7 +414,7 @@ public virtual void WriteAllLines(string path, IEnumerable contents) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -426,7 +426,7 @@ public virtual void WriteAllLines(string path, string[] contents) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -439,7 +439,7 @@ public virtual void WriteAllLines(string path, IEnumerable contents, Enc /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -452,7 +452,7 @@ public virtual void WriteAllLines(string path, string[] contents, Encoding encod /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -464,7 +464,7 @@ public virtual void WriteAllText(string path, string contents) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -477,7 +477,7 @@ public virtual void WriteAllText(string path, string contents, Encoding encoding /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -489,7 +489,7 @@ public virtual FileAttributes GetAttributes(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -501,7 +501,7 @@ public virtual void SetAttributes(string path, FileAttributes fileAttributes) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -513,7 +513,7 @@ public virtual DateTime GetCreationTime(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -525,7 +525,7 @@ public virtual DateTime GetCreationTimeUtc(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -537,7 +537,7 @@ public virtual void SetCreationTime(string path, DateTime creationTime) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -549,7 +549,7 @@ public virtual void SetCreationTimeUtc(string path, DateTime creationTimeUtc) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -561,7 +561,7 @@ public virtual DateTime GetLastAccessTime(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -573,7 +573,7 @@ public virtual DateTime GetLastAccessTimeUtc(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -585,7 +585,7 @@ public virtual void SetLastAccessTime(string path, DateTime lastAccessTime) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -597,7 +597,7 @@ public virtual void SetLastAccessTimeUtc(string path, DateTime lastAccessTimeUtc /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -609,7 +609,7 @@ public virtual DateTime GetLastWriteTime(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -621,7 +621,7 @@ public virtual DateTime GetLastWriteTimeUtc(string path) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -633,7 +633,7 @@ public virtual void SetLastWriteTime(string path, DateTime lastWriteTime) /// - /// IOLayer - documentation pending + /// See . /// /// /// diff --git a/Composite/Core/Implementation/C1FileInfoImplementation.cs b/Composite/Core/Implementation/C1FileInfoImplementation.cs index 0fdc62ddb5..985cb92b27 100644 --- a/Composite/Core/Implementation/C1FileInfoImplementation.cs +++ b/Composite/Core/Implementation/C1FileInfoImplementation.cs @@ -8,14 +8,14 @@ namespace Composite.Core.Implementation { /// - /// IOLayer - documentation pending + /// Implementation of . /// public class C1FileInfoImplementation { private IC1FileInfo _fileInfo; /// - /// IOLayer - documentation pending + /// See . /// /// public C1FileInfoImplementation(string path) @@ -26,7 +26,7 @@ public C1FileInfoImplementation(string path) /// - /// IOLayer - documentation pending + /// See . /// public string DirectoryName { @@ -39,7 +39,7 @@ public string DirectoryName /// - /// IOLayer - documentation pending + /// See . /// public C1DirectoryInfo Directory { @@ -52,7 +52,7 @@ public C1DirectoryInfo Directory /// - /// IOLayer - documentation pending + /// See . /// public string Name { @@ -65,7 +65,7 @@ public string Name /// - /// IOLayer - documentation pending + /// See . /// public string FullName { @@ -78,7 +78,7 @@ public string FullName /// - /// IOLayer - documentation pending + /// See . /// public bool Exists { @@ -91,7 +91,7 @@ public bool Exists /// - /// IOLayer - documentation pending + /// See . /// public string Extension { @@ -104,7 +104,7 @@ public string Extension /// - /// IOLayer - documentation pending + /// See . /// public bool IsReadOnly { @@ -121,7 +121,7 @@ public bool IsReadOnly /// - /// IOLayer - documentation pending + /// See . /// public long Length { @@ -134,7 +134,7 @@ public long Length /// - /// IOLayer - documentation pending + /// See . /// public FileAttributes Attributes { @@ -151,7 +151,7 @@ public FileAttributes Attributes /// - /// IOLayer - documentation pending + /// See . /// /// public C1FileStream Create() @@ -162,7 +162,7 @@ public C1FileStream Create() /// - /// IOLayer - documentation pending + /// See . /// /// public C1StreamWriter CreateText() @@ -173,7 +173,7 @@ public C1StreamWriter CreateText() /// - /// IOLayer - documentation pending + /// See . /// /// public C1StreamWriter AppendText() @@ -184,7 +184,7 @@ public C1StreamWriter AppendText() /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -196,7 +196,7 @@ public C1FileStream Open(FileMode mode) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -209,7 +209,7 @@ public C1FileStream Open(FileMode mode, FileAccess access) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -223,7 +223,7 @@ public C1FileStream Open(FileMode mode, FileAccess access, FileShare share) /// - /// IOLayer - documentation pending + /// See . /// /// public C1FileStream OpenRead() @@ -234,7 +234,7 @@ public C1FileStream OpenRead() /// - /// IOLayer - documentation pending + /// See . /// /// public C1StreamReader OpenText() @@ -245,7 +245,7 @@ public C1StreamReader OpenText() /// - /// IOLayer - documentation pending + /// See . /// /// public C1FileStream OpenWrite() @@ -256,7 +256,7 @@ public C1FileStream OpenWrite() /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -268,7 +268,7 @@ public C1FileInfo CopyTo(string destinationFileName) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -281,7 +281,7 @@ public C1FileInfo CopyTo(string destinationFileName, bool overwrite) /// - /// IOLayer - documentation pending + /// See . /// /// public void MoveTo(string destinationFileName) @@ -292,7 +292,7 @@ public void MoveTo(string destinationFileName) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -305,7 +305,7 @@ public C1FileInfo Replace(string destinationFileName, string destinationBackupFi /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -319,7 +319,7 @@ public C1FileInfo Replace(string destinationFileName, string destinationBackupFi /// - /// IOLayer - documentation pending + /// See . /// public void Delete() { @@ -329,7 +329,7 @@ public void Delete() /// - /// IOLayer - documentation pending + /// See . /// public void Refresh() { @@ -339,7 +339,7 @@ public void Refresh() /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -351,7 +351,7 @@ public void GetObjectData(SerializationInfo info, StreamingContext context) /// - /// IOLayer - documentation pending + /// See . /// public DateTime CreationTime { @@ -368,7 +368,7 @@ public DateTime CreationTime /// - /// IOLayer - documentation pending + /// See . /// public DateTime CreationTimeUtc { @@ -385,7 +385,7 @@ public DateTime CreationTimeUtc /// - /// IOLayer - documentation pending + /// See . /// public DateTime LastAccessTime { @@ -402,7 +402,7 @@ public DateTime LastAccessTime /// - /// IOLayer - documentation pending + /// See . /// public DateTime LastAccessTimeUtc { @@ -419,7 +419,7 @@ public DateTime LastAccessTimeUtc /// - /// IOLayer - documentation pending + /// See . /// public DateTime LastWriteTime { @@ -436,7 +436,7 @@ public DateTime LastWriteTime /// - /// IOLayer - documentation pending + /// See . /// public DateTime LastWriteTimeUtc { diff --git a/Composite/Core/Implementation/C1FileStreamImplementation.cs b/Composite/Core/Implementation/C1FileStreamImplementation.cs index 368ba484fc..5e383f0b65 100644 --- a/Composite/Core/Implementation/C1FileStreamImplementation.cs +++ b/Composite/Core/Implementation/C1FileStreamImplementation.cs @@ -8,7 +8,7 @@ namespace Composite.Core.Implementation { /// - /// IOLayer - documentation pending + /// Implementation of . /// public class C1FileStreamImplementation : IDisposable { @@ -16,7 +16,7 @@ public class C1FileStreamImplementation : IDisposable /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -32,7 +32,7 @@ public C1FileStreamImplementation(string path, FileMode mode, FileAccess access, /// - /// IOLayer - documentation pending + /// See . /// public virtual string Name { @@ -45,7 +45,7 @@ public virtual string Name /// - /// IOLayer - documentation pending + /// See . /// public virtual long Length { @@ -58,7 +58,7 @@ public virtual long Length /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void SetLength(long value) @@ -69,7 +69,7 @@ public virtual void SetLength(long value) /// - /// IOLayer - documentation pending + /// See . /// public virtual long Position { @@ -86,7 +86,7 @@ public virtual long Position /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -100,7 +100,7 @@ public virtual int Read(byte[] array, int offset, int count) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual int ReadByte() @@ -111,7 +111,7 @@ public virtual int ReadByte() /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -124,7 +124,7 @@ public virtual void Write(byte[] array, int offset, int count) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void WriteByte(byte value) @@ -135,7 +135,7 @@ public virtual void WriteByte(byte value) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -148,7 +148,7 @@ public virtual long Seek(long offset, SeekOrigin origin) /// - /// IOLayer - documentation pending + /// See . /// public virtual bool CanRead { @@ -161,7 +161,7 @@ public virtual bool CanRead /// - /// IOLayer - documentation pending + /// See . /// public virtual bool CanSeek { @@ -174,7 +174,7 @@ public virtual bool CanSeek /// - /// IOLayer - documentation pending + /// See . /// public virtual bool CanWrite { @@ -187,7 +187,7 @@ public virtual bool CanWrite /// - /// IOLayer - documentation pending + /// See . /// public virtual void Flush() { @@ -197,7 +197,7 @@ public virtual void Flush() /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Flush(bool flushToDisk) @@ -208,7 +208,7 @@ public virtual void Flush(bool flushToDisk) /// - /// IOLayer - documentation pending + /// See . /// public virtual void Close() { diff --git a/Composite/Core/Implementation/C1FileSystemWatcherImplementation.cs b/Composite/Core/Implementation/C1FileSystemWatcherImplementation.cs index 659bf85d37..d655c501ae 100644 --- a/Composite/Core/Implementation/C1FileSystemWatcherImplementation.cs +++ b/Composite/Core/Implementation/C1FileSystemWatcherImplementation.cs @@ -6,7 +6,7 @@ namespace Composite.Core.Implementation { /// - /// IOLayer - documentation pending + /// Implementation of . /// public class C1FileSystemWatcherImplementation { @@ -14,7 +14,7 @@ public class C1FileSystemWatcherImplementation /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -26,7 +26,7 @@ public C1FileSystemWatcherImplementation(string path, string filter) /// - /// IOLayer - documentation pending + /// See . /// public virtual bool EnableRaisingEvents { @@ -43,7 +43,7 @@ public virtual bool EnableRaisingEvents /// - /// IOLayer - documentation pending + /// See . /// public virtual string Path { @@ -60,7 +60,7 @@ public virtual string Path /// - /// IOLayer - documentation pending + /// See . /// public virtual string Filter { @@ -77,7 +77,7 @@ public virtual string Filter /// - /// IOLayer - documentation pending + /// See . /// public virtual bool IncludeSubdirectories { @@ -94,7 +94,7 @@ public virtual bool IncludeSubdirectories /// - /// IOLayer - documentation pending + /// See . /// public virtual event FileSystemEventHandler Created { @@ -111,7 +111,7 @@ public virtual event FileSystemEventHandler Created /// - /// IOLayer - documentation pending + /// See . /// public virtual event FileSystemEventHandler Changed { @@ -128,7 +128,7 @@ public virtual event FileSystemEventHandler Changed /// - /// IOLayer - documentation pending + /// See . /// public virtual event RenamedEventHandler Renamed { @@ -145,7 +145,7 @@ public virtual event RenamedEventHandler Renamed /// - /// IOLayer - documentation pending + /// See . /// public virtual event FileSystemEventHandler Deleted { @@ -162,7 +162,7 @@ public virtual event FileSystemEventHandler Deleted /// - /// IOLayer - documentation pending + /// See . /// [System.Diagnostics.CodeAnalysis.SuppressMessage("Microsoft.Naming", "CA1716:IdentifiersShouldNotMatchKeywords", MessageId = "Error")] public virtual event ErrorEventHandler Error @@ -180,7 +180,7 @@ public virtual event ErrorEventHandler Error /// - /// IOLayer - documentation pending + /// See . /// public virtual NotifyFilters NotifyFilter { @@ -197,7 +197,7 @@ public virtual NotifyFilters NotifyFilter /// - /// IOLayer - documentation pending + /// See . /// public virtual void BeginInit() { @@ -207,7 +207,7 @@ public virtual void BeginInit() /// - /// IOLayer - documentation pending + /// See . /// public virtual void EndInit() { @@ -217,7 +217,7 @@ public virtual void EndInit() /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -229,7 +229,7 @@ public virtual C1WaitForChangedResult WaitForChanged(WatcherChangeTypes changeTy /// - /// IOLayer - documentation pending + /// See . /// /// /// diff --git a/Composite/Core/Implementation/C1StreamReaderImplementation.cs b/Composite/Core/Implementation/C1StreamReaderImplementation.cs index 8fdf1f4526..be51bd7f84 100644 --- a/Composite/Core/Implementation/C1StreamReaderImplementation.cs +++ b/Composite/Core/Implementation/C1StreamReaderImplementation.cs @@ -9,7 +9,7 @@ namespace Composite.Core.Implementation { /// - /// IOLayer - documentation pending + /// Implementation of . /// public class C1StreamReaderImplementation : IDisposable { @@ -17,7 +17,7 @@ public class C1StreamReaderImplementation : IDisposable /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -31,7 +31,7 @@ public C1StreamReaderImplementation(string path, Encoding encoding, bool detectE /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -45,7 +45,7 @@ public C1StreamReaderImplementation(Stream stream, Encoding encoding, bool detec /// - /// IOLayer - documentation pending + /// See . /// /// public virtual int Read() @@ -56,7 +56,7 @@ public virtual int Read() /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -70,7 +70,7 @@ public virtual int Read(char[] buffer, int index, int count) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual string ReadLine() @@ -81,7 +81,7 @@ public virtual string ReadLine() /// - /// IOLayer - documentation pending + /// See . /// /// public virtual string ReadToEnd() @@ -92,7 +92,7 @@ public virtual string ReadToEnd() /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -106,7 +106,7 @@ public virtual int ReadBlock(char[] buffer, int index, int count) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual int Peek() @@ -117,7 +117,7 @@ public virtual int Peek() /// - /// IOLayer - documentation pending + /// See . /// public virtual bool EndOfStream { @@ -130,7 +130,7 @@ public virtual bool EndOfStream /// - /// IOLayer - documentation pending + /// See . /// public virtual void Close() { @@ -140,7 +140,7 @@ public virtual void Close() /// - /// IOLayer - documentation pending + /// See . /// public virtual Stream BaseStream { @@ -153,7 +153,7 @@ public virtual Stream BaseStream /// - /// IOLayer - documentation pending + /// See . /// public virtual Encoding CurrentEncoding { @@ -166,7 +166,7 @@ public virtual Encoding CurrentEncoding /// - /// IOLayer - documentation pending + /// See . /// public void Dispose() { @@ -177,7 +177,7 @@ public void Dispose() /// - /// IOLayer - documentation pending + /// See . /// ~C1StreamReaderImplementation() { @@ -187,7 +187,7 @@ public void Dispose() /// - /// IOLayer - documentation pending + /// See . /// /// protected virtual void Dispose(bool disposing) diff --git a/Composite/Core/Implementation/C1StreamWriterImplementation.cs b/Composite/Core/Implementation/C1StreamWriterImplementation.cs index 49e7631aec..0b94d93995 100644 --- a/Composite/Core/Implementation/C1StreamWriterImplementation.cs +++ b/Composite/Core/Implementation/C1StreamWriterImplementation.cs @@ -8,7 +8,7 @@ namespace Composite.Core.Implementation { /// - /// IOLayer - documentation pending + /// Implementation of . /// public class C1StreamWriterImplementation : IDisposable { @@ -17,7 +17,7 @@ public class C1StreamWriterImplementation : IDisposable /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -31,7 +31,7 @@ public C1StreamWriterImplementation(string path, bool append, Encoding encoding, /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -44,7 +44,7 @@ public C1StreamWriterImplementation(Stream stream, Encoding encoding, int buffer /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Write(string value) @@ -55,7 +55,7 @@ public virtual void Write(string value) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -67,7 +67,7 @@ public virtual void Write(string format, object arg0) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -80,7 +80,7 @@ public virtual void Write(string format, object arg0, object arg1) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -94,7 +94,7 @@ public virtual void Write(string format, object arg0, object arg1, object arg2) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -106,7 +106,7 @@ public virtual void Write(string format, params object[] arg) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Write(char value) @@ -117,7 +117,7 @@ public virtual void Write(char value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Write(char[] buffer) @@ -128,7 +128,7 @@ public virtual void Write(char[] buffer) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -141,7 +141,7 @@ public virtual void Write(char[] buffer, int index, int count) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Write(bool value) @@ -152,7 +152,7 @@ public virtual void Write(bool value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Write(int value) @@ -163,7 +163,7 @@ public virtual void Write(int value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Write(uint value) @@ -174,7 +174,7 @@ public virtual void Write(uint value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Write(long value) @@ -185,7 +185,7 @@ public virtual void Write(long value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Write(ulong value) @@ -196,7 +196,7 @@ public virtual void Write(ulong value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Write(float value) @@ -207,7 +207,7 @@ public virtual void Write(float value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Write(double value) @@ -218,7 +218,7 @@ public virtual void Write(double value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Write(decimal value) @@ -229,7 +229,7 @@ public virtual void Write(decimal value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void Write(object value) @@ -240,7 +240,7 @@ public virtual void Write(object value) /// - /// IOLayer - documentation pending + /// See . /// public virtual void WriteLine() { @@ -250,7 +250,7 @@ public virtual void WriteLine() /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void WriteLine(string value) @@ -261,7 +261,7 @@ public virtual void WriteLine(string value) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -273,7 +273,7 @@ public virtual void WriteLine(string format, object arg0) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -286,7 +286,7 @@ public virtual void WriteLine(string format, object arg0, object arg1) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -300,7 +300,7 @@ public virtual void WriteLine(string format, object arg0, object arg1, object ar /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -312,7 +312,7 @@ public virtual void WriteLine(string format, params object[] arg) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void WriteLine(char value) @@ -323,7 +323,7 @@ public virtual void WriteLine(char value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void WriteLine(char[] buffer) @@ -334,7 +334,7 @@ public virtual void WriteLine(char[] buffer) /// - /// IOLayer - documentation pending + /// See . /// /// /// @@ -347,7 +347,7 @@ public virtual void WriteLine(char[] buffer, int index, int count) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void WriteLine(bool value) @@ -358,7 +358,7 @@ public virtual void WriteLine(bool value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void WriteLine(int value) @@ -369,7 +369,7 @@ public virtual void WriteLine(int value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void WriteLine(uint value) @@ -380,7 +380,7 @@ public virtual void WriteLine(uint value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void WriteLine(long value) @@ -391,7 +391,7 @@ public virtual void WriteLine(long value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void WriteLine(ulong value) @@ -402,7 +402,7 @@ public virtual void WriteLine(ulong value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void WriteLine(float value) @@ -413,7 +413,7 @@ public virtual void WriteLine(float value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void WriteLine(double value) @@ -424,7 +424,7 @@ public virtual void WriteLine(double value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void WriteLine(decimal value) @@ -435,7 +435,7 @@ public virtual void WriteLine(decimal value) /// - /// IOLayer - documentation pending + /// See . /// /// public virtual void WriteLine(object value) @@ -446,7 +446,7 @@ public virtual void WriteLine(object value) /// - /// IOLayer - documentation pending + /// See . /// public virtual string NewLine { @@ -463,7 +463,7 @@ public virtual string NewLine /// - /// IOLayer - documentation pending + /// See . /// public virtual IFormatProvider FormatProvider { @@ -476,7 +476,7 @@ public virtual IFormatProvider FormatProvider /// - /// IOLayer - documentation pending + /// See . /// public virtual void Flush() { @@ -486,7 +486,7 @@ public virtual void Flush() /// - /// IOLayer - documentation pending + /// See . /// public virtual bool AutoFlush { @@ -503,7 +503,7 @@ public virtual bool AutoFlush /// - /// IOLayer - documentation pending + /// See . /// public virtual void Close() { @@ -513,7 +513,7 @@ public virtual void Close() /// - /// IOLayer - documentation pending + /// See . /// public virtual Stream BaseStream { @@ -526,7 +526,7 @@ public virtual Stream BaseStream /// - /// IOLayer - documentation pending + /// See . /// public virtual Encoding Encoding { @@ -539,7 +539,7 @@ public virtual Encoding Encoding /// - /// IOLayer - documentation pending + /// See . /// public void Dispose() { @@ -558,7 +558,7 @@ public void Dispose() /// - /// IOLayer - documentation pending + /// See . /// /// protected virtual void Dispose(bool disposing)