Menu
▾
▴
[mvp-xml-cvs] XInclude/v1/src TextUtils.cs,1.3,1.4 XInclude.csproj,1.8,1.9 XIncludeException.cs,1.8,1.9 XIncludingReader.cs,1.28,1.29
|
From: Oleg T. <he...@us...> - 2004-11-07 16:46:39
|
Update of /cvsroot/mvp-xml/XInclude/v1/src In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv32642/v1/src Modified Files: TextUtils.cs XInclude.csproj XIncludeException.cs XIncludingReader.cs Log Message: Documenation stuff. Index: XIncludeException.cs =================================================================== RCS file: /cvsroot/mvp-xml/XInclude/v1/src/XIncludeException.cs,v retrieving revision 1.8 retrieving revision 1.9 diff -u -d -r1.8 -r1.9 --- XIncludeException.cs 4 Nov 2004 15:47:25 -0000 1.8 +++ XIncludeException.cs 7 Nov 2004 16:46:25 -0000 1.9 @@ -6,75 +6,157 @@ namespace Mvp.Xml.XInclude { - /// <summary> - /// Generic XInclude exception. - /// </summary> - public abstract class XIncludeException : Exception { - public XIncludeException(string message) : base(message) {} - public XIncludeException(string message, Exception innerException) - : base(message, innerException) {} - } + /// <summary> + /// Generic XInclude exception. + /// </summary> + public abstract class XIncludeException : Exception + { + /// <summary> + /// Initializes a new instance of the <see cref="XIncludeException"/> + /// class with a specified error message. + /// </summary> + /// <param name="message">Error message</param> + public XIncludeException(string message) : base(message) {} + + /// <summary> + /// Initializes a new instance of the <see cref="XIncludeException"/> + /// class with a specified error message and a reference to the + /// inner exception that is the cause of this exception. + /// </summary> + /// <param name="message">Error message</param> + /// <param name="innerException">Inner exceptiion</param> + public XIncludeException(string message, Exception innerException) + : base(message, innerException) {} + } - /// <summary> - /// <c>ResourceException</c> represents resource error as per XInclude specification. - /// </summary> - /// <remarks> - /// Resource error is internal error and should lead to fallback processing. - /// <c>ResourceException</c> therefore should never be thrown outside - /// the XInclude Processor. - /// </remarks> - internal class ResourceException : XIncludeException { - public ResourceException(string message) : base(message) {} + /// <summary> + /// <c>ResourceException</c> represents resource error as per XInclude specification. + /// </summary> + /// <remarks> + /// Resource error is internal error and should lead to the fallback processing. + /// <c>ResourceException</c> therefore should never be thrown outside + /// the XInclude Processor. + /// </remarks> + internal class ResourceException : XIncludeException + { + /// <summary> + /// Initializes a new instance of the <see cref="ResourceException"/> + /// class with a specified error message. + /// </summary> + /// <param name="message">Error message</param> + public ResourceException(string message) : base(message) {} + + /// <summary> + /// Initializes a new instance of the <see cref="ResourceException"/> + /// class with a specified error message and a reference to the + /// inner exception that is the cause of this exception. + /// </summary> + /// <param name="message">Error message</param> + /// <param name="innerException">Inner exceptiion</param> public ResourceException(string message, Exception innerException) : base(message, innerException) {} - } + } - /// <summary> - /// <c>FatalException</c> represents fatal error as per XInclude spcification. - /// </summary> - public abstract class FatalException : XIncludeException { - public FatalException(string message) : base(message) {} + /// <summary> + /// <c>FatalException</c> represents fatal error as per XInclude spcification. + /// </summary> + public abstract class FatalException : XIncludeException + { + /// <summary> + /// Initializes a new instance of the <see cref="FatalException"/> + /// class with a specified error message. + /// </summary> + /// <param name="message">Error message</param> + public FatalException(string message) : base(message) {} + + /// <summary> + /// Initializes a new instance of the <see cref="FatalException"/> + /// class with a specified error message and a reference to the + /// inner exception that is the cause of this exception. + /// </summary> + /// <param name="message">Error message</param> + /// <param name="innerException">Inner exceptiion</param> public FatalException(string message, Exception innerException) : base(message, innerException) {} - } + } - /// <summary> - /// Non XML character in a document to include exception. - /// </summary> - public class NonXmlCharacterException : FatalException { + /// <summary> + /// Non XML character in a document to include exception. + /// </summary> + public class NonXmlCharacterException : FatalException + { + /// <summary> + /// Initializes a new instance of the <see cref="NonXmlCharacterException"/> + /// class with a specified invalid character. + /// </summary> + /// <param name="c">Invalid character</param> public NonXmlCharacterException(char c) : base(SR.GetString("NonXmlCharacter", ((int)c).ToString("X2"))) {} - } + } - /// <summary> - /// Circular inclusion exception. - /// </summary> - public class CircularInclusionException : FatalException { + /// <summary> + /// Circular inclusion exception. + /// </summary> + public class CircularInclusionException : FatalException + { + /// <summary> + /// Initializes a new instance of the <see cref="CircularInclusionException"/> + /// class with a specified Uri that causes inclusion loop. + /// </summary> + /// <param name="uri">Uri that causes inclusion loop</param> public CircularInclusionException(Uri uri) : base(SR.GetString("CircularInclusion", uri.AbsoluteUri)) {} + + /// <summary> + /// Initializes a new instance of the <see cref="CircularInclusionException"/> + /// class with a specified Uri that causes inclusion loop and error location within + /// XML document. + /// </summary> + /// <param name="uri">Uri that causes inclusion loop</param> + /// <param name="line">Line number</param> + /// <param name="locationUri">Location Uri</param> + /// <param name="position">Column number</param> public CircularInclusionException(Uri uri, string locationUri, int line, int position) : base(SR.GetString("CircularInclusionLong", uri.AbsoluteUri, locationUri, line, position)) {} - } + } /// <summary> /// Resource error not backed up by xi:fallback exception. /// </summary> - public class FatalResourceException : FatalException { + public class FatalResourceException : FatalException + { + /// <summary> + /// Initializes a new instance of the <see cref="FatalResourceException"/> + /// class with the specified inner exception that is the cause of this exception. + /// </summary> + /// <param name="re">Inner exceptiion</param> public FatalResourceException(Exception re) : - base(SR.GetString("FatalResourceException", re.Message), re) {} - } + base(SR.GetString("FatalResourceException", re.Message), re) {} + } /// <summary> /// XInclude syntax error exception. /// </summary> - public class XIncludeSyntaxError : FatalException { + public class XIncludeSyntaxError : FatalException + { + /// <summary> + /// Initializes a new instance of the <see cref="XIncludeSyntaxError"/> + /// class with a specified error message. + /// </summary> + /// <param name="message">Error message</param> public XIncludeSyntaxError(string message) : base(message) {} } /// <summary> /// Include location identifies an attribute or namespace node. /// </summary> - public class AttributeOrNamespaceInIncludeLocationError : FatalException { + public class AttributeOrNamespaceInIncludeLocationError : FatalException + { + /// <summary> + /// Initializes a new instance of the <see cref="AttributeOrNamespaceInIncludeLocationError"/> + /// class with a specified error message. + /// </summary> + /// <param name="message">Error message</param> public AttributeOrNamespaceInIncludeLocationError(string message) : base(message) {} } @@ -84,6 +166,11 @@ /// </summary> public class MalformedXInclusionResultError : FatalException { + /// <summary> + /// Initializes a new instance of the <see cref="MalformedXInclusionResultError"/> + /// class with a specified error message. + /// </summary> + /// <param name="message">Error message</param> public MalformedXInclusionResultError(string message) : base(message) {} } @@ -91,9 +178,14 @@ /// Value of the "accept" attribute contains an invalid for /// HTTP header character (outside #x20 through #x7E range). /// </summary> - public class InvalidAcceptHTTPHeaderValue : FatalException + public class InvalidAcceptHTTPHeaderValueError : FatalException { - public InvalidAcceptHTTPHeaderValue(char c) : + /// <summary> + /// Initializes a new instance of the <see cref="InvalidAcceptHTTPHeaderValueError"/> + /// class with a specified invalid character. + /// </summary> + /// <param name="c">Invalid character</param> + public InvalidAcceptHTTPHeaderValueError(char c) : base(SR.GetString("InvalidCharForAccept", ((int)c).ToString("X2"))) {} } } Index: XInclude.csproj =================================================================== RCS file: /cvsroot/mvp-xml/XInclude/v1/src/XInclude.csproj,v retrieving revision 1.8 retrieving revision 1.9 diff -u -d -r1.8 -r1.9 --- XInclude.csproj 28 Oct 2004 18:27:05 -0000 1.8 +++ XInclude.csproj 7 Nov 2004 16:46:25 -0000 1.9 @@ -29,7 +29,7 @@ CheckForOverflowUnderflow = "false" ConfigurationOverrideFile = "" DefineConstants = "DEBUG;TRACE" - DocumentationFile = "" + DocumentationFile = "Mvp.Xml.XInclude.xml" DebugSymbols = "true" FileAlignment = "4096" IncrementalBuild = "false" Index: XIncludingReader.cs =================================================================== RCS file: /cvsroot/mvp-xml/XInclude/v1/src/XIncludingReader.cs,v retrieving revision 1.28 retrieving revision 1.29 diff -u -d -r1.28 -r1.29 --- XIncludingReader.cs 7 Nov 2004 14:49:56 -0000 1.28 +++ XIncludingReader.cs 7 Nov 2004 16:46:25 -0000 1.29 @@ -20,14 +20,13 @@ namespace Mvp.Xml.XInclude { /// <summary> - /// XInclude 1.0 aware XmlReader. + /// <c>XIncludingReader</c> class implements streamable subset of the + /// XInclude 1.0 in a fast, non-caching, forward-only fashion. + /// To put it another way <c>XIncludingReader</c> is XInclude 1.0 aware + /// <c>XmlReader</c>. /// </summary> + /// <remarks>See <a href="http://mvp-xml.sf.net/xinclude">XInclude.NET homepage</a> for more info.</remarks> /// <author>Oleg Tkachenko, ol...@tk...</author> - /// <remarks> - /// Open Issues: - /// o GetAttribute(int i)? - /// o MoveToAttribute(int i)? - ///</remarks> public class XIncludingReader : XmlReader { #region Private fields @@ -604,19 +603,19 @@ get { return _reader.ReadState; } } - /// <summary>See <see cref="XmlReader.Item"/></summary> + /// <summary>See <see cref="XmlReader.this"/></summary> public override String this [int i] { get { return GetAttribute(i); } } - /// <summary>See <see cref="XmlReader.Item"/></summary> + /// <summary>See <see cref="XmlReader.this"/></summary> public override string this [string name] { get { return GetAttribute(name); } } - /// <summary>See <see cref="XmlReader.Item"/></summary> + /// <summary>See <see cref="XmlReader.this"/></summary> public override string this [string name, string namespaceURI] { get { return GetAttribute(name, namespaceURI); } @@ -915,8 +914,8 @@ } /// <summary> - /// Flag indicating whether to emit xml:base as relative URI. - /// Note, it's true by default + /// Flag indicating whether to emit <c>xml:base</c> as relative URI. + /// True by default. /// </summary> public bool MakeRelativeBaseUri { @@ -1347,6 +1346,7 @@ /// Creates acquired infoset. /// </summary> /// <param name="reader">Source reader</param> + /// <param name="includeLocation">Base URI</param> private string CreateAcquiredInfoset(Uri includeLocation, TextReader reader) { return CreateAcquiredInfoset( Index: TextUtils.cs =================================================================== RCS file: /cvsroot/mvp-xml/XInclude/v1/src/TextUtils.cs,v retrieving revision 1.3 retrieving revision 1.4 diff -u -d -r1.3 -r1.4 --- TextUtils.cs 26 Oct 2004 19:28:41 -0000 1.3 +++ TextUtils.cs 7 Nov 2004 16:46:25 -0000 1.4 @@ -19,7 +19,7 @@ /// not permitted in XML 1.0 documents. /// </summary> /// <param name="str">Input string to check.</param> - /// <exception cref="NonXmlCharacterInDocument">Given string contains a character, + /// <exception cref="NonXmlCharacterException">Given string contains a character, /// forbidden in XML 1.0.</exception> public static void CheckForNonXmlChars(string str) { @@ -55,7 +55,7 @@ foreach (char c in accept) { if (c < 0x0020 || c > 0x007E) - throw new InvalidAcceptHTTPHeaderValue(c); + throw new InvalidAcceptHTTPHeaderValueError(c); } } |
