ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2024-12-24 01:45:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update docs for Gdk.Color and also Gtk.Application. The Makefile is

Browse source 
updated to always use the updater instead of the generator.

svn path=/trunk/gtk-sharp/; revision=12569
This commit is contained in:
Duncan Mak 2003-03-15 22:58:57 +00:00
parent 69d72bdf94
commit a8ce5e560a
3 changed files with 96 additions and 57 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
doc/en/Gdk/Color.xml
View file

@ -162,7 +162,7 @@
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Parse"> <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> <MemberType>Method</MemberType>
<ReturnValue> <ReturnValue>
<ReturnType>System.Int32</ReturnType> <ReturnType>System.Int32</ReturnType>

134
doc/en/Gtk/Application.xml
View file

@ -34,10 +34,10 @@
<Docs> <Docs>
<summary>Quits the current main loop</summary> <summary>Quits the current main loop</summary>
<remarks> <remarks>
<para> <para>
Makes the innermost invocation of the main loop return when it regains control. Makes the innermost invocation of the main loop return when it regains control.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RunIteration"> <Member MemberName="RunIteration">
@ -48,21 +48,19 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary></summary> <summary />
<remarks> <remarks>
<para> <para>
Runs a single iteration of the mainloop. If no events are Runs a single iteration of the mainloop. If no events are
waiting to be processed GTK+ will block until the next waiting to be processed GTK+ will block until the next
event is noticed. If you don't want to block look at <see event is noticed. If you don't want to block look at <see cref="M:Gtk.Application.RunIteration(bool)" /> or check if
cref="M:Gtk.Application.RunIteration(bool)"/> or check if any events are pending with <see cref="M:Gtk.Application.EventsPending()" /> first.
any events are pending with <see
cref="M:Gtk.Application.EventsPending()"/> first.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="RunIteration"> <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> <MemberType>Method</MemberType>
<ReturnValue> <ReturnValue>
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
@ -71,18 +69,17 @@
<Parameter Name="block" Type="System.Boolean;" /> <Parameter Name="block" Type="System.Boolean;" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary></summary> <summary />
<param name="block">A boolean value, whether the iteration should block or not</param> <param name="block">A boolean value, whether the iteration should block or not</param>
<remarks> <remarks>
<para> <para>
Runs a single iteration of the mainloop. If <paramref Runs a single iteration of the mainloop. If <paramref name="block" /> is true, then if no events are
name="block"/> is true, then if no events are
waiting to be processed GTK+ will block until the next 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 then it if no events are waiting to be processed Gtk+ the
routine will return immediately. routine will return immediately.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="EventsPending"> <Member MemberName="EventsPending">
@ -96,13 +93,13 @@
<summary>Whether there are events on the queue</summary> <summary>Whether there are events on the queue</summary>
<returns>true if events are available to be processed, false otherwise</returns> <returns>true if events are available to be processed, false otherwise</returns>
<remarks> <remarks>
<para> <para>
Checks if any events are pending. This can be used to Checks if any events are pending. This can be used to
update the GUI and invoke timeouts etc. while doing some update the GUI and invoke timeouts etc. while doing some
time intensive computation. time intensive computation.
</para> </para>
<example> <example>
<code lang="C#"> <code lang="C#">
void LongComputation () void LongComputation ()
{ {
while (!done){ while (!done){
@ -114,8 +111,8 @@
} }
} }
</code> </code>
</example> </example>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Run"> <Member MemberName="Run">
@ -128,17 +125,16 @@
<Docs> <Docs>
<summary>Runs the main loop</summary> <summary>Runs the main loop</summary>
<remarks> <remarks>
<para> <para>
Runs the main loop until <see Runs the main loop until <see cref="M:Gtk.Application.Quit()" /> is called. You can nest
cref="M:Gtk.Application.Quit()"/> is called. You can nest calls to <see cref="Gtk.Application.Run()" />. In that
calls to <see cref="Gtk.Application.Run()"/>. In that case <see cref="M:Gtk.Application.Quit()" /> will make the
case <see cref="M:Gtk.Application.Quit()"/> will make the
innermost invocation of the main loop return. innermost invocation of the main loop return.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Init"> <Member MemberName="Init" Deprecated="true">
<MemberSignature Language="C#" Value="public static void Init (ref string [] args);" /> <MemberSignature Language="C#" Value="public static void Init (ref string [] args);" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
<ReturnValue> <ReturnValue>
@ -151,25 +147,25 @@
<summary>Initializes GTK+ for operation.</summary> <summary>Initializes GTK+ for operation.</summary>
<param name="args">The arguments to pass to the toolkit</param> <param name="args">The arguments to pass to the toolkit</param>
<remarks> <remarks>
<para> <para>
Call this function before using any other GTK+ functions Call this function before using any other GTK+ functions
in your GUI applications. It will initialize everything in your GUI applications. It will initialize everything
needed to operate the toolkit. needed to operate the toolkit.
</para> </para>
<para> <para>
This function will terminate your program if it was unable This function will terminate your program if it was unable
to initialize the GUI for some reason. If you want your to initialize the GUI for some reason. If you want your
program to fall back to a textual interface you want to 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> <para>
The args values will be modified after Gtk has removed the The args values will be modified after Gtk has removed the
command line options that it handles itself. command line options that it handles itself.
</para> </para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="InitCheck"> <Member MemberName="InitCheck" Deprecated="true">
<MemberSignature Language="C#" Value="public static bool InitCheck (ref string [] args);" /> <MemberSignature Language="C#" Value="public static bool InitCheck (ref string [] args);" />
<MemberType>Method</MemberType> <MemberType>Method</MemberType>
<ReturnValue> <ReturnValue>
@ -184,25 +180,24 @@
windowing system can not be initilized.</returns> windowing system can not be initilized.</returns>
<param name="args">The arguments to pass to the toolkit</param> <param name="args">The arguments to pass to the toolkit</param>
<remarks> <remarks>
<para> <para>
You use this call to initialize GTK+ for your GUI You use this call to initialize GTK+ for your GUI
applications. This method will allow your application to applications. This method will allow your application to
be both GUI/text. A true return value means that the be both GUI/text. A true return value means that the
toolkit was initialized, a false value means that the toolkit was initialized, a false value means that the
toolkit could not be initialized. If you do not want to toolkit could not be initialized. If you do not want to
do dual GUI/text applications, you can use <see do dual GUI/text applications, you can use <see cref="M:Gtk.Application.Init()" /> instead.
cref="M:Gtk.Application.Init()"/> instead.
</para> </para>
<para> <para>
This function will terminate your program if it was unable This function will terminate your program if it was unable
to initialize the GUI for some reason. If you want your to initialize the GUI for some reason. If you want your
program to fall back to a textual interface you want to 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>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor" Deprecated="true">
<MemberSignature Language="C#" Value="public Application ();" /> <MemberSignature Language="C#" Value="public Application ();" />
<MemberType>Constructor</MemberType> <MemberType>Constructor</MemberType>
<ReturnValue /> <ReturnValue />
@ -219,27 +214,70 @@
<ReturnValue> <ReturnValue>
<ReturnType>System.Void</ReturnType> <ReturnType>System.Void</ReturnType>
</ReturnValue> </ReturnValue>
<Parameters/> <Parameters />
<Docs> <Docs>
<summary>Initializes GTK+ for operation.</summary> <summary>Initializes GTK+ for operation.</summary>
<remarks> <remarks>
<para> <para>
Call this function before using any other GTK+ functions Call this function before using any other GTK+ functions
in your GUI applications. It will initialize everything in your GUI applications. It will initialize everything
needed to operate the toolkit. needed to operate the toolkit.
</para> </para>
<para> <para>
This function will terminate your program if it was unable This function will terminate your program if it was unable
to initialize the GUI for some reason. If you want your to initialize the GUI for some reason. If you want your
program to fall back to a textual interface you want to 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> <para>
If you want to pass arguments from the command line use 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. method instead.
</para> </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[]&amp;" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="args">To be added: an object of type 'String[]&amp;'</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[]&amp;" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="args">To be added: an object of type 'String[]&amp;'</param>
<remarks>To be added</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

17
doc/makefile
View file

@ -2,8 +2,9 @@ LIBDIR=/usr/lib
BROWSER=../../monodoc/browser/browser.exe BROWSER=../../monodoc/browser/browser.exe
ASSEMBLER=../../monodoc/browser/assembler.exe ASSEMBLER=../../monodoc/browser/assembler.exe
GENERATOR=../../monodoc/generator/generator.exe GENERATOR=../../monodoc/generator/generator.exe
UPDATER=../../monodoc/updater/updater.exe
all: tree all: docs
b: b:
mono --debug $(BROWSER) mono --debug $(BROWSER)
@ -13,19 +14,19 @@ tree:
docs: glib pango atk gtk gdk gnome glade docs: glib pango atk gtk gdk gnome glade
glib: glib:
mono --debug $(GENERATOR) $(LIBDIR)/glib-sharp.dll -o en mono --debug $(UPDATER) $(LIBDIR)/glib-sharp.dll -o en
pango: pango:
mono --debug $(GENERATOR) $(LIBDIR)/pango-sharp.dll -o en mono --debug $(UPDATER) $(LIBDIR)/pango-sharp.dll -o en
atk: atk:
mono --debug $(GENERATOR) $(LIBDIR)/atk-sharp.dll -o en mono --debug $(UPDATER) $(LIBDIR)/atk-sharp.dll -o en
gtk: gtk:
mono --debug $(GENERATOR) $(LIBDIR)/gtk-sharp.dll -o en mono --debug $(UPDATER) $(LIBDIR)/gtk-sharp.dll -o en
gdk: gdk:
mono --debug $(GENERATOR) $(LIBDIR)/gdk-sharp.dll -o en mono --debug $(UPDATER) $(LIBDIR)/gdk-sharp.dll -o en
gnome: gnome:
mono --debug $(GENERATOR) $(LIBDIR)/gnome-sharp.dll -o en mono --debug $(UPDATER) $(LIBDIR)/gnome-sharp.dll -o en
glade: glade:
mono --debug $(GENERATOR) $(LIBDIR)/glade-sharp.dll -o en mono --debug $(UPDATER) $(LIBDIR)/glade-sharp.dll -o en
clean: clean:
rm *.tree rm *.tree