Used the params keyword with the parameter descriptions

svn path=/trunk/gtk-sharp/; revision=17048
This commit is contained in:
Martin Willemoes Hansen 2003-08-04 12:17:17 +00:00
parent 793b5ded71
commit 671e97d5c9
5 changed files with 30 additions and 25 deletions

View file

@ -11,6 +11,12 @@
Used when the <see cref="T:Gnome.Client" /> wishes to interact with the user at
the session manager's convenience (usually during shutdown and restarts).
</summary>
<param name="client">The <see cref="T:Gnome.Client" /> instance doing the interaction.</param>
<param name="key">A unique key.</param>
<param name="dialog_type">The <see cref="T:Gnome.DialogType" /> that should be used to do the interaction.</param>
<param name="data">Application specific data that was specified at the time the callback was set up.</param>
<remarks>
<para>
All other <see cref="T:Gnome.Client" />s are blocked from interacting with the user until the
@ -20,10 +26,6 @@
Although the function is not obliged to respect the passed in <see cref="T:Gnome.DialogType" />,
it is bad form not to do so.
</para>
<para>client : The <see cref="T:Gnome.Client" /> instance doing the interaction.</para>
<para>key : A unique key.</para>
<para>dialog_type : The <see cref="T:Gnome.DialogType" /> that should be used to do the interaction.</para>
<para>data : Application specific data that was specified at the time the callback was set up.</para>
</remarks>
</Docs>
<Base>
@ -39,8 +41,9 @@
</Interfaces>
<Attributes />
<Members />
<Parameters>
<Parameter Name="client" Type="Gnome.Client" />
<Parameter Name="client" Type="Gnome.Client" />
<Parameter Name="key" Type="System.Int32" />
<Parameter Name="dialog_type" Type="Gnome.DialogType" />
</Parameters>

View file

@ -11,10 +11,9 @@
Called to perform some initialization in a module
(which could be either the main init function or the pre or post argument parsing phase).
</summary>
<remarks>
<para>program : The <see cref="T:Gnome.Program" /> instance which is being initialized.</para>
<para>mod_info : The current module's <see cref="T:Gnome.ModuleInfo" /> structure.</para>
</remarks>
<param name="program">The <see cref="T:Gnome.Program" /> instance which is being initialized.</param>
<param name="mod_info">The current module's <see cref="T:Gnome.ModuleInfo" /> structure.</param>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>

View file

@ -7,11 +7,15 @@
</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>Called to allow a module to do any pre-initialization it might need to do
prior to having arguments parsed by the controlling parent module </summary>
<summary>
Called to allow a module to do any pre-initialization it might need to do
prior to having arguments parsed by the controlling parent module.
</summary>
<param name="mod_info">The current module's <see cref="T:Gnome.ModuleInfo" /> structure.</param>
<remarks>
<para>The parent module will do the argument parsing for all modules in the hierarchy.</para>
<para>mod_info : The current module's <see cref="T:Gnome.ModuleInfo" /> structure.</para>
</remarks>
</Docs>
<Base>

View file

@ -11,14 +11,14 @@
Can be used as a target for <see cref="T:Gnome.TriggerType" />
of <see cref="T:Gnome.Trigger" /> instances.
</summary>
<remarks>
<para>
msg : The human-readable message that was passed to
<param name="msg">
The human-readable message that was passed to
<see cref="M:Gnome.Triggers.Vdo(string,string,string[])" />. May be null.
</para>
<para>level : The severity level of the event. May be null. </para>
<para>supinfo : The section in which the event belongs. </para>
</remarks>
</param>
<param name="level">The severity level of the event. May be null. </param>
<param name="supinfo">The section in which the event belongs. </param>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>

View file

@ -8,17 +8,16 @@
<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>Are called as a result of signals being emitted from a menu or tool bar item</summary>
<param name="uiinfo">The user data that was part of the <see cref="T:Gnome.UIInfo" /> instance.</param>
<param name="signal_name">The name of the emitted signal.</param>
<param name="uibdata">The user data that was part of the relevant <see cref="T:Gnome.UIBuilderData" /> instance.</param>
<remarks>
<para>
Delegates of this type are given as the first element of a
<see cref="T:Gnome.UIBuilderData" /> instance.
</para>
<para>uiinfo : The user data that was part of the <see cref="T:Gnome.UIInfo" /> instance.</para>
<para>signal_name : The name of the emitted signal.</para>
<para>
uibdata : The user data that was part of the relevant
<see cref="T:Gnome.UIBuilderData" /> instance.
</para>
</remarks>
</Docs>
<Base>