Improve the documentation

svn path=/trunk/gtk-sharp/; revision=39362
This commit is contained in:
Miguel de Icaza 2005-01-22 22:42:44 +00:00
parent 67e7fc486b
commit a310c8747b

View file

@ -185,9 +185,15 @@
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Creates a new <see cref="T:GLib.Object" /> instance, using the GLib-provided type.</summary> <summary>Creates a new <see cref="T:GLib.Object" /> instance, using the GLib-provided type.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">The <see cref="T:GLib.GType" /> to register with the GLib type system.</param>
<returns>a <see cref="T:GLib.Object" /></returns> <returns>a <see cref="T:GLib.Object" /></returns>
<remarks>This is a constructor used by derivative types of <see cref="T:GLib.Object" /> that would have their own GLib.GType assigned to it. This is not typically used by C# code.</remarks> <remarks>
<para>This is a constructor used by derivative types of <see cref="T:GLib.Object" /> that would have their own GLib.GType assigned to it. This is not typically used by C# code.
</para>
<para>
This is typically used to construct a new object that must be registered with the C-based GObject type system. An <see cref="T:GLib.GType" /> is usually registered from the static constructor for the class.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="TypeName"> <Member MemberName="TypeName">
@ -382,10 +388,17 @@
<Parameter Name="raw" Type="System.IntPtr" /> <Parameter Name="raw" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructs the object from a C-based pointer to the GLib object.</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param> <param name="raw">The pointer to the native C object.</param>
<returns>a <see cref="T:GLib.Object" /></returns> <returns>a <see cref="T:GLib.Object" /></returns>
<remarks>To be added</remarks> <remarks>
<para>
This constructor is used to associate a C-based GLib object with its equivalent object in the managed world.
</para>
<para>
This method is called by the generated classes by the Gtk# framework.
</para>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>