Gorgeous and wonderul docs from maarten@alpha-cursus.nl

svn path=/trunk/gtk-sharp/; revision=88754
This commit is contained in:
Miguel de Icaza 2007-11-02 22:14:29 +00:00
parent 6e2e6f6f36
commit 6990e2bbed
5 changed files with 36 additions and 22 deletions

View File

@ -309,11 +309,14 @@
<Parameter Name="color" Type="Gdk.Color&amp;" RefType="ref" />
</Parameters>
<Docs>
<param name="spec">To be added.</param>
<param name="color">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="spec">A <see cref="T:System.String" /> specifying the color.</param>
<param name="color">The <see cref="T:Gdk.Color" /> to fill in.</param>
<summary>Parses a textual specification of a color and fill in the red, green, and blue fields of a <see cref="T:Gdk.Color" /> structure.</summary>
<returns>A <see cref="T:System.Boolean" /> which indicates whether the parsing succeeded.</returns>
<remarks>
<para>The color is not allocated.</para>
<para>The text string can be in any of the forms accepted by XParseColor; these include name for a color from rgb.txt, such as DarkSlateGray, or a hex specification such as #3050b2 or #35b.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="op_Explicit">
@ -349,4 +352,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -668,9 +668,9 @@ public class CellRendererCompletion : CellRendererText
<Docs>
<param name="width">Location to fill in with the fixed width of the widget, or <see langword="null" />.</param>
<param name="height">Location to fill in with the fixed height of the widget, or <see langword="null" />.</param>
<summary>Fills in <parameref name="width" /> and <paramref name="height" /> with the appropriate size.</summary>
<summary>Fills in <paramref name="width" /> and <paramref name="height" /> with the appropriate size.</summary>
<remarks />
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -117,7 +117,7 @@
<Parameters />
<Docs>
<summary>Removes a focus chain.</summary>
<remarks>Removes a focus chain explicitly set with <see cref="M:Gtk.Container.SetFocusChain(GLib.List)" />.</remarks>
<remarks>Removes a focus chain explicitly set with <see cref="M:Gtk.Container.FocusChain" />.</remarks>
</Docs>
</Member>
<Member MemberName="ResizeChildren">
@ -720,4 +720,4 @@ foreach (Widget w in myContainer) {
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -178,7 +178,7 @@
<see langword="true" /> if focus ended up inside <paramref name="widget" />.</returns>
<remarks>
<para>
This method is used by custom <paramref name="widget" /> implementations; if you're writing an app, you'd use <see cref="M:Gtk.Widget.GrabFocus" /> to move the focus to a particular <paramref name="widget" />, and <see cref="M:Gtk.Container.SetFocusChain" /> to change the focus tab order. So you may want to investigate those methods instead.
This method is used by custom <paramref name="widget" /> implementations; if you're writing an app, you'd use <see cref="M:Gtk.Widget.GrabFocus" /> to move the focus to a particular <paramref name="widget" />, and <see cref="M:Gtk.Container.FocusChain" /> to change the focus tab order. So you may want to investigate those methods instead.
</para>
<para>
<see cref="M:Gtk.Widget.ChildFocus" /> is called by containers as the user moves around the window using keyboard shortcuts. <paramref name="direction" /> indicates what kind of motion is taking place (up, down, left, right, tab forward, tab backward). <see cref="M:Gtk.Widget.ChildFocus" /> invokes the <see cref="F:Gtk.Window.FocusActivated" /> event on <see cref="T:Gtk.Widget" />; <paramref name="widgets" /> override the default handler for this event in order to implement appropriate focus behavior.
@ -4853,4 +4853,4 @@ Widgets are required to honor the size allocation they receive; a size request i
<AttributeName>GLib.TypeInitializer(typeof(Gtk.Widget), "ClassInit")</AttributeName>
</Attribute>
</Attributes>
</Type>
</Type>

View File

@ -247,9 +247,20 @@ Any one of the options may be absent. If FAMILY-LIST is absent, then the family_
<Parameters>
</Parameters>
<Docs>
<summary>The size of the font in pango units.</summary>
<value> the size field for the font description in pango units. Returns 0 if the stretch field has not previously been set. Use <see cref="M:Pango.FontDescription.SetFields()" /> to find out if the field was explicitly set or not.</value>
<remarks>There are <see cref="F:Pango.Scale.PangoScale" /> pango units in one device unit - for fonts, font points are the device unit. Therefore, the size of the font in points is <see cref="P:Pango.FontDescription.Size" /> / <see cref="F:Pango.Scale.PangoScale" />.</remarks>
<summary>The size of the font in fractional points.</summary>
<value>
<para>
The size field for the font description scaled by <see cref="F:Pango.Scale.PangoScale" />. Setting this field is in fractional points. When getting the Size the value is either in points or device units. Use <see cref="P:Pango.FontDescription.SizeIsAbsolute" /> to find out which is the case.
</para>
<para>
Returns 0 if the size field has not previously been set. Use <see cref="M:Pango.FontDescription.SetFields()" /> to find out if the field was explicitly set or not.
</para>
</value>
<remarks>
<para>There are <see cref="F:Pango.Scale.PangoScale" /> pango units in one device unit - for fonts, font points are the device unit. Therefore, the size of the font in points is <see cref="P:Pango.FontDescription.Size" /> / <see cref="F:Pango.Scale.PangoScale" />.</para>
<para>Use <see cref="P:Pango.FontDescription.AbsoluteSize" /> if you need to set a particular size in device units</para>
</remarks>
</Docs>
</Member>
<Member MemberName="FamilyStatic">
@ -342,9 +353,9 @@ Any one of the options may be absent. If FAMILY-LIST is absent, then the family_
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Boolean" /></value>
<remarks>To be added</remarks>
<summary>Determines whether the size of the font is in points (not absolute) or device units (absolute).</summary>
<value>a <see cref="T:System.Boolean" />, indicating whether the Size for the FontDescription is in points or device units.</value>
<remarks>See <see cref="P:Pango.FontDescription.Size" /> and <see cref="P:Pango.FontDescription.AbsoluteSize" />.</remarks>
<since version="Gtk# 2.6" />
</Docs>
</Member>
@ -355,11 +366,11 @@ Any one of the options may be absent. If FAMILY-LIST is absent, then the family_
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Double" /></value>
<remarks>To be added</remarks>
<summary>The size of the font in device units.</summary>
<value>A <see cref="T:System.Double" />, the new size in Pango units.</value>
<remarks>There are <see cref="F:Pango.Scale.PangoScale" /> Pango units in one device unit. For an output backend where a device unit is a pixel, an AbsoluteSize value of 10 * <see cref="F:Pango.Scale.PangoScale" /> gives a 10 pixel font.</remarks>
<since version="Gtk# 2.6" />
</Docs>
</Member>
</Members>
</Type>
</Type>