more pango docs

svn path=/trunk/gtk-sharp/; revision=31265
This commit is contained in:
John Luke 2004-07-17 18:05:37 +00:00
parent 38b2f0fd39
commit 8de889da0e
27 changed files with 78 additions and 74 deletions

View file

@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>returns a new <see cref="T:Pango.Analysis" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -56,7 +56,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>The <see cref="T:Pango.Language" /></summary>
<param name="value">an object of type <see cref="T:Pango.Language" /></param>
<returns>an object of type <see cref="T:Pango.Language" /></returns>
<remarks />
@ -71,7 +71,7 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>the <see cref="T:Pango.Font" /></summary>
<param name="value">an object of type <see cref="T:Pango.Font" /></param>
<returns>an object of type <see cref="T:Pango.Font" /></returns>
<remarks />

View file

@ -27,7 +27,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>returns an empty <see cref="T:Pango.AttrClass" /></summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View file

@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Pango.AttrColor" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -11,7 +11,7 @@
<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>Used to represent attributes with a float or double value.</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Pango.AttrFloat" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -27,7 +27,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Returns an empty <see cref="T:Pango.AttrFontDesc" /></summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View file

@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Pango.AttrInt" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Pango.AttrLanguage" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Pango.AttrShape" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -11,7 +11,7 @@
<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>Used to represent attributes with a string value.</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Pango.AttrString" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Pango.Attribute" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -27,7 +27,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Returns an empty <see cref="T:Pango.Color" /></summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View file

@ -11,7 +11,7 @@
<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>Represents a map from ISO-10646 character point to <see cref="T:Pango.CoverageLevel" />.</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>

View file

@ -11,7 +11,7 @@
<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>The <see cref="T:Pango.FT2FontMap" /> is the <see cref="T:Pango.FontMap" /> implementation for FreeType fonts.</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
<Base>
<BaseTypeName>Pango.FontMap</BaseTypeName>

View file

@ -11,7 +11,7 @@
<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>Used to represent a font in a rendering-system-independent matter.</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>

View file

@ -11,7 +11,7 @@
<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>Holds the overall metric information for a font (possibly restricted to a script).</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>

View file

@ -65,13 +65,13 @@
<Parameter Name="attrs_len" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text">a <see cref="T:System.String" /></param>
<param name="level">a <see cref="T:System.Int32" /></param>
<param name="language">a <see cref="T:Pango.Language" /></param>
<param name="log_attrs">a <see cref="T:Pango.LogAttr" /></param>
<summary>Computes a <see cref="T:Pango.LogAttr" /> for each character in <paramref name="text" />.</summary>
<param name="text"> text to process</param>
<param name="level"> embedding level, or -1 if unknown</param>
<param name="language"> language tag</param>
<param name="log_attrs"> array with one PangoLogAttr per character in text, plus one extra, to be filled in</param>
<param name="attrs_len">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
<remarks>The <paramref name="log_attrs" /> array must have one <see cref="T:Pango.LogAttr" /> for each position in text; if text contains N characters, it has N+1 positions, including the last position at the end of the text. text should be an entire paragraph; logical attributes cannot be computed without context (for example you need to see spaces on either side of a word to know the word is a word).</remarks>
</Docs>
</Member>
<Member MemberName="SkipSpace">
@ -96,9 +96,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Default constructor</summary>
<returns>a <see cref="T:Pango.Global" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="ParseWeight">
@ -193,11 +193,15 @@
<Parameter Name="next_paragraph_start" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text">a <see cref="T:System.String" /></param>
<param name="paragraph_delimiter_index">a <see cref="T:System.Int32&amp;" /></param>
<param name="next_paragraph_start">a <see cref="T:System.Int32&amp;" /></param>
<remarks>To be added</remarks>
<summary>Locates a paragraph boundary in <paramref name="text" />.</summary>
<param name="text"> UTF-8 text</param>
<param name="paragraph_delimiter_index"> return location for index of delimiter</param>
<param name="next_paragraph_start"> return location for start of next paragraph</param>
<remarks>
<para>
A boundary is caused by delimiter characters, such as a newline, carriage return, carriage return-newline pair, or Unicode paragraph separator character. The index of the run of delimiters is returned in <paramref name="paragraph_delimiter_index" />. The index of the start of the paragraph (index after all delimiters) is stored in <paramref name="next_paragraph_start" />.
</para>
If no delimiters are found, both <paramref name="paragraph_delimiter_index" /> and <paramref name="next_paragraph_start" /> are filled with the length of text (an index one off the end).</remarks>
</Docs>
</Member>
<Member MemberName="ScanInt">

View file

@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns a new <see cref="T:Pango.GlyphGeometry" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Pango.GlyphInfo" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Pango.GlyphItem" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -11,7 +11,7 @@
<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>Used to store strings of glyphs with geometry and visual attribute information.</summary>
<remarks>To be added</remarks>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Pango.GlyphString" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Pango.GlyphVisAttr" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Pango.IntSet" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -39,9 +39,9 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.IntSet'</returns>
<remarks>To be added</remarks>
<summary>Creates a new <see cref="T:Pango.IntSet" /></summary>
<returns>a new <see cref="T:Pango.IntSet" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Pango.Item" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -11,7 +11,7 @@
<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>The <see cref="T:Pango.LayoutRun" /> structure represents a single run within a <see cref="T:Pango.LayoutLine" />.</summary>
<remarks>It is simply an alternate name for <see cref="T:Pango.GlyphItem" />, present for backwards compatibility. See the <see cref="T:Pango.GlyphItem" /> docs for Ietails on the fields.</remarks>
<remarks>It is simply an alternate name for <see cref="T:Pango.GlyphItem" />, present for backwards compatibility. See the <see cref="T:Pango.GlyphItem" /> docs for details on the fields.</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns a new <see cref="T:Pango.LayoutRun" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">
@ -54,9 +54,9 @@
<ReturnType>Pango.GlyphString</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>the glyphs obtained by shaping the text corresponding to item.</summary>
<returns>an object of type <see cref="T:Pango.GlyphString" /></returns>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="item">
@ -66,9 +66,9 @@
<ReturnType>Pango.Item</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Pango.Item'</returns>
<remarks>To be added</remarks>
<summary>A <see cref="T:Pango.Item" /> that provides information about a segment of text.</summary>
<returns>a <see cref="T:Pango.Item" /></returns>
<remarks />
</Docs>
</Member>
</Members>

View file

@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns an empty <see cref="T:Pango.LogAttr" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Returns a new <see cref="T:Pango.Rectangle" /></summary>
<remarks />
</Docs>
</Member>
<Member MemberName="New">

View file

@ -59,8 +59,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Frees all the resources for this object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="SetTab">
@ -149,10 +149,10 @@
<Parameter Name="locations" Type="System.Int32&amp;" RefType="out" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Gets the an array of alignments and positions.</summary>
<param name="alignments">a <see cref="T:Pango.TabAlign&amp;" /></param>
<param name="locations">a <see cref="T:System.Int32&amp;" /></param>
<remarks>To be added</remarks>
<remarks />
</Docs>
</Member>
<Member MemberName="GetTab">