Fix C# code documentation in manual files

DEVSIX-3096

Author: yulian-gaponenko

itext/itext.kernel/itext/kernel/xmp/XMPDateTime.cs

@@ -33,23 +33,23 @@
 namespace iText.Kernel.XMP
 {
 	/// <summary>
-	/// The <code>XMPDateTime</code>-class represents a point in time up to a resolution of nano
+	/// The <c>XMPDateTime</c>-class represents a point in time up to a resolution of nano
 	/// seconds.
 	/// </summary>
 	/// <remarks>
-	/// The <code>XMPDateTime</code>-class represents a point in time up to a resolution of nano
+	/// The <c>XMPDateTime</c>-class represents a point in time up to a resolution of nano
 	/// seconds. Dates and time in the serialized XMP are ISO 8601 strings. There are utility functions
-	/// to convert to the ISO format, a <code>Calendar</code> or get the Timezone. The fields of
-	/// <code>XMPDateTime</code> are:
+	/// to convert to the ISO format, a <c>Calendar</c> or get the Timezone. The fields of
+	/// <c>XMPDateTime</c> are:
 	/// <ul>
-	/// <li> month - The month in the range 1..12.
-	/// <li> day - The day of the month in the range 1..31.
-	/// <li> minute - The minute in the range 0..59.
-	/// <li> hour - The time zone hour in the range 0..23.
-	/// <li> minute - The time zone minute in the range 0..59.
+	/// <li> month - The month in the range 1..12.</li> 
+	/// <li> day - The day of the month in the range 1..31.</li>
+	/// <li> minute - The minute in the range 0..59.</li>
+	/// <li> hour - The time zone hour in the range 0..23.</li>
+	/// <li> minute - The time zone minute in the range 0..59.</li>
 	/// <li> nanoSecond - The nano seconds within a second. <em>Note:</em> if the XMPDateTime is
-	/// converted into a calendar, the resolution is reduced to milli seconds.
-	/// <li> timeZoneInfo - a <code>TimeZoneInfo</code>-object.
+	/// converted into a calendar, the resolution is reduced to milli seconds.</li>
+	/// <li> timeZoneInfo - a <code>TimeZoneInfo</code>-object.</li>
 	/// </ul>
 	/// DateTime values are occasionally used in cases with only a date or only a time component. A date
 	/// without a time has zeros for all the time fields. A time without a date has zeros for all date

itext/itext.kernel/itext/kernel/xmp/impl/ISO8601Converter.cs

@@ -44,29 +44,29 @@ private ISO8601Converter()
 		}
 
 		// EMPTY
-		/// <summary>Converts an ISO 8601 string to an <code>XMPDateTime</code>.</summary>
+		/// <summary>Converts an ISO 8601 string to an <c>XMPDateTime</c>.</summary>
 		/// <remarks>
-		/// Converts an ISO 8601 string to an <code>XMPDateTime</code>.
+		/// Converts an ISO 8601 string to an <c>XMPDateTime</c>.
 		/// Parse a date according to ISO 8601 and
 		/// http://www.w3.org/TR/NOTE-datetime:
 		/// <ul>
-		/// <li>YYYY
-		/// <li>YYYY-MM
-		/// <li>YYYY-MM-DD
-		/// <li>YYYY-MM-DDThh:mmTZD
-		/// <li>YYYY-MM-DDThh:mm:ssTZD
-		/// <li>YYYY-MM-DDThh:mm:ss.sTZD
+		/// <li>YYYY</li>
+		/// <li>YYYY-MM</li>
+		/// <li>YYYY-MM-DD</li>
+		/// <li>YYYY-MM-DDThh:mmTZD</li>
+		/// <li>YYYY-MM-DDThh:mm:ssTZD</li>
+		/// <li>YYYY-MM-DDThh:mm:ss.sTZD</li>
 		/// </ul>
 		/// Data fields:
 		/// <ul>
-		/// <li>YYYY = four-digit year
-		/// <li>MM = two-digit month (01=January, etc.)
-		/// <li>DD = two-digit day of month (01 through 31)
-		/// <li>hh = two digits of hour (00 through 23)
-		/// <li>mm = two digits of minute (00 through 59)
-		/// <li>ss = two digits of second (00 through 59)
-		/// <li>s = one or more digits representing a decimal fraction of a second
-		/// <li>TZD = time zone designator (Z or +hh:mm or -hh:mm)
+		/// <li>YYYY = four-digit year</li>
+		/// <li>MM = two-digit month (01=January, etc.)</li>
+		/// <li>DD = two-digit day of month (01 through 31)</li>
+		/// <li>hh = two digits of hour (00 through 23)</li>
+		/// <li>mm = two digits of minute (00 through 59)</li>
+		/// <li>ss = two digits of second (00 through 59)</li>
+		/// <li>s = one or more digits representing a decimal fraction of a second</li>
+		/// <li>TZD = time zone designator (Z or +hh:mm or -hh:mm)</li>
 		/// </ul>
 		/// Note that ISO 8601 does not seem to allow years less than 1000 or greater
 		/// than 9999. We allow any year, even negative ones. The year is formatted
@@ -77,9 +77,10 @@ private ISO8601Converter()
 		/// <em>Note:</em> DOES NOT APPLY ANYMORE.
 		/// Tolerate missing date portion, in case someone foolishly
 		/// writes a time-only value that way.
+		/// </p>
 		/// </remarks>
 		/// <param name="iso8601String">a date string that is ISO 8601 conform.</param>
-		/// <returns>Returns a <code>Calendar</code>.</returns>
+		/// <returns>Returns a <c>XMPDateTime</c>.</returns>
 		/// <exception cref="iText.Kernel.XMP.XMPException">Is thrown when the string is non-conform.
 		/// 	</exception>
 		public static XMPDateTime Parse(String iso8601String)
@@ -234,34 +235,35 @@ public static XMPDateTime Parse(String iso8601String, XMPDateTime binValue)
 			return binValue;
 		}
 
-		/// <summary>Converts a <code>Calendar</code> into an ISO 8601 string.</summary>
+		/// <summary>Converts a <c>XMPDateTime</c> into an ISO 8601 string.</summary>
 		/// <remarks>
-		/// Converts a <code>Calendar</code> into an ISO 8601 string.
+		/// Converts a <c>XMPDateTime</c> into an ISO 8601 string.
 		/// Format a date according to ISO 8601 and http://www.w3.org/TR/NOTE-datetime:
 		/// <ul>
-		/// <li>YYYY
-		/// <li>YYYY-MM
-		/// <li>YYYY-MM-DD
-		/// <li>YYYY-MM-DDThh:mmTZD
-		/// <li>YYYY-MM-DDThh:mm:ssTZD
-		/// <li>YYYY-MM-DDThh:mm:ss.sTZD
+		/// <li>YYYY</li>
+		/// <li>YYYY-MM</li>
+		/// <li>YYYY-MM-DD</li>
+		/// <li>YYYY-MM-DDThh:mmTZD</li>
+		/// <li>YYYY-MM-DDThh:mm:ssTZD</li>
+		/// <li>YYYY-MM-DDThh:mm:ss.sTZD</li>
 		/// </ul>
 		/// Data fields:
 		/// <ul>
-		/// <li>YYYY = four-digit year
-		/// <li>MM	 = two-digit month (01=January, etc.)
-		/// <li>DD	 = two-digit day of month (01 through 31)
-		/// <li>hh	 = two digits of hour (00 through 23)
-		/// <li>mm	 = two digits of minute (00 through 59)
-		/// <li>ss	 = two digits of second (00 through 59)
-		/// <li>s	 = one or more digits representing a decimal fraction of a second
-		/// <li>TZD	 = time zone designator (Z or +hh:mm or -hh:mm)
+		/// <li>YYYY = four-digit year</li>
+		/// <li>MM	 = two-digit month (01=January, etc.)</li>
+		/// <li>DD	 = two-digit day of month (01 through 31)</li>
+		/// <li>hh	 = two digits of hour (00 through 23)</li>
+		/// <li>mm	 = two digits of minute (00 through 59)</li>
+		/// <li>ss	 = two digits of second (00 through 59)</li>
+		/// <li>s	 = one or more digits representing a decimal fraction of a second</li>
+		/// <li>TZD	 = time zone designator (Z or +hh:mm or -hh:mm)</li>
 		/// </ul>
 		/// <p>
 		/// <em>Note:</em> ISO 8601 does not seem to allow years less than 1000 or greater than 9999.
-		/// We allow any year, even negative ones. The year is formatted as "%.4d".<p>
+		/// We allow any year, even negative ones. The year is formatted as "%.4d".</p><p>
 		/// <em>Note:</em> Fix for bug 1269463 (silently fix out of range values) included in parsing.
 		/// The quasi-bogus "time only" values from Photoshop CS are not supported.
+		/// </p>
 		/// </remarks>
 		/// <param name="dateTime">an XMPDateTime-object.</param>
 		/// <returns>Returns an ISO 8601 string.</returns>

itext/itext.kernel/itext/kernel/xmp/impl/XMPIteratorImpl.cs

@@ -273,7 +273,7 @@ public virtual Object Current {
 			/// <summary>
 			/// Prepares the next node to return if not already done. 
 			/// </summary>
-			/// <seealso cref= Iterator#hasNext() </seealso>
+			/// <seealso cref="IEnumerator.MoveNext"/>
 			public virtual bool MoveNext() {
 				// find next node
 				if (state == ITERATE_NODE) {
@@ -457,7 +457,7 @@ public NodeIteratorChildren(XMPIteratorImpl outerInstance, XMPNode parentNode, s
 			/// <summary>
 			/// Prepares the next node to return if not already done. 
 			/// </summary>
-			/// <seealso cref= Iterator#hasNext() </seealso>
+			/// <seealso cref="IEnumerator.MoveNext"/>
 			public override bool MoveNext() {
 				if (outerInstance.skipSiblings) {
 					return false;

itext/itext.kernel/itext/kernel/xmp/impl/XMPMetaParser.cs

@@ -101,14 +101,16 @@ public static XMPMeta Parse(Object input, ParseOptions options)
 		/// Latin-1/ISO-8859-1 can be accepted when the input is a byte stream
 		/// (some old toolkits versions such packets). The stream is
 		/// then wrapped in another stream that converts Latin-1 to UTF-8.
-		/// <p>
+		/// <para>
 		/// If control characters shall be fixed, a reader is used that fixes the chars to spaces
 		/// (if the input is a byte stream is has to be read as character stream).
-		/// <p>
+		/// </para>
+		/// <para>
 		/// Both options reduce the performance of the parser.
+		/// </para>
 		/// </remarks>
 		/// <param name="input">
-		/// the input can be an <code>InputStream</code>, a <code>String</code> or
+		/// the input can be an <c>Stream</c>, a <c>String</c> or
 		/// a byte buffer containing the XMP packet.
 		/// </param>
 		/// <param name="options">the parsing options</param>
@@ -220,30 +222,30 @@ private static XmlDocument ParseXmlFromString(string input, ParseOptions options
 		/// is parsed (e.g. SVG). The XML parser counted all rdf:RDF and
 		/// pxmp:XMP_Packet nodes, and kept a pointer to the last one. If there is
 		/// more than one possible root use PickBestRoot to choose among them.
-		/// <p>
+		/// <para>
 		/// If there is a root node, try to extract the version of the previous XMP
-		/// toolkit.
-		/// <p>
+		/// toolkit.</para>
+		/// <para>
 		/// Pick the first x:xmpmeta among multiple root candidates. If there aren't
 		/// any, pick the first bare rdf:RDF if that is allowed. The returned root is
 		/// the rdf:RDF child if an x:xmpmeta element was chosen. The search is
 		/// breadth first, so a higher level candiate is chosen over a lower level
-		/// one that was textually earlier in the serialized XML.
+		/// one that was textually earlier in the serialized XML.</para>
 		/// </remarks>
 		/// <param name="root">the root of the xml document</param>
 		/// <param name="xmpmetaRequired">
 		/// flag if the xmpmeta-tag is still required, might be set
-		/// initially to <code>true</code>, if the parse option "REQUIRE_XMP_META" is set
+		/// initially to <c>true</c>, if the parse option "REQUIRE_XMP_META" is set
 		/// </param>
 		/// <param name="result">The result array that is filled during the recursive process.
 		/// 	</param>
 		/// <returns>
-		/// Returns an array that contains the result or <code>null</code>.
+		/// Returns an array that contains the result or <c>null</c>.
 		/// The array contains:
 		/// <ul>
-		/// <li>[0] - the rdf:RDF-node
-		/// <li>[1] - an object that is either XMP_RDF or XMP_PLAIN (the latter is decrecated)
-		/// <li>[2] - the body text of the xpacket-instruction.
+		/// <li>[0] - the rdf:RDF-node</li>
+		/// <li>[1] - an object that is either XMP_RDF or XMP_PLAIN (the latter is decrecated)</li>
+		/// <li>[2] - the body text of the xpacket-instruction.</li>
 		/// </ul>
 		/// </returns>
 		private static Object[] FindRootNode(XmlNode root, bool xmpmetaRequired, Object[] result) {

itext/itext.kernel/itext/kernel/xmp/impl/XMPNode.cs

@@ -522,21 +522,17 @@ public virtual void SetHasValueChild(bool hasValueChild)
 		}
 
 		/// <summary>
-		/// Sorts the complete datamodel according to the following rules:
-		/// <ul>
-		/// <li>Nodes at one level are sorted by name, that is prefix + local name
-		/// <li>Starting at the root node the children and qualifier are sorted recursively,
-		/// which the following exceptions.
+		/// Sorts the complete datamodel according to the rules.
 		/// </summary>
 		/// <remarks>
 		/// Sorts the complete datamodel according to the following rules:
 		/// <ul>
-		/// <li>Nodes at one level are sorted by name, that is prefix + local name
+		/// <li>Nodes at one level are sorted by name, that is prefix + local name</li>
 		/// <li>Starting at the root node the children and qualifier are sorted recursively,
-		/// which the following exceptions.
-		/// <li>Sorting will not be used for arrays.
+		/// which the following exceptions.</li>
+		/// <li>Sorting will not be used for arrays.</li>
 		/// <li>Within qualifier "xml:lang" and/or "rdf:type" stay at the top in that order,
-		/// all others are sorted.
+		/// all others are sorted.</li>
 		/// </ul>
 		/// </remarks>
 		public virtual void Sort()

itext/itext.kernel/itext/kernel/xmp/impl/XMPNodeUtils.cs

@@ -35,7 +35,7 @@
 
 namespace iText.Kernel.XMP.Impl
 {
-	/// <summary>Utilities for <code>XMPNode</code>.</summary>
+	/// <summary>Utilities for <c>XMPNode</c>.</summary>
 	/// <since>Aug 28, 2006</since>
 	public sealed class XMPNodeUtils : XMPConst
 	{
@@ -440,19 +440,17 @@ internal static String SerializeNodeValue(Object value)
 		}
 
 		/// <summary>
-		/// After processing by ExpandXPath, a step can be of these forms:
-		/// <ul>
-		/// <li>qualName - A top level property or struct field.
+		/// After processing by ExpandXPath, a step can be of certain forms described in documentation.
 		/// </summary>
 		/// <remarks>
 		/// After processing by ExpandXPath, a step can be of these forms:
 		/// <ul>
-		/// <li>qualName - A top level property or struct field.
-		/// <li>[index] - An element of an array.
-		/// <li>[last()] - The last element of an array.
-		/// <li>[qualName="value"] - An element in an array of structs, chosen by a field value.
-		/// <li>[?qualName="value"] - An element in an array, chosen by a qualifier value.
-		/// <li>?qualName - A general qualifier.
+		/// <li>qualName - A top level property or struct field.</li>
+		/// <li>[index] - An element of an array.</li>
+		/// <li>[last()] - The last element of an array.</li>
+		/// <li>[qualName="value"] - An element in an array of structs, chosen by a field value.</li>
+		/// <li>[?qualName="value"] - An element in an array, chosen by a qualifier value.</li>
+		/// <li>?qualName - A general qualifier.</li>
 		/// </ul>
 		/// Find the appropriate child node, resolving aliases, and optionally creating nodes.
 		/// </remarks>
@@ -785,16 +783,15 @@ internal static void AppendLangItem(XMPNode arrayNode, String itemLang, String i
 		}
 
 		/// <summary>
-		/// <ol>
-		/// <li>Look for an exact match with the specific language.
+		/// Look for an exact match with the specific language.
 		/// </summary>
 		/// <remarks>
-		/// <ol>
-		/// <li>Look for an exact match with the specific language.
-		/// <li>If a generic language is given, look for partial matches.
-		/// <li>Look for an "x-default"-item.
-		/// <li>Choose the first item.
-		/// </ol>
+		/// <ul>
+		/// <li>Look for an exact match with the specific language.</li>
+		/// <li>If a generic language is given, look for partial matches.</li>
+		/// <li>Look for an "x-default"-item.</li>
+		/// <li>Choose the first item.</li>
+		/// </ul>
 		/// </remarks>
 		/// <param name="arrayNode">the alt text array node</param>
 		/// <param name="genericLang">the generic language</param>

itext/itext.kernel/itext/kernel/xmp/impl/XMPSchemaRegistryImpl.cs

@@ -280,8 +280,7 @@ public XMPAliasInfo ResolveAlias(String aliasNS, String aliasProp)
 			}
 		}
 
-		/// <seealso cref="iText.Kernel.XMP.XMPSchemaRegistry.FindAlias(System.String)"/
-		/// 	>
+		/// <seealso cref="iText.Kernel.XMP.XMPSchemaRegistry.FindAlias(System.String)" />
 		public XMPAliasInfo FindAlias(String qname)
 		{
 			lock (this)
@@ -290,8 +289,7 @@ public XMPAliasInfo FindAlias(String qname)
 			}
 		}
 
-		/// <seealso cref="iText.Kernel.XMP.XMPSchemaRegistry.FindAliases(System.String)
-		/// 	"/>
+		/// <seealso cref="iText.Kernel.XMP.XMPSchemaRegistry.FindAliases(System.String)"/>
 		public XMPAliasInfo[] FindAliases(String aliasNS)
 		{
 			lock (this)
@@ -316,7 +314,7 @@ public XMPAliasInfo[] FindAliases(String aliasNS)
 		/// <summary>Associates an alias name with an actual name.</summary>
 		/// <remarks>
 		/// Associates an alias name with an actual name.
-		/// <p>
+		/// <para>
 		/// Define a alias mapping from one namespace/property to another. Both
 		/// property names must be simple names. An alias can be a direct mapping,
 		/// where the alias and actual have the same data type. It is also possible
@@ -327,6 +325,7 @@ public XMPAliasInfo[] FindAliases(String aliasNS)
 		/// Note: This method is not locking because only called by registerStandardAliases
 		/// which is only called by the constructor.
 		/// Note2: The method is only package-private so that it can be tested with unittests
+		/// </para>
 		/// </remarks>
 		/// <param name="aliasNS">
 		/// The namespace URI for the alias. Must not be null or the empty
@@ -530,6 +529,7 @@ private ReadOnlyDictionary(IDictionary original) {
 		/// Return a read only wrapper to an existing dictionary.
 		/// Any change to the underlying dictionary will be 
 		/// propagated to the read-only wrapper.
+		/// </summary>
 		public static ReadOnlyDictionary ReadOnly(IDictionary dictionary) {
 			return new ReadOnlyDictionary(dictionary);
 		}

itext/itext.kernel/itext/kernel/xmp/impl/XMPSerializerRdf.cs

@@ -867,7 +867,7 @@ private void StartOuterRDFDescription(XMPNode schemaNode, int level)
 			WriteNewline();
 		}
 
-		/// <summary>Write the </rdf:Description> end tag.</summary>
+		/// <summary>Write the &lt;/rdf:Description&gt; end tag.</summary>
 		/// <exception cref="System.IO.IOException"/>
 		private void EndOuterRDFDescription(int level)
 		{
@@ -1217,10 +1217,10 @@ private void AppendNodeValue(String value, bool forAttribute)
 		/// <summary>
 		/// A node can be serialized as RDF-Attribute, if it meets the following conditions:
 		/// <ul>
-		/// <li>is not array item
-		/// <li>don't has qualifier
-		/// <li>is no URI
-		/// <li>is no composite property
+		/// <li>is not array item</li>
+		/// <li>don't has qualifier</li>
+		/// <li>is no URI</li>
+		/// <li>is no composite property</li>
 		/// </ul>
 		/// </summary>
 		/// <param name="node">an XMPNode</param>