mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-12-23 15:45:28 +00:00
Update docs for Gdk.Color and also Gtk.Application. The Makefile is
updated to always use the updater instead of the generator. svn path=/trunk/gtk-sharp/; revision=12569
This commit is contained in:
Duncan Mak
parent
69d72bdf94
commit
a8ce5e560a
|
|
@ -162,7 +162,7 @@
|
|||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Parse">
|
||||
<MemberSignature Language="C#" Value="public static int Parse (string spec, ref Gdk.Color color);" />
|
||||
<MemberSignature Language="C#" Value="public static bool Parse (string spec, ref Gdk.Color color);" />
|
||||
<MemberType>Method</MemberType>
|
||||
<ReturnValue>
|
||||
<ReturnType>System.Int32</ReturnType>
|
||||
|
|
|
|||
|
|
@ -34,10 +34,10 @@
|
|||
<Docs>
|
||||
<summary>Quits the current main loop</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
<para>
|
||||
Makes the innermost invocation of the main loop return when it regains control.
|
||||
</para>
|
||||
</remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="RunIteration">
|
||||
|
|
@ -48,21 +48,19 @@
|
|||
</ReturnValue>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary></summary>
|
||||
<summary />
|
||||
<remarks>
|
||||
<para>
|
||||
<para>
|
||||
Runs a single iteration of the mainloop. If no events are
|
||||
waiting to be processed GTK+ will block until the next
|
||||
event is noticed. If you don't want to block look at <see
|
||||
cref="M:Gtk.Application.RunIteration(bool)"/> or check if
|
||||
any events are pending with <see
|
||||
cref="M:Gtk.Application.EventsPending()"/> first.
|
||||
event is noticed. If you don't want to block look at <see cref="M:Gtk.Application.RunIteration(bool)" /> or check if
|
||||
any events are pending with <see cref="M:Gtk.Application.EventsPending()" /> first.
|
||||
</para>
|
||||
</remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="RunIteration">
|
||||
<MemberSignature Language="C#" Value="public static void RunIteration (bool block);" />
|
||||
<MemberSignature Language="C#" Value="public static bool RunIteration (bool block);" />
|
||||
<MemberType>Method</MemberType>
|
||||
<ReturnValue>
|
||||
<ReturnType>System.Void</ReturnType>
|
||||
|
|
@ -71,18 +69,17 @@
|
|||
<Parameter Name="block" Type="System.Boolean;" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary></summary>
|
||||
<summary />
|
||||
<param name="block">A boolean value, whether the iteration should block or not</param>
|
||||
<remarks>
|
||||
<para>
|
||||
Runs a single iteration of the mainloop. If <paramref
|
||||
name="block"/> is true, then if no events are
|
||||
<para>
|
||||
Runs a single iteration of the mainloop. If <paramref name="block" /> is true, then if no events are
|
||||
waiting to be processed GTK+ will block until the next
|
||||
event is noticed; If <paramref name="block"/> is false,
|
||||
event is noticed; If <paramref name="block" /> is false,
|
||||
then it if no events are waiting to be processed Gtk+ the
|
||||
routine will return immediately.
|
||||
</para>
|
||||
</remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="EventsPending">
|
||||
|
|
@ -96,13 +93,13 @@
|
|||
<summary>Whether there are events on the queue</summary>
|
||||
<returns>true if events are available to be processed, false otherwise</returns>
|
||||
<remarks>
|
||||
<para>
|
||||
<para>
|
||||
Checks if any events are pending. This can be used to
|
||||
update the GUI and invoke timeouts etc. while doing some
|
||||
time intensive computation.
|
||||
</para>
|
||||
<example>
|
||||
<code lang="C#">
|
||||
<example>
|
||||
<code lang="C#">
|
||||
void LongComputation ()
|
||||
{
|
||||
while (!done){
|
||||
|
|
@ -114,8 +111,8 @@
|
|||
}
|
||||
}
|
||||
</code>
|
||||
</example>
|
||||
</remarks>
|
||||
</example>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Run">
|
||||
|
|
@ -128,17 +125,16 @@
|
|||
<Docs>
|
||||
<summary>Runs the main loop</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
Runs the main loop until <see
|
||||
cref="M:Gtk.Application.Quit()"/> is called. You can nest
|
||||
calls to <see cref="Gtk.Application.Run()"/>. In that
|
||||
case <see cref="M:Gtk.Application.Quit()"/> will make the
|
||||
<para>
|
||||
Runs the main loop until <see cref="M:Gtk.Application.Quit()" /> is called. You can nest
|
||||
calls to <see cref="Gtk.Application.Run()" />. In that
|
||||
case <see cref="M:Gtk.Application.Quit()" /> will make the
|
||||
innermost invocation of the main loop return.
|
||||
</para>
|
||||
</remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Init">
|
||||
<Member MemberName="Init" Deprecated="true">
|
||||
<MemberSignature Language="C#" Value="public static void Init (ref string [] args);" />
|
||||
<MemberType>Method</MemberType>
|
||||
<ReturnValue>
|
||||
|
|
@ -151,25 +147,25 @@
|
|||
<summary>Initializes GTK+ for operation.</summary>
|
||||
<param name="args">The arguments to pass to the toolkit</param>
|
||||
<remarks>
|
||||
<para>
|
||||
<para>
|
||||
Call this function before using any other GTK+ functions
|
||||
in your GUI applications. It will initialize everything
|
||||
needed to operate the toolkit.
|
||||
</para>
|
||||
<para>
|
||||
<para>
|
||||
This function will terminate your program if it was unable
|
||||
to initialize the GUI for some reason. If you want your
|
||||
program to fall back to a textual interface you want to
|
||||
call <see cref="M:Gtk.Application.InitCheck()"/> instead.
|
||||
call <see cref="M:Gtk.Application.InitCheck()" /> instead.
|
||||
</para>
|
||||
<para>
|
||||
<para>
|
||||
The args values will be modified after Gtk has removed the
|
||||
command line options that it handles itself.
|
||||
</para>
|
||||
</remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="InitCheck">
|
||||
<Member MemberName="InitCheck" Deprecated="true">
|
||||
<MemberSignature Language="C#" Value="public static bool InitCheck (ref string [] args);" />
|
||||
<MemberType>Method</MemberType>
|
||||
<ReturnValue>
|
||||
|
|
@ -184,25 +180,24 @@
|
|||
windowing system can not be initilized.</returns>
|
||||
<param name="args">The arguments to pass to the toolkit</param>
|
||||
<remarks>
|
||||
<para>
|
||||
<para>
|
||||
You use this call to initialize GTK+ for your GUI
|
||||
applications. This method will allow your application to
|
||||
be both GUI/text. A true return value means that the
|
||||
toolkit was initialized, a false value means that the
|
||||
toolkit could not be initialized. If you do not want to
|
||||
do dual GUI/text applications, you can use <see
|
||||
cref="M:Gtk.Application.Init()"/> instead.
|
||||
do dual GUI/text applications, you can use <see cref="M:Gtk.Application.Init()" /> instead.
|
||||
</para>
|
||||
<para>
|
||||
<para>
|
||||
This function will terminate your program if it was unable
|
||||
to initialize the GUI for some reason. If you want your
|
||||
program to fall back to a textual interface you want to
|
||||
call <see cref="M:Gtk.Application.InitCheck()"/> instead.
|
||||
call <see cref="M:Gtk.Application.InitCheck()" /> instead.
|
||||
</para>
|
||||
</remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName=".ctor">
|
||||
<Member MemberName=".ctor" Deprecated="true">
|
||||
<MemberSignature Language="C#" Value="public Application ();" />
|
||||
<MemberType>Constructor</MemberType>
|
||||
<ReturnValue />
|
||||
|
|
@ -219,27 +214,70 @@
|
|||
<ReturnValue>
|
||||
<ReturnType>System.Void</ReturnType>
|
||||
</ReturnValue>
|
||||
<Parameters/>
|
||||
<Parameters />
|
||||
<Docs>
|
||||
<summary>Initializes GTK+ for operation.</summary>
|
||||
<remarks>
|
||||
<para>
|
||||
<para>
|
||||
Call this function before using any other GTK+ functions
|
||||
in your GUI applications. It will initialize everything
|
||||
needed to operate the toolkit.
|
||||
</para>
|
||||
<para>
|
||||
<para>
|
||||
This function will terminate your program if it was unable
|
||||
to initialize the GUI for some reason. If you want your
|
||||
program to fall back to a textual interface you want to
|
||||
call <see cref="M:Gtk.Application.InitCheck()"/> instead.
|
||||
call <see cref="M:Gtk.Application.InitCheck()" /> instead.
|
||||
</para>
|
||||
<para>
|
||||
<para>
|
||||
If you want to pass arguments from the command line use
|
||||
the <see cref="T:Gtk.Application.Init(ref string[])"/>
|
||||
the <see cref="T:Gtk.Application.Init(ref string[])" />
|
||||
method instead.
|
||||
</para>
|
||||
</remarks>
|
||||
</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="CurrentEvent">
|
||||
<MemberSignature Language="C#" Value="public object CurrentEvent { get; };" />
|
||||
<MemberType>Property</MemberType>
|
||||
<ReturnValue>
|
||||
<ReturnType>System.Object</ReturnType>
|
||||
</ReturnValue>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<returns>To be added: an object of type 'object'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="InitCheck">
|
||||
<MemberSignature Language="C#" Value="public static bool InitCheck (ref String[] args);" />
|
||||
<MemberType>Method</MemberType>
|
||||
<ReturnValue>
|
||||
<ReturnType>System.Boolean</ReturnType>
|
||||
</ReturnValue>
|
||||
<Parameters>
|
||||
<Parameter Name="args" Type="System.String[]&" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="args">To be added: an object of type 'String[]&'</param>
|
||||
<returns>To be added: an object of type 'bool'</returns>
|
||||
<remarks>To be added</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
<Member MemberName="Init">
|
||||
<MemberSignature Language="C#" Value="public static void Init (ref String[] args);" />
|
||||
<MemberType>Method</MemberType>
|
||||
<ReturnValue>
|
||||
<ReturnType>System.Void</ReturnType>
|
||||
</ReturnValue>
|
||||
<Parameters>
|
||||
<Parameter Name="args" Type="System.String[]&" />
|
||||
</Parameters>
|
||||
<Docs>
|
||||
<summary>To be added</summary>
|
||||
<param name="args">To be added: an object of type 'String[]&'</param>
|
||||
<remarks>To be added</remarks>
|
||||
</Docs>
|
||||
</Member>
|
||||
</Members>
|
||||
|
|
|
|||
17
doc/makefile
17
doc/makefile
|
|
@ -2,8 +2,9 @@ LIBDIR=/usr/lib
|
|||
BROWSER=../../monodoc/browser/browser.exe
|
||||
ASSEMBLER=../../monodoc/browser/assembler.exe
|
||||
GENERATOR=../../monodoc/generator/generator.exe
|
||||
UPDATER=../../monodoc/updater/updater.exe
|
||||
|
||||
all: tree
|
||||
all: docs
|
||||
|
||||
b:
|
||||
mono --debug $(BROWSER)
|
||||
|
|
@ -13,19 +14,19 @@ tree:
|
|||
docs: glib pango atk gtk gdk gnome glade
|
||||
|
||||
glib:
|
||||
mono --debug $(GENERATOR) $(LIBDIR)/glib-sharp.dll -o en
|
||||
mono --debug $(UPDATER) $(LIBDIR)/glib-sharp.dll -o en
|
||||
pango:
|
||||
mono --debug $(GENERATOR) $(LIBDIR)/pango-sharp.dll -o en
|
||||
mono --debug $(UPDATER) $(LIBDIR)/pango-sharp.dll -o en
|
||||
atk:
|
||||
mono --debug $(GENERATOR) $(LIBDIR)/atk-sharp.dll -o en
|
||||
mono --debug $(UPDATER) $(LIBDIR)/atk-sharp.dll -o en
|
||||
gtk:
|
||||
mono --debug $(GENERATOR) $(LIBDIR)/gtk-sharp.dll -o en
|
||||
mono --debug $(UPDATER) $(LIBDIR)/gtk-sharp.dll -o en
|
||||
gdk:
|
||||
mono --debug $(GENERATOR) $(LIBDIR)/gdk-sharp.dll -o en
|
||||
mono --debug $(UPDATER) $(LIBDIR)/gdk-sharp.dll -o en
|
||||
gnome:
|
||||
mono --debug $(GENERATOR) $(LIBDIR)/gnome-sharp.dll -o en
|
||||
mono --debug $(UPDATER) $(LIBDIR)/gnome-sharp.dll -o en
|
||||
glade:
|
||||
mono --debug $(GENERATOR) $(LIBDIR)/glade-sharp.dll -o en
|
||||
mono --debug $(UPDATER) $(LIBDIR)/glade-sharp.dll -o en
|
||||
|
||||
clean:
|
||||
rm *.tree
|
||||
|
|
|
|||
Loading…
Reference in a new issue