From 18e36962aac765e0a930176ab414b0a891673ec4 Mon Sep 17 00:00:00 2001 From: Duncan Mak <duncan@mono-cvs.ximian.com> Date: Fri, 18 Jul 2003 06:41:42 +0000 Subject: [PATCH] * en/Pango/Alignment.xml: * en/Pango/AttrTyoe.xml: * en/Pango/CoverageLevel.xml: * en/Pango/Direction.xml: * en/Pango/FontMask.xml: * en/Pango/OTTableType.xml: * en/Pango/Stretch.xml: * en/Pango/Style.xml: * en/Pango/TabAlign.xml: * en/Pango/Underline.xml: * en/Pango/Variant.xml: * en/Pango/Weight.xml: * en/Pango/WrapMode.xml: All enumerations in Pango are documented. svn path=/trunk/gtk-sharp/; revision=16383 --- doc/ChangeLog | 17 ++++++++ doc/en/Pango/Alignment.xml | 28 +++++++++---- doc/en/Pango/AttrType.xml | 76 +++++++++++++++++++++------------- doc/en/Pango/CoverageLevel.xml | 37 ++++++++++++----- doc/en/Pango/Direction.xml | 28 ++++++++----- doc/en/Pango/FontMask.xml | 33 +++++++-------- doc/en/Pango/OTTableType.xml | 14 +++---- doc/en/Pango/Stretch.xml | 61 +++++++++++++++++---------- doc/en/Pango/Style.xml | 21 ++++++---- doc/en/Pango/TabAlign.xml | 18 +++++--- doc/en/Pango/Underline.xml | 33 ++++++++++----- doc/en/Pango/Variant.xml | 17 ++++---- doc/en/Pango/Weight.xml | 37 ++++++++++------- doc/en/Pango/WrapMode.xml | 24 +++++++---- 14 files changed, 283 insertions(+), 161 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index c78c2376f..7496dd1d5 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,20 @@ +2003-07-18 Duncan Mak <duncan@ximian.com> + + * en/Pango/Alignment.xml: + * en/Pango/AttrTyoe.xml: + * en/Pango/CoverageLevel.xml: + * en/Pango/Direction.xml: + * en/Pango/FontMask.xml: + * en/Pango/OTTableType.xml: + * en/Pango/Stretch.xml: + * en/Pango/Style.xml: + * en/Pango/TabAlign.xml: + * en/Pango/Underline.xml: + * en/Pango/Variant.xml: + * en/Pango/Weight.xml: + * en/Pango/WrapMode.xml: All enumerations in Pango are documented. + + 2003-07-17 John Luke <jluke@cfl.rr.com> * en/Gtk/CellRendererMode.xml: documented diff --git a/doc/en/Pango/Alignment.xml b/doc/en/Pango/Alignment.xml index db7a632c9..0a06e4df5 100644 --- a/doc/en/Pango/Alignment.xml +++ b/doc/en/Pango/Alignment.xml @@ -1,5 +1,5 @@ <Type Name="Alignment" FullName="Pango.Alignment"> - <TypeSignature Language="C#" Maintainer="auto" Value="public enum Alignment;" /> + <TypeSignature Language="C#" Maintainer="duncan" Value="public enum Alignment;" /> <AssemblyInfo> <AssemblyName>pango-sharp</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> @@ -7,8 +7,18 @@ </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + Describes how to align the lines of a <see cref="T:Pango.Layout"/> + </summary> + <remarks> + <para> + This enumeration describes how to align the lines of a + <see cref="T:Gtk.Pango.Layout" /> within the available space. If the <see + cref="T:Pango.Layout" /> is set to justify using + <see cref="P:Pango.Layout" /> property, then this only has an effect for + partial lines. + </para> + </remarks> </Docs> <Base> <BaseTypeName>System.Enum</BaseTypeName> @@ -34,8 +44,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Put all available space on the left</summary> + <remarks /> </Docs> </Member> <Member MemberName="Center"> @@ -46,8 +56,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Center the line within the available space</summary> + <remarks /> </Docs> </Member> <Member MemberName="Right"> @@ -58,8 +68,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Put all available space on the right</summary> + <remarks /> </Docs> </Member> <Member MemberName="value__"> diff --git a/doc/en/Pango/AttrType.xml b/doc/en/Pango/AttrType.xml index 0e2e159eb..7f8ecf0e1 100644 --- a/doc/en/Pango/AttrType.xml +++ b/doc/en/Pango/AttrType.xml @@ -1,5 +1,5 @@ <Type Name="AttrType" FullName="Pango.AttrType"> - <TypeSignature Language="C#" Maintainer="auto" Value="public enum AttrType;" /> + <TypeSignature Language="C#" Maintainer="duncan" Value="public enum AttrType;" /> <AssemblyInfo> <AssemblyName>pango-sharp</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> @@ -8,7 +8,16 @@ <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> <summary>To be added</summary> - <remarks>To be added</remarks> + <remarks> + <para> + This enumeration is used to distinguish between different + types of attributes. Along with the predefined values, it is + possible to allocate additional values for custom attributes + using <see cref="M:Pango.Attr.TypeRegister(System.String)" />. The predefined values are + given below. The type of structure used to store the attribute + is listed in parentheses after the description. + </para> + </remarks> </Docs> <Base> <BaseTypeName>System.Enum</BaseTypeName> @@ -34,8 +43,10 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Invalid</summary> + <remarks> + <para>This marks it as an invalid attribute</para> + </remarks> </Docs> </Member> <Member MemberName="Language"> @@ -46,8 +57,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Language (<see cref="T:Pango.AttrLanguage"/>)</summary> + <remarks /> </Docs> </Member> <Member MemberName="Family"> @@ -58,8 +69,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Font family name list (<see cref="T:Pango.AttrFamily" />)</summary> + <remarks /> </Docs> </Member> <Member MemberName="Style"> @@ -70,8 +81,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Font slant style (<see cref="T:Pango.AttrInt" />)</summary> + <remarks /> </Docs> </Member> <Member MemberName="Weight"> @@ -82,8 +93,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Font weight (<see cref="T:Pango.AttrInt" />)</summary> + <remarks /> </Docs> </Member> <Member MemberName="Variant"> @@ -94,8 +105,10 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + Font variant (normal or small caps) (<see cref="T:Pango.AttrInt" />) + </summary> + <remarks /> </Docs> </Member> <Member MemberName="Stretch"> @@ -106,7 +119,7 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> + <summary>Font stretch (<see cref="T:Pango.AttrInt" />)</summary> <remarks>To be added</remarks> </Docs> </Member> @@ -118,7 +131,10 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> + <summary> + Font size in points divided by <see cref="T:Pango.Scale" /> + (<see cref="T:Pango.AttrInt" />) + </summary> <remarks>To be added</remarks> </Docs> </Member> @@ -130,8 +146,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Font description (<see cref="T:Pango.AttrFontDesc" />)</summary> + <remarks /> </Docs> </Member> <Member MemberName="Foreground"> @@ -142,8 +158,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Foreground color (<see cref="T:Pango.AttrColor" />)</summary> + <remarks /> </Docs> </Member> <Member MemberName="Background"> @@ -154,8 +170,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Background color (<see cref="T:Pango.AttrColor" />)</summary> + <remarks /> </Docs> </Member> <Member MemberName="Underline"> @@ -166,7 +182,7 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> + <summary>Whether the text has an underline (<see cref="T:Pango.AttrInt" />)</summary> <remarks>To be added</remarks> </Docs> </Member> @@ -178,7 +194,7 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> + <summary>Whether the text has an struck-through (<see cref="T:Pango.AttrInt" />)</summary> <remarks>To be added</remarks> </Docs> </Member> @@ -190,8 +206,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Baseline displacement (<see cref="T:Pango.AttrInt" />)</summary> + <remarks /> </Docs> </Member> <Member MemberName="Shape"> @@ -202,8 +218,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Shape (<see cref="T:Pango.AttrShape" />)</summary> + <remarks /> </Docs> </Member> <Member MemberName="Scale"> @@ -214,7 +230,9 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> + <summary> + Font size scale factor (<see cref="T:Pango.AttrScale"/>) + </summary> <remarks>To be added</remarks> </Docs> </Member> diff --git a/doc/en/Pango/CoverageLevel.xml b/doc/en/Pango/CoverageLevel.xml index 55ead0e9f..05244a905 100644 --- a/doc/en/Pango/CoverageLevel.xml +++ b/doc/en/Pango/CoverageLevel.xml @@ -1,5 +1,5 @@ <Type Name="CoverageLevel" FullName="Pango.CoverageLevel"> - <TypeSignature Language="C#" Maintainer="auto" Value="public enum CoverageLevel;" /> + <TypeSignature Language="C#" Maintainer="duncan" Value="public enum CoverageLevel;" /> <AssemblyInfo> <AssemblyName>pango-sharp</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> @@ -7,8 +7,8 @@ </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Used to indicate how well a font can represent a particular ISO 10646 character point for a particular scrpt</summary> + <remarks /> </Docs> <Base> <BaseTypeName>System.Enum</BaseTypeName> @@ -34,8 +34,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The character is not representable with the font</summary> + <remarks /> </Docs> </Member> <Member MemberName="Fallback"> @@ -46,8 +46,19 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + The character is represented in a way that may be + comprehensible but is not the correct graphical + form + </summary> + <remarks> + <para> + The character is represented in a way that may be + comprehensible but is not the correct graphical form. For + instance, a Hangul character represented as a a sequence + of Jamos, or a Latin transliteration of a Cyrillic word. + </para> + </remarks> </Docs> </Member> <Member MemberName="Approximate"> @@ -58,8 +69,12 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + The character is represented as basically the correct + graphical form, but with a stylistic variant inappropriate + for the current script + </summary> + <remarks /> </Docs> </Member> <Member MemberName="Exact"> @@ -70,8 +85,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The character is represented as the correct graphical form.</summary> + <remarks /> </Docs> </Member> <Member MemberName="value__"> diff --git a/doc/en/Pango/Direction.xml b/doc/en/Pango/Direction.xml index 0c353250a..0f11422fd 100644 --- a/doc/en/Pango/Direction.xml +++ b/doc/en/Pango/Direction.xml @@ -1,5 +1,5 @@ <Type Name="Direction" FullName="Pango.Direction"> - <TypeSignature Language="C#" Maintainer="auto" Value="public enum Direction;" /> + <TypeSignature Language="C#" Maintainer="duncan" Value="public enum Direction;" /> <AssemblyInfo> <AssemblyName>pango-sharp</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> @@ -7,8 +7,8 @@ </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Represents the direction of writing for text</summary> + <remarks /> </Docs> <Base> <BaseTypeName>System.Enum</BaseTypeName> @@ -34,8 +34,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The text is written left-to-right</summary> + <remarks /> </Docs> </Member> <Member MemberName="Rtl"> @@ -46,8 +46,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The text is written right-to-left</summary> + <remarks /> </Docs> </Member> <Member MemberName="TtbLtr"> @@ -58,8 +58,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + The text is written vertically top-to-bottom, with the rows + ordered from left to right + </summary> + <remarks /> </Docs> </Member> <Member MemberName="TtbRtl"> @@ -70,8 +73,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + The text is written vertically top-to-bottom, with the rows + ordered from right to left + </summary> + <remarks /> </Docs> </Member> <Member MemberName="value__"> diff --git a/doc/en/Pango/FontMask.xml b/doc/en/Pango/FontMask.xml index 823e8ec21..f5108ca58 100644 --- a/doc/en/Pango/FontMask.xml +++ b/doc/en/Pango/FontMask.xml @@ -1,5 +1,5 @@ <Type Name="FontMask" FullName="Pango.FontMask"> - <TypeSignature Language="C#" Maintainer="auto" Value="public enum FontMask;" /> + <TypeSignature Language="C#" Maintainer="duncan" Value="public enum FontMask;" /> <AssemblyInfo> <AssemblyName>pango-sharp</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> @@ -7,8 +7,8 @@ </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>TThe bits in a PangoFontMask correspond to fields in a PangoFontDescription that have been set.</summary> + <remarks /> </Docs> <Base> <BaseTypeName>System.Enum</BaseTypeName> @@ -34,8 +34,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The font family is specified</summary> + <remarks /> </Docs> </Member> <Member MemberName="Style"> @@ -46,8 +46,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The font style is specified</summary> + <remarks /> </Docs> </Member> <Member MemberName="Variant"> @@ -58,8 +58,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The font variant is specified</summary> + <remarks /> </Docs> </Member> <Member MemberName="Weight"> @@ -70,8 +70,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The font weight is specified</summary> + <remarks /> </Docs> </Member> <Member MemberName="Stretch"> @@ -82,8 +82,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The font stretch is specified</summary> + <remarks /> </Docs> </Member> <Member MemberName="Size"> @@ -94,11 +94,10 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The font size is specified</summary> + <remarks /> </Docs> - </Member> - <Member MemberName="value__"> + </Member> <Member MemberName="value__"> <MemberSignature Language="C#" Value="value__" /> <MemberType>Field</MemberType> <ReturnValue> diff --git a/doc/en/Pango/OTTableType.xml b/doc/en/Pango/OTTableType.xml index ca6eff1f2..bff63b570 100644 --- a/doc/en/Pango/OTTableType.xml +++ b/doc/en/Pango/OTTableType.xml @@ -1,5 +1,5 @@ <Type Name="OTTableType" FullName="Pango.OTTableType"> - <TypeSignature Language="C#" Maintainer="auto" Value="public enum OTTableType;" /> + <TypeSignature Language="C#" Maintainer="duncan" Value="public enum OTTableType;" /> <AssemblyInfo> <AssemblyName>pango-sharp</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> @@ -7,8 +7,8 @@ </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The values of this enumeration are used to identify the various OpenType tables</summary> + <remarks /> </Docs> <Base> <BaseTypeName>System.Enum</BaseTypeName> @@ -34,8 +34,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The GSUB table</summary> + <remarks /> </Docs> </Member> <Member MemberName="Gpos"> @@ -46,8 +46,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The GPOS table</summary> + <remarks /> </Docs> </Member> <Member MemberName="value__"> diff --git a/doc/en/Pango/Stretch.xml b/doc/en/Pango/Stretch.xml index ef9a6860b..ca032c86b 100644 --- a/doc/en/Pango/Stretch.xml +++ b/doc/en/Pango/Stretch.xml @@ -1,5 +1,5 @@ <Type Name="Stretch" FullName="Pango.Stretch"> - <TypeSignature Language="C#" Maintainer="auto" Value="public enum Stretch;" /> + <TypeSignature Language="C#" Maintainer="duncan" Value="public enum Stretch;" /> <AssemblyInfo> <AssemblyName>pango-sharp</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> @@ -7,8 +7,11 @@ </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + An enumeration specifying the width of the font relatives to + other designs with the font family + </summary> + <remarks /> </Docs> <Base> <BaseTypeName>System.Enum</BaseTypeName> @@ -34,8 +37,10 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + 4x more condensed than <see cref="T:Pango.Stretch.Normal" /> + </summary> + <remarks /> </Docs> </Member> <Member MemberName="ExtraCondensed"> @@ -46,8 +51,10 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + 3x more condensed than <see cref="T:Pango.Stretch.Normal" /> + </summary> + <remarks /> </Docs> </Member> <Member MemberName="Condensed"> @@ -58,8 +65,10 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + 2x more condensed than <see cref="T:Pango.Stretch.Normal" /> + </summary> + <remarks /> </Docs> </Member> <Member MemberName="SemiCondensed"> @@ -70,8 +79,10 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + 1x more condensed than <see cref="T:Pango.Stretch.Normal" /> + </summary> + <remarks /> </Docs> </Member> <Member MemberName="Normal"> @@ -82,8 +93,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The normal width</summary> + <remarks /> </Docs> </Member> <Member MemberName="SemiExpanded"> @@ -94,8 +105,10 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + 1x more expanded than <see cref="T:Pango.Stretch.Normal" /> + </summary> + <remarks /> </Docs> </Member> <Member MemberName="Expanded"> @@ -106,8 +119,10 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + 2x more expanded than <see cref="T:Pango.Stretch.Normal" /> + </summary> + <remarks /> </Docs> </Member> <Member MemberName="ExtraExpanded"> @@ -118,8 +133,10 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + 3x more expanded than <see cref="T:Pango.Stretch.Normal" /> + </summary> + <remarks /> </Docs> </Member> <Member MemberName="UltraExpanded"> @@ -130,8 +147,10 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + 3x more expanded than <see cref="T:Pango.Stretch.Normal" /> + </summary> + <remarks /> </Docs> </Member> <Member MemberName="value__"> diff --git a/doc/en/Pango/Style.xml b/doc/en/Pango/Style.xml index 8969bb42c..2fc9fc300 100644 --- a/doc/en/Pango/Style.xml +++ b/doc/en/Pango/Style.xml @@ -1,5 +1,5 @@ <Type Name="Style" FullName="Pango.Style"> - <TypeSignature Language="C#" Maintainer="auto" Value="public enum Style;" /> + <TypeSignature Language="C#" Maintainer="duncan" Value="public enum Style;" /> <AssemblyInfo> <AssemblyName>pango-sharp</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> @@ -7,8 +7,11 @@ </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + An enumeration specific the various saltn styles possible for a + font + </summary> + <remarks /> </Docs> <Base> <BaseTypeName>System.Enum</BaseTypeName> @@ -34,8 +37,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The font is upright</summary> + <remarks /> </Docs> </Member> <Member MemberName="Oblique"> @@ -46,8 +49,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The font is slanted, but in a roman style</summary> + <remarks /> </Docs> </Member> <Member MemberName="Italic"> @@ -58,8 +61,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The font is slanted in an italic style</summary> + <remarks /> </Docs> </Member> <Member MemberName="value__"> diff --git a/doc/en/Pango/TabAlign.xml b/doc/en/Pango/TabAlign.xml index add440448..d5c1936ab 100644 --- a/doc/en/Pango/TabAlign.xml +++ b/doc/en/Pango/TabAlign.xml @@ -1,5 +1,5 @@ <Type Name="TabAlign" FullName="Pango.TabAlign"> - <TypeSignature Language="C#" Maintainer="auto" Value="public enum TabAlign;" /> + <TypeSignature Language="C#" Maintainer="duncan" Value="public enum TabAlign;" /> <AssemblyInfo> <AssemblyName>pango-sharp</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> @@ -7,8 +7,16 @@ </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + This enumeration specifies where a tab stop appears relative to + the text + </summary> + <remarks> + <para> + Right now, there is only one value in this enumeration. In + the future, Right, Center and Numeric may be supported. + </para> + </remarks> </Docs> <Base> <BaseTypeName>System.Enum</BaseTypeName> @@ -34,8 +42,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The tab stop appears to the left of the text</summary> + <remarks /> </Docs> </Member> <Member MemberName="value__"> diff --git a/doc/en/Pango/Underline.xml b/doc/en/Pango/Underline.xml index d3555fb1b..74ae7e8dd 100644 --- a/doc/en/Pango/Underline.xml +++ b/doc/en/Pango/Underline.xml @@ -1,5 +1,5 @@ <Type Name="Underline" FullName="Pango.Underline"> - <TypeSignature Language="C#" Maintainer="auto" Value="public enum Underline;" /> + <TypeSignature Language="C#" Maintainer="duncan" Value="public enum Underline;" /> <AssemblyInfo> <AssemblyName>pango-sharp</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> @@ -7,7 +7,10 @@ </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> - <summary>To be added</summary> + <summary> + This enumeration is used to specify whether text should be + underlined, and if so, the type of underlining + </summary> <remarks>To be added</remarks> </Docs> <Base> @@ -34,8 +37,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>No underline should be drawn</summary> + <remarks /> </Docs> </Member> <Member MemberName="Single"> @@ -46,8 +49,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>A single underline should be drawn</summary> + <remarks /> </Docs> </Member> <Member MemberName="Double"> @@ -58,8 +61,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>A double underline should be drawn</summary> + <remarks /> </Docs> </Member> <Member MemberName="Low"> @@ -70,8 +73,18 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + A single underline should be drawn at a position beneath the + ink extedn of the text being underlined + </summary> + <remarks> + <para> + This should be used only for underlining single + characters, such as for keyboard accelerators. + <see cref="T:Pango.Underline.Single" /> should be used for + extended portions of text + </para> + </remarks> </Docs> </Member> <Member MemberName="value__"> diff --git a/doc/en/Pango/Variant.xml b/doc/en/Pango/Variant.xml index 084e90eca..943e9723d 100644 --- a/doc/en/Pango/Variant.xml +++ b/doc/en/Pango/Variant.xml @@ -1,5 +1,5 @@ <Type Name="Variant" FullName="Pango.Variant"> - <TypeSignature Language="C#" Maintainer="auto" Value="public enum Variant;" /> + <TypeSignature Language="C#" Maintainer="duncan" Value="public enum Variant;" /> <AssemblyInfo> <AssemblyName>pango-sharp</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> @@ -7,8 +7,8 @@ </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>An enumeration specifying capitalization variant of the font</summary> + <remarks /> </Docs> <Base> <BaseTypeName>System.Enum</BaseTypeName> @@ -34,8 +34,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>A normal font</summary> + <remarks /> </Docs> </Member> <Member MemberName="SmallCaps"> @@ -46,8 +46,11 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + A font with the lower case characters replaced by smaller + variants of the capital letters + </summary> + <remarks /> </Docs> </Member> <Member MemberName="value__"> diff --git a/doc/en/Pango/Weight.xml b/doc/en/Pango/Weight.xml index 12c922937..f194ddacf 100644 --- a/doc/en/Pango/Weight.xml +++ b/doc/en/Pango/Weight.xml @@ -1,5 +1,5 @@ <Type Name="Weight" FullName="Pango.Weight"> - <TypeSignature Language="C#" Maintainer="auto" Value="public enum Weight;" /> + <TypeSignature Language="C#" Maintainer="duncan" Value="public enum Weight;" /> <AssemblyInfo> <AssemblyName>pango-sharp</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> @@ -7,8 +7,13 @@ </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>An enumeration specifying the weight (boldness) of a font</summary> + <remarks> + <para> + This is a numerical value ranging from 100 to 900, but there + are two predefined values. + </para> + </remarks> </Docs> <Base> <BaseTypeName>System.Enum</BaseTypeName> @@ -34,8 +39,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The ultralight weight (200)</summary> + <remarks /> </Docs> </Member> <Member MemberName="Light"> @@ -46,8 +51,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The light weight (300)</summary> + <remarks /> </Docs> </Member> <Member MemberName="Normal"> @@ -58,8 +63,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The default weight (400)</summary> + <remarks /> </Docs> </Member> <Member MemberName="Bold"> @@ -70,8 +75,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The bold weight (700)</summary> + <remarks /> </Docs> </Member> <Member MemberName="Ultrabold"> @@ -82,8 +87,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The ultrabold weight (800)</summary> + <remarks /> </Docs> </Member> <Member MemberName="Heavy"> @@ -94,8 +99,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>The heavy weight (900)</summary> + <remarks /> </Docs> </Member> <Member MemberName="value__"> @@ -111,4 +116,4 @@ </Docs> </Member> </Members> -</Type> \ No newline at end of file +</Type>n \ No newline at end of file diff --git a/doc/en/Pango/WrapMode.xml b/doc/en/Pango/WrapMode.xml index 8d57c3437..b00e81653 100644 --- a/doc/en/Pango/WrapMode.xml +++ b/doc/en/Pango/WrapMode.xml @@ -1,5 +1,5 @@ <Type Name="WrapMode" FullName="Pango.WrapMode"> - <TypeSignature Language="C#" Maintainer="auto" Value="public enum WrapMode;" /> + <TypeSignature Language="C#" Maintainer="duncan" Value="public enum WrapMode;" /> <AssemblyInfo> <AssemblyName>pango-sharp</AssemblyName> <AssemblyVersion>0.0.0.0</AssemblyVersion> @@ -7,8 +7,11 @@ </AssemblyInfo> <ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + Describes how to wrap the lines of a <see cref="T:Pango.Layout"/> + to the desired width + </summary> + <remarks /> </Docs> <Base> <BaseTypeName>System.Enum</BaseTypeName> @@ -34,8 +37,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Wrap lines at word boundaries</summary> + <remarks /> </Docs> </Member> <Member MemberName="Char"> @@ -46,8 +49,8 @@ </ReturnValue> <Parameters /> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary>Wrap line at character boundaries</summary> + <remarks /> </Docs> </Member> <Member MemberName="value__"> @@ -70,8 +73,11 @@ </ReturnValue> <Parameters></Parameters> <Docs> - <summary>To be added</summary> - <remarks>To be added</remarks> + <summary> + Wrap line at word boundaries, but fall back to character + boundaries if there is not enough space for a full word + </summary> + <remarks /> </Docs> </Member> </Members>