Patch from kerrick@asu.edu to documentation

svn path=/trunk/gtk-sharp/; revision=30202
This commit is contained in:
Miguel de Icaza 2004-06-23 14:45:52 +00:00
parent 5767c36072
commit c199b76a33
4 changed files with 25 additions and 20 deletions

View File

@ -10,7 +10,7 @@
</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>A set of flags used to specify conditions for which an input callback will be triggered. </summary>
<summary>A set of flags used to specify conditions for which an input callback will be triggered.</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
@ -37,7 +37,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The file descriptor has become available for reading. (Or, as is standard in Unix, a socket or pipe was closed at the other end; this is the case if a subsequent read on the file descriptor returns a count of zero.) </summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -49,7 +49,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>The file descriptor has become available for writing. </summary>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -61,7 +61,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>An exception was raised on the file descriptor. </summary>
<remarks>To be added</remarks>
</Docs>
</Member>

View File

@ -7,7 +7,7 @@
</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>Delegate to invoke when a condition becomes true on a file descriptor. </summary>
<remarks>To be added</remarks>
</Docs>
<Base>

View File

@ -29,7 +29,7 @@
<Parameter Name="function" Type="Gtk.Function" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Registers a function to be called when the mainloop is started. </summary>
<param name="function">a <see cref="T:Gtk.Function" /></param>
<remarks>To be added</remarks>
</Docs>
@ -56,11 +56,16 @@
<Parameter Name="argv" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="argc">a <see cref="T:System.Int32&amp;" /></param>
<summary>Initializes Gtk# for operation, probes window system. </summary>
<param name="argc">The number of if arguments. Changed if any arguments were handled.</param>
<param name="argv">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<returns>True if the toolkit initialized correctly, false otherwise. </returns>
<remarks>Aside from the arguments, this function behaves in the same way as <see cref="T:Gtk.Application.InitCheck" />. Br returning whether or not the toolkit initialized correctly, it allows the application to fall back to a non-GUI interface, should the developer be so inclined to write one.
<block subset="none" type="note">
<para>In Gtk# 0.98, this function's second argument is of type <see cref="T:System.String" />, when it should be an "out String[]". Until corrected, this function shall not work as expected.</para>
</block></remarks>
</Docs>
</Member>
<Member MemberName="CheckAbiCheck">

View File

@ -34,14 +34,14 @@
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="source">a <see cref="T:System.Int32" /></param>
<param name="condition">a <see cref="T:Gdk.InputCondition" /></param>
<param name="function">a <see cref="T:Gdk.InputFunction" /></param>
<param name="marshal">a <see cref="T:Gtk.CallbackMarshal" /></param>
<param name="data">a <see cref="T:System.IntPtr" /></param>
<param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param>
<returns>a <see cref="T:System.UInt32" /></returns>
<summary>Registers a function to be called when a condition becomes true on a file descriptor. </summary>
<param name="source">an <see cref="T:System.Int32" />, a file descriptor. </param>
<param name="condition">an <see cref="T:Gdk.InputCondition" />, the condition. </param>
<param name="function">an <see cref="T:Gdk.InputFunction" />, the function to call. </param>
<param name="marshal">a <see cref="T:Gtk.CallbackMarshal" />, the marshaller to use instead of the function (if non-null). </param>
<param name="data">a <see cref="T:System.IntPtr" />, callback data passed to the function. </param>
<param name="destroy">a <see cref="T:Gtk.DestroyNotify" />, the callback function to call with "data" when the input handler is removed, or null. </param>
<returns>a <see cref="T:System.UInt32" />, a unique id for the event source; to be used with <see cref="M:Gtk.Input.Remove" />. </returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -55,8 +55,8 @@
<Parameter Name="input_handler_id" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="input_handler_id">a <see cref="T:System.UInt32" /></param>
<summary>Removes the function with the given id. </summary>
<param name="input_handler_id">a <see cref="T:System.UInt32" /> identifying the function to remove, provided by <see cref="M:Gtk.Input.AddFull" />.</param>
<remarks>To be added</remarks>
</Docs>
</Member>