From f0b7ccb6079389ab5940fe356c8ac915bd30bd2b Mon Sep 17 00:00:00 2001 From: GoldenCrystal Date: Tue, 16 Dec 2014 02:48:50 +0100 Subject: [PATCH] =?UTF-8?q?Xml=20documentation=E2=80=A6=20Done!?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .../CompatibilityFormattingTag.cs | 51 +++++++++++++------ UnicodeInformation/ContributoryProperties.cs | 1 + UnicodeInformation/CoreProperties.cs | 21 ++++++++ .../UnicodeCrossReferenceCollection.cs | 1 + UnicodeInformation/UnicodeNameAliasKind.cs | 6 +++ 5 files changed, 64 insertions(+), 16 deletions(-) diff --git a/UnicodeInformation/CompatibilityFormattingTag.cs b/UnicodeInformation/CompatibilityFormattingTag.cs index 4fe821d..045bf87 100644 --- a/UnicodeInformation/CompatibilityFormattingTag.cs +++ b/UnicodeInformation/CompatibilityFormattingTag.cs @@ -7,40 +7,59 @@ using System.Threading.Tasks; namespace System.Unicode { + /// Provides information on the kind of compatibility decomposition provided. + /// The default value of indicates canonical decomposition of the code point. public enum CompatibilityFormattingTag : byte { + /// Canonical form. Canonical = 0, - [ValueName("font"), Display(Name = "font", Description = "Font variant (for example, a blackletter form)")] + /// Font variant (for example, a blackletter form). + [ValueName("font"), Display(Name = "font", Description = "Font variant (for example, a blackletter form).")] Font, - [ValueName("noBreak"), Display(Name = "noBreak", Description = "No-break version of a space or hyphen")] + /// No-break version of a space or hyphen. + [ValueName("noBreak"), Display(Name = "noBreak", Description = "No-break version of a space or hyphen.")] NoBreak, - [ValueName("initial"), Display(Name = "initial", Description = "Initial presentation form (Arabic)")] + /// Initial presentation form (Arabic). + [ValueName("initial"), Display(Name = "initial", Description = "Initial presentation form (Arabic).")] Initial, - [ValueName("medial"), Display(Name = "medial", Description = "Medial presentation form (Arabic)")] + /// Medial presentation form (Arabic). + [ValueName("medial"), Display(Name = "medial", Description = "Medial presentation form (Arabic).")] Medial, - [ValueName("final"), Display(Name = "final", Description = "Final presentation form (Arabic)")] + /// Final presentation form (Arabic). + [ValueName("final"), Display(Name = "final", Description = "Final presentation form (Arabic).")] Final, - [ValueName("isolated"), Display(Name = "isolated", Description = "Isolated presentation form (Arabic)")] + /// Isolated presentation form (Arabic). + [ValueName("isolated"), Display(Name = "isolated", Description = "Isolated presentation form (Arabic).")] Isolated, - [ValueName("circle"), Display(Name = "circle", Description = "Encircled form")] + /// Encircled form. + [ValueName("circle"), Display(Name = "circle", Description = "Encircled form.")] Circle, - [ValueName("super"), Display(Name = "super", Description = "Superscript form")] + /// Superscript form. + [ValueName("super"), Display(Name = "super", Description = "Superscript form.")] Super, - [ValueName("sub"), Display(Name = "sub", Description = "Subscript form")] + /// Subscript form. + [ValueName("sub"), Display(Name = "sub", Description = "Subscript form.")] Sub, - [ValueName("vertical"), Display(Name = "vertical", Description = "Vertical layout presentation form")] + /// Vertical layout presentation form. + [ValueName("vertical"), Display(Name = "vertical", Description = "Vertical layout presentation form.")] Vertical, - [ValueName("wide"), Display(Name = "wide", Description = "Wide (or zenkaku) compatibility character")] + /// Wide (or zenkaku) compatibility character. + [ValueName("wide"), Display(Name = "wide", Description = "Wide (or zenkaku) compatibility character.")] Wide, - [ValueName("narrow"), Display(Name = "narrow", Description = "Narrow (or hankaku) compatibility character")] + /// Narrow (or hankaku) compatibility character. + [ValueName("narrow"), Display(Name = "narrow", Description = "Narrow (or hankaku) compatibility character.")] Narrow, - [ValueName("small"), Display(Name = "small", Description = "Small variant form (CNS compatibility)")] + /// Small variant form (CNS compatibility). + [ValueName("small"), Display(Name = "small", Description = "Small variant form (CNS compatibility).")] Small, - [ValueName("square"), Display(Name = "square", Description = "CJK squared font variant")] + /// CJK squared font variant. + [ValueName("square"), Display(Name = "square", Description = "CJK squared font variant.")] Square, - [ValueName("fraction"), Display(Name = "fraction", Description = "Vulgar fraction form")] + /// Vulgar fraction form. + [ValueName("fraction"), Display(Name = "fraction", Description = "Vulgar fraction form.")] Fraction, - [ValueName("compat"), Display(Name = "compat", Description = "Otherwise unspecified compatibility character")] + /// Otherwise unspecified compatibility character. + [ValueName("compat"), Display(Name = "compat", Description = "Otherwise unspecified compatibility character.")] Compat, } } diff --git a/UnicodeInformation/ContributoryProperties.cs b/UnicodeInformation/ContributoryProperties.cs index 88061a5..7947a2a 100644 --- a/UnicodeInformation/ContributoryProperties.cs +++ b/UnicodeInformation/ContributoryProperties.cs @@ -8,6 +8,7 @@ using System.Threading.Tasks; namespace System.Unicode { /// A bitmask of the various available contributory properties. + /// As per the standard, contributory properties are neither normative nor informative, but are used to derive . [Flags] public enum ContributoryProperties : int { diff --git a/UnicodeInformation/CoreProperties.cs b/UnicodeInformation/CoreProperties.cs index e569a6f..6f5aa78 100644 --- a/UnicodeInformation/CoreProperties.cs +++ b/UnicodeInformation/CoreProperties.cs @@ -7,45 +7,66 @@ using System.Threading.Tasks; namespace System.Unicode { + /// A bitmask of the various available core properties. + /// Core properties are normative, and derived from various properties as well as . [Flags] public enum CoreProperties : int { + /// Represents the Lowercase property. [ValueName("Lowercase"), ValueName("Lower"), Display(Name = "Lowercase")] Lowercase = 0x00000001, + /// Represents the Uppercase property. [ValueName("Uppercase"), ValueName("Upper"), Display(Name = "Uppercase")] Uppercase = 0x00000002, + /// Represents the Cased property. [ValueName("Cased"), Display(Name = "Cased")] Cased = 0x00000004, + /// Represents the Case_Ignorable property. [ValueName("Case_Ignorable"), ValueName("CI"), Display(Name = "Case_Ignorable")] CaseIgnorable = 0x00000008, + /// Represents the Changes_When_Lowercased property. [ValueName("Changes_When_Lowercased"), ValueName("CWL"), Display(Name = "Changes_When_Lowercased")] ChangesWhenLowercased = 0x00000010, + /// Represents the Changes_When_Uppercased property. [ValueName("Changes_When_Uppercased"), ValueName("CWU"), Display(Name = "Changes_When_Uppercased")] ChangesWhenUppercased = 0x00000020, + /// Represents the Changes_When_Titlecased property. [ValueName("Changes_When_Titlecased"), ValueName("CWT"), Display(Name = "Changes_When_Titlecased")] ChangesWhenTitlecased = 0x00000040, + /// Represents the Changes_When_Casefolded property. [ValueName("Changes_When_Casefolded"), ValueName("CWCF"), Display(Name = "Changes_When_Casefolded")] ChangesWhenCasefolded = 0x00000080, + /// Represents the Changes_When_Casemapped property. [ValueName("Changes_When_Casemapped"), ValueName("CWCM"), Display(Name = "Changes_When_Casemapped")] ChangesWhenCasemapped = 0x00000100, + /// Represents the Alphabetic property. [ValueName("Alphabetic"), ValueName("Alpha"), Display(Name = "Alphabetic")] Alphabetic = 0x00000200, + /// Represents the Default_Ignorable_Code_Point property. [ValueName("Default_Ignorable_Code_Point"), ValueName("DI"), Display(Name = "Default_Ignorable_Code_Point")] DefaultIgnorableCodePoint = 0x00000400, + /// Represents the Grapheme_Base property. [ValueName("Grapheme_Base"), ValueName("Gr_Base"), Display(Name = "Grapheme_Base")] GraphemeBase = 0x00000800, + /// Represents the Grapheme_Extend property. [ValueName("Grapheme_Extend"), ValueName("Gr_Ext"), Display(Name = "Grapheme_Extend")] GraphemeExtend = 0x00001000, + /// Represents the Grapheme_Link property. [ValueName("Grapheme_Link"), ValueName("Gr_Link"), Display(Name = "Grapheme_Link")] GraphemeLink = 0x00002000, + /// Represents the Math property. [ValueName("Math"), Display(Name = "Math")] Math = 0x00004000, + /// Represents the ID_Start property. [ValueName("ID_Start"), ValueName("IDS"), Display(Name = "ID_Start")] IdentifierStart = 0x00008000, + /// Represents the ID_Continue property. [ValueName("ID_Continue"), ValueName("IDC"), Display(Name = "ID_Continue")] IdentifierContinue = 0x00010000, + /// Represents the XID_Start property. [ValueName("XID_Start"), ValueName("XIDS"), Display(Name = "XID_Start")] ExtendedIdentifierStart = 0x00020000, + /// Represents the XID_Continue property. [ValueName("XID_Continue"), ValueName("XIDC"), Display(Name = "XID_Continue")] ExtendedIdentifierContinue = 0x00040000, } diff --git a/UnicodeInformation/UnicodeCrossReferenceCollection.cs b/UnicodeInformation/UnicodeCrossReferenceCollection.cs index 295d942..7567d59 100644 --- a/UnicodeInformation/UnicodeCrossReferenceCollection.cs +++ b/UnicodeInformation/UnicodeCrossReferenceCollection.cs @@ -7,6 +7,7 @@ using System.Threading.Tasks; namespace System.Unicode { + /// Represents a collection of code point cross-references. public struct UnicodeCrossReferenceCollection : IList { private static int[] EmptyArray = new int[0]; diff --git a/UnicodeInformation/UnicodeNameAliasKind.cs b/UnicodeInformation/UnicodeNameAliasKind.cs index bd5568b..83b6b3f 100644 --- a/UnicodeInformation/UnicodeNameAliasKind.cs +++ b/UnicodeInformation/UnicodeNameAliasKind.cs @@ -1,15 +1,21 @@ namespace System.Unicode { + /// Provides information on the kind of name alias provided for a code point. public enum UnicodeNameAliasKind : byte { + /// The alias is a correction of a serious problem in the original name. [ValueName("correction")] Correction = 1, + /// The alias provides the ISO 6429 name for C0 and C1 control functions of a control code, or another commonly occurring name for the control code. [ValueName("control")] Control = 2, + /// The alias is a widely used alternate name for a format character. [ValueName("alternate")] Alternate = 3, + /// The alias is a documented non-standardized label for C1 control code points. [ValueName("figment")] Figment = 4, + /// The alias is a commonly occurring abbreviation (or acronym) for control codes, format characters, spaces, and variation selectors. [ValueName("abbreviation")] Abbreviation = 5 }