Skip to content

Commit 1056da0

Browse files
yulian-gaponenkoiText-CI
yulian-gaponenko
authored and
iText-CI
committed
Fix C# code documentation in manual files
DEVSIX-3096
1 parent 6cf634c commit 1056da0

File tree

8 files changed

+93
-96
lines changed

8 files changed

+93
-96
lines changed

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

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -33,23 +33,23 @@
3333
namespace iText.Kernel.XMP
3434
{
3535
/// <summary>
36-
/// The <code>XMPDateTime</code>-class represents a point in time up to a resolution of nano
36+
/// The <c>XMPDateTime</c>-class represents a point in time up to a resolution of nano
3737
/// seconds.
3838
/// </summary>
3939
/// <remarks>
40-
/// The <code>XMPDateTime</code>-class represents a point in time up to a resolution of nano
40+
/// The <c>XMPDateTime</c>-class represents a point in time up to a resolution of nano
4141
/// seconds. Dates and time in the serialized XMP are ISO 8601 strings. There are utility functions
42-
/// to convert to the ISO format, a <code>Calendar</code> or get the Timezone. The fields of
43-
/// <code>XMPDateTime</code> are:
42+
/// to convert to the ISO format, a <c>Calendar</c> or get the Timezone. The fields of
43+
/// <c>XMPDateTime</c> are:
4444
/// <ul>
45-
/// <li> month - The month in the range 1..12.
46-
/// <li> day - The day of the month in the range 1..31.
47-
/// <li> minute - The minute in the range 0..59.
48-
/// <li> hour - The time zone hour in the range 0..23.
49-
/// <li> minute - The time zone minute in the range 0..59.
45+
/// <li> month - The month in the range 1..12.</li>
46+
/// <li> day - The day of the month in the range 1..31.</li>
47+
/// <li> minute - The minute in the range 0..59.</li>
48+
/// <li> hour - The time zone hour in the range 0..23.</li>
49+
/// <li> minute - The time zone minute in the range 0..59.</li>
5050
/// <li> nanoSecond - The nano seconds within a second. <em>Note:</em> if the XMPDateTime is
51-
/// converted into a calendar, the resolution is reduced to milli seconds.
52-
/// <li> timeZoneInfo - a <code>TimeZoneInfo</code>-object.
51+
/// converted into a calendar, the resolution is reduced to milli seconds.</li>
52+
/// <li> timeZoneInfo - a <code>TimeZoneInfo</code>-object.</li>
5353
/// </ul>
5454
/// DateTime values are occasionally used in cases with only a date or only a time component. A date
5555
/// 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‎

Lines changed: 36 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -44,29 +44,29 @@ private ISO8601Converter()
4444
}
4545

4646
// EMPTY
47-
/// <summary>Converts an ISO 8601 string to an <code>XMPDateTime</code>.</summary>
47+
/// <summary>Converts an ISO 8601 string to an <c>XMPDateTime</c>.</summary>
4848
/// <remarks>
49-
/// Converts an ISO 8601 string to an <code>XMPDateTime</code>.
49+
/// Converts an ISO 8601 string to an <c>XMPDateTime</c>.
5050
/// Parse a date according to ISO 8601 and
5151
/// http://www.w3.org/TR/NOTE-datetime:
5252
/// <ul>
53-
/// <li>YYYY
54-
/// <li>YYYY-MM
55-
/// <li>YYYY-MM-DD
56-
/// <li>YYYY-MM-DDThh:mmTZD
57-
/// <li>YYYY-MM-DDThh:mm:ssTZD
58-
/// <li>YYYY-MM-DDThh:mm:ss.sTZD
53+
/// <li>YYYY</li>
54+
/// <li>YYYY-MM</li>
55+
/// <li>YYYY-MM-DD</li>
56+
/// <li>YYYY-MM-DDThh:mmTZD</li>
57+
/// <li>YYYY-MM-DDThh:mm:ssTZD</li>
58+
/// <li>YYYY-MM-DDThh:mm:ss.sTZD</li>
5959
/// </ul>
6060
/// Data fields:
6161
/// <ul>
62-
/// <li>YYYY = four-digit year
63-
/// <li>MM = two-digit month (01=January, etc.)
64-
/// <li>DD = two-digit day of month (01 through 31)
65-
/// <li>hh = two digits of hour (00 through 23)
66-
/// <li>mm = two digits of minute (00 through 59)
67-
/// <li>ss = two digits of second (00 through 59)
68-
/// <li>s = one or more digits representing a decimal fraction of a second
69-
/// <li>TZD = time zone designator (Z or +hh:mm or -hh:mm)
62+
/// <li>YYYY = four-digit year</li>
63+
/// <li>MM = two-digit month (01=January, etc.)</li>
64+
/// <li>DD = two-digit day of month (01 through 31)</li>
65+
/// <li>hh = two digits of hour (00 through 23)</li>
66+
/// <li>mm = two digits of minute (00 through 59)</li>
67+
/// <li>ss = two digits of second (00 through 59)</li>
68+
/// <li>s = one or more digits representing a decimal fraction of a second</li>
69+
/// <li>TZD = time zone designator (Z or +hh:mm or -hh:mm)</li>
7070
/// </ul>
7171
/// Note that ISO 8601 does not seem to allow years less than 1000 or greater
7272
/// than 9999. We allow any year, even negative ones. The year is formatted
@@ -77,9 +77,10 @@ private ISO8601Converter()
7777
/// <em>Note:</em> DOES NOT APPLY ANYMORE.
7878
/// Tolerate missing date portion, in case someone foolishly
7979
/// writes a time-only value that way.
80+
/// </p>
8081
/// </remarks>
8182
/// <param name="iso8601String">a date string that is ISO 8601 conform.</param>
82-
/// <returns>Returns a <code>Calendar</code>.</returns>
83+
/// <returns>Returns a <c>XMPDateTime</c>.</returns>
8384
/// <exception cref="iText.Kernel.XMP.XMPException">Is thrown when the string is non-conform.
8485
/// </exception>
8586
public static XMPDateTime Parse(String iso8601String)
@@ -234,34 +235,35 @@ public static XMPDateTime Parse(String iso8601String, XMPDateTime binValue)
234235
return binValue;
235236
}
236237

237-
/// <summary>Converts a <code>Calendar</code> into an ISO 8601 string.</summary>
238+
/// <summary>Converts a <c>XMPDateTime</c> into an ISO 8601 string.</summary>
238239
/// <remarks>
239-
/// Converts a <code>Calendar</code> into an ISO 8601 string.
240+
/// Converts a <c>XMPDateTime</c> into an ISO 8601 string.
240241
/// Format a date according to ISO 8601 and http://www.w3.org/TR/NOTE-datetime:
241242
/// <ul>
242-
/// <li>YYYY
243-
/// <li>YYYY-MM
244-
/// <li>YYYY-MM-DD
245-
/// <li>YYYY-MM-DDThh:mmTZD
246-
/// <li>YYYY-MM-DDThh:mm:ssTZD
247-
/// <li>YYYY-MM-DDThh:mm:ss.sTZD
243+
/// <li>YYYY</li>
244+
/// <li>YYYY-MM</li>
245+
/// <li>YYYY-MM-DD</li>
246+
/// <li>YYYY-MM-DDThh:mmTZD</li>
247+
/// <li>YYYY-MM-DDThh:mm:ssTZD</li>
248+
/// <li>YYYY-MM-DDThh:mm:ss.sTZD</li>
248249
/// </ul>
249250
/// Data fields:
250251
/// <ul>
251-
/// <li>YYYY = four-digit year
252-
/// <li>MM = two-digit month (01=January, etc.)
253-
/// <li>DD = two-digit day of month (01 through 31)
254-
/// <li>hh = two digits of hour (00 through 23)
255-
/// <li>mm = two digits of minute (00 through 59)
256-
/// <li>ss = two digits of second (00 through 59)
257-
/// <li>s = one or more digits representing a decimal fraction of a second
258-
/// <li>TZD = time zone designator (Z or +hh:mm or -hh:mm)
252+
/// <li>YYYY = four-digit year</li>
253+
/// <li>MM = two-digit month (01=January, etc.)</li>
254+
/// <li>DD = two-digit day of month (01 through 31)</li>
255+
/// <li>hh = two digits of hour (00 through 23)</li>
256+
/// <li>mm = two digits of minute (00 through 59)</li>
257+
/// <li>ss = two digits of second (00 through 59)</li>
258+
/// <li>s = one or more digits representing a decimal fraction of a second</li>
259+
/// <li>TZD = time zone designator (Z or +hh:mm or -hh:mm)</li>
259260
/// </ul>
260261
/// <p>
261262
/// <em>Note:</em> ISO 8601 does not seem to allow years less than 1000 or greater than 9999.
262-
/// We allow any year, even negative ones. The year is formatted as "%.4d".<p>
263+
/// We allow any year, even negative ones. The year is formatted as "%.4d".</p><p>
263264
/// <em>Note:</em> Fix for bug 1269463 (silently fix out of range values) included in parsing.
264265
/// The quasi-bogus "time only" values from Photoshop CS are not supported.
266+
/// </p>
265267
/// </remarks>
266268
/// <param name="dateTime">an XMPDateTime-object.</param>
267269
/// <returns>Returns an ISO 8601 string.</returns>

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -273,7 +273,7 @@ public virtual Object Current {
273273
/// <summary>
274274
/// Prepares the next node to return if not already done.
275275
/// </summary>
276-
/// <seealso cref= Iterator#hasNext() </seealso>
276+
/// <seealso cref="IEnumerator.MoveNext"/>
277277
public virtual bool MoveNext() {
278278
// find next node
279279
if (state == ITERATE_NODE) {
@@ -457,7 +457,7 @@ public NodeIteratorChildren(XMPIteratorImpl outerInstance, XMPNode parentNode, s
457457
/// <summary>
458458
/// Prepares the next node to return if not already done.
459459
/// </summary>
460-
/// <seealso cref= Iterator#hasNext() </seealso>
460+
/// <seealso cref="IEnumerator.MoveNext"/>
461461
public override bool MoveNext() {
462462
if (outerInstance.skipSiblings) {
463463
return false;

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

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -101,14 +101,16 @@ public static XMPMeta Parse(Object input, ParseOptions options)
101101
/// Latin-1/ISO-8859-1 can be accepted when the input is a byte stream
102102
/// (some old toolkits versions such packets). The stream is
103103
/// then wrapped in another stream that converts Latin-1 to UTF-8.
104-
/// <p>
104+
/// <para>
105105
/// If control characters shall be fixed, a reader is used that fixes the chars to spaces
106106
/// (if the input is a byte stream is has to be read as character stream).
107-
/// <p>
107+
/// </para>
108+
/// <para>
108109
/// Both options reduce the performance of the parser.
110+
/// </para>
109111
/// </remarks>
110112
/// <param name="input">
111-
/// the input can be an <code>InputStream</code>, a <code>String</code> or
113+
/// the input can be an <c>Stream</c>, a <c>String</c> or
112114
/// a byte buffer containing the XMP packet.
113115
/// </param>
114116
/// <param name="options">the parsing options</param>
@@ -220,30 +222,30 @@ private static XmlDocument ParseXmlFromString(string input, ParseOptions options
220222
/// is parsed (e.g. SVG). The XML parser counted all rdf:RDF and
221223
/// pxmp:XMP_Packet nodes, and kept a pointer to the last one. If there is
222224
/// more than one possible root use PickBestRoot to choose among them.
223-
/// <p>
225+
/// <para>
224226
/// If there is a root node, try to extract the version of the previous XMP
225-
/// toolkit.
226-
/// <p>
227+
/// toolkit.</para>
228+
/// <para>
227229
/// Pick the first x:xmpmeta among multiple root candidates. If there aren't
228230
/// any, pick the first bare rdf:RDF if that is allowed. The returned root is
229231
/// the rdf:RDF child if an x:xmpmeta element was chosen. The search is
230232
/// breadth first, so a higher level candiate is chosen over a lower level
231-
/// one that was textually earlier in the serialized XML.
233+
/// one that was textually earlier in the serialized XML.</para>
232234
/// </remarks>
233235
/// <param name="root">the root of the xml document</param>
234236
/// <param name="xmpmetaRequired">
235237
/// flag if the xmpmeta-tag is still required, might be set
236-
/// initially to <code>true</code>, if the parse option "REQUIRE_XMP_META" is set
238+
/// initially to <c>true</c>, if the parse option "REQUIRE_XMP_META" is set
237239
/// </param>
238240
/// <param name="result">The result array that is filled during the recursive process.
239241
/// </param>
240242
/// <returns>
241-
/// Returns an array that contains the result or <code>null</code>.
243+
/// Returns an array that contains the result or <c>null</c>.
242244
/// The array contains:
243245
/// <ul>
244-
/// <li>[0] - the rdf:RDF-node
245-
/// <li>[1] - an object that is either XMP_RDF or XMP_PLAIN (the latter is decrecated)
246-
/// <li>[2] - the body text of the xpacket-instruction.
246+
/// <li>[0] - the rdf:RDF-node</li>
247+
/// <li>[1] - an object that is either XMP_RDF or XMP_PLAIN (the latter is decrecated)</li>
248+
/// <li>[2] - the body text of the xpacket-instruction.</li>
247249
/// </ul>
248250
/// </returns>
249251
private static Object[] FindRootNode(XmlNode root, bool xmpmetaRequired, Object[] result) {

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

Lines changed: 5 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -522,21 +522,17 @@ public virtual void SetHasValueChild(bool hasValueChild)
522522
}
523523

524524
/// <summary>
525-
/// Sorts the complete datamodel according to the following rules:
526-
/// <ul>
527-
/// <li>Nodes at one level are sorted by name, that is prefix + local name
528-
/// <li>Starting at the root node the children and qualifier are sorted recursively,
529-
/// which the following exceptions.
525+
/// Sorts the complete datamodel according to the rules.
530526
/// </summary>
531527
/// <remarks>
532528
/// Sorts the complete datamodel according to the following rules:
533529
/// <ul>
534-
/// <li>Nodes at one level are sorted by name, that is prefix + local name
530+
/// <li>Nodes at one level are sorted by name, that is prefix + local name</li>
535531
/// <li>Starting at the root node the children and qualifier are sorted recursively,
536-
/// which the following exceptions.
537-
/// <li>Sorting will not be used for arrays.
532+
/// which the following exceptions.</li>
533+
/// <li>Sorting will not be used for arrays.</li>
538534
/// <li>Within qualifier "xml:lang" and/or "rdf:type" stay at the top in that order,
539-
/// all others are sorted.
535+
/// all others are sorted.</li>
540536
/// </ul>
541537
/// </remarks>
542538
public virtual void Sort()

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

Lines changed: 15 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@
3535

3636
namespace iText.Kernel.XMP.Impl
3737
{
38-
/// <summary>Utilities for <code>XMPNode</code>.</summary>
38+
/// <summary>Utilities for <c>XMPNode</c>.</summary>
3939
/// <since>Aug 28, 2006</since>
4040
public sealed class XMPNodeUtils : XMPConst
4141
{
@@ -440,19 +440,17 @@ internal static String SerializeNodeValue(Object value)
440440
}
441441

442442
/// <summary>
443-
/// After processing by ExpandXPath, a step can be of these forms:
444-
/// <ul>
445-
/// <li>qualName - A top level property or struct field.
443+
/// After processing by ExpandXPath, a step can be of certain forms described in documentation.
446444
/// </summary>
447445
/// <remarks>
448446
/// After processing by ExpandXPath, a step can be of these forms:
449447
/// <ul>
450-
/// <li>qualName - A top level property or struct field.
451-
/// <li>[index] - An element of an array.
452-
/// <li>[last()] - The last element of an array.
453-
/// <li>[qualName="value"] - An element in an array of structs, chosen by a field value.
454-
/// <li>[?qualName="value"] - An element in an array, chosen by a qualifier value.
455-
/// <li>?qualName - A general qualifier.
448+
/// <li>qualName - A top level property or struct field.</li>
449+
/// <li>[index] - An element of an array.</li>
450+
/// <li>[last()] - The last element of an array.</li>
451+
/// <li>[qualName="value"] - An element in an array of structs, chosen by a field value.</li>
452+
/// <li>[?qualName="value"] - An element in an array, chosen by a qualifier value.</li>
453+
/// <li>?qualName - A general qualifier.</li>
456454
/// </ul>
457455
/// Find the appropriate child node, resolving aliases, and optionally creating nodes.
458456
/// </remarks>
@@ -785,16 +783,15 @@ internal static void AppendLangItem(XMPNode arrayNode, String itemLang, String i
785783
}
786784

787785
/// <summary>
788-
/// <ol>
789-
/// <li>Look for an exact match with the specific language.
786+
/// Look for an exact match with the specific language.
790787
/// </summary>
791788
/// <remarks>
792-
/// <ol>
793-
/// <li>Look for an exact match with the specific language.
794-
/// <li>If a generic language is given, look for partial matches.
795-
/// <li>Look for an "x-default"-item.
796-
/// <li>Choose the first item.
797-
/// </ol>
789+
/// <ul>
790+
/// <li>Look for an exact match with the specific language.</li>
791+
/// <li>If a generic language is given, look for partial matches.</li>
792+
/// <li>Look for an "x-default"-item.</li>
793+
/// <li>Choose the first item.</li>
794+
/// </ul>
798795
/// </remarks>
799796
/// <param name="arrayNode">the alt text array node</param>
800797
/// <param name="genericLang">the generic language</param>

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -280,8 +280,7 @@ public XMPAliasInfo ResolveAlias(String aliasNS, String aliasProp)
280280
}
281281
}
282282

283-
/// <seealso cref="iText.Kernel.XMP.XMPSchemaRegistry.FindAlias(System.String)"/
284-
/// >
283+
/// <seealso cref="iText.Kernel.XMP.XMPSchemaRegistry.FindAlias(System.String)" />
285284
public XMPAliasInfo FindAlias(String qname)
286285
{
287286
lock (this)
@@ -290,8 +289,7 @@ public XMPAliasInfo FindAlias(String qname)
290289
}
291290
}
292291

293-
/// <seealso cref="iText.Kernel.XMP.XMPSchemaRegistry.FindAliases(System.String)
294-
/// "/>
292+
/// <seealso cref="iText.Kernel.XMP.XMPSchemaRegistry.FindAliases(System.String)"/>
295293
public XMPAliasInfo[] FindAliases(String aliasNS)
296294
{
297295
lock (this)
@@ -316,7 +314,7 @@ public XMPAliasInfo[] FindAliases(String aliasNS)
316314
/// <summary>Associates an alias name with an actual name.</summary>
317315
/// <remarks>
318316
/// Associates an alias name with an actual name.
319-
/// <p>
317+
/// <para>
320318
/// Define a alias mapping from one namespace/property to another. Both
321319
/// property names must be simple names. An alias can be a direct mapping,
322320
/// where the alias and actual have the same data type. It is also possible
@@ -327,6 +325,7 @@ public XMPAliasInfo[] FindAliases(String aliasNS)
327325
/// Note: This method is not locking because only called by registerStandardAliases
328326
/// which is only called by the constructor.
329327
/// Note2: The method is only package-private so that it can be tested with unittests
328+
/// </para>
330329
/// </remarks>
331330
/// <param name="aliasNS">
332331
/// The namespace URI for the alias. Must not be null or the empty
@@ -530,6 +529,7 @@ private ReadOnlyDictionary(IDictionary original) {
530529
/// Return a read only wrapper to an existing dictionary.
531530
/// Any change to the underlying dictionary will be
532531
/// propagated to the read-only wrapper.
532+
/// </summary>
533533
public static ReadOnlyDictionary ReadOnly(IDictionary dictionary) {
534534
return new ReadOnlyDictionary(dictionary);
535535
}

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

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -867,7 +867,7 @@ private void StartOuterRDFDescription(XMPNode schemaNode, int level)
867867
WriteNewline();
868868
}
869869

870-
/// <summary>Write the </rdf:Description> end tag.</summary>
870+
/// <summary>Write the &lt;/rdf:Description&gt; end tag.</summary>
871871
/// <exception cref="System.IO.IOException"/>
872872
private void EndOuterRDFDescription(int level)
873873
{
@@ -1217,10 +1217,10 @@ private void AppendNodeValue(String value, bool forAttribute)
12171217
/// <summary>
12181218
/// A node can be serialized as RDF-Attribute, if it meets the following conditions:
12191219
/// <ul>
1220-
/// <li>is not array item
1221-
/// <li>don't has qualifier
1222-
/// <li>is no URI
1223-
/// <li>is no composite property
1220+
/// <li>is not array item</li>
1221+
/// <li>don't has qualifier</li>
1222+
/// <li>is no URI</li>
1223+
/// <li>is no composite property</li>
12241224
/// </ul>
12251225
/// </summary>
12261226
/// <param name="node">an XMPNode</param>

0 commit comments

Comments
 (0)