The-Homebrew-Cloud/Ryujinx-GtkSharp
2
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2024-09-08 07:53:17 +02:00
Code Issues Packages Projects Releases Wiki Activity

2003-08-18 John Luke <jluke@cfl.rr.com>

Browse Source 
* en/Gnome/Help.xml: documented
	* en/Gnome/CanvasText.xml: add example from monkeyguide

svn path=/trunk/gtk-sharp/; revision=17377
This commit is contained in:
John Luke 2003-08-18 04:28:10 +00:00
parent 8e1bf959d0
commit 5b0557bdc1
3 changed files with 205 additions and 149 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
doc/ChangeLog
View File

@ -1,3 +1,8 @@
2003-08-18 John Luke <jluke@cfl.rr.com>
* en/Gnome/Help.xml: documented
* en/Gnome/CanvasText.xml: add example from monkeyguide
2003-08-09 John Luke <jluke@cfl.rr.com>
* en/Gtk/Entry.xml: add example

306
doc/en/Gnome/CanvasText.xml
View File

@ -9,6 +9,71 @@
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<example>
<code language="C#">
using System;
using Gtk;
using GtkSharp;
using Gnome;
class CanvasTest
{
public CanvasTest()
{
Application.Init();
Window window1 = new Window("Hello Canvas!");
window1.DeleteEvent += new DeleteEventHandler (delete_event);
Canvas canvas1 = Canvas.NewAa();
int Width = 100;
int Height = 100;
canvas1.SetScrollRegion(0, 0, Width, Height);
canvas1.WidthRequest = Width;
canvas1.HeightRequest = Height;
CanvasGroup root = canvas1.Root();
// Draw Background
CanvasRect background = new CanvasRect(root);
background.X1 = 0;
background.X2 = Width;
background.Y1 = 0;
background.Y2 = Height;
background.FillColor = "#ffffff";
background.Show();
// Here we go
CanvasText hello = new CanvasText(root);
hello.X = 40;
hello.Y = 10;
hello.FillColor = "#000000";
hello.Text = "Hello, Canvas!";
hello.Show();
canvas1.Show();
window1.Add(canvas1);
window1.ShowAll();
Application.Run();
}
public static void Main()
{
new CanvasTest();
}
void delete_event (object obj, DeleteEventArgs args)
{
Application.Quit ();
}
}
</code>
</example>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasItem</BaseTypeName>
@ -40,8 +105,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
@ -58,7 +123,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.CanvasText'</returns>
<returns>an object of type <see cref="T:Gnome.CanvasText" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -67,12 +132,12 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
<returns>To be added: an object of type 'Gnome.CanvasText'</returns>
<param name="group">an object of type <see cref="T:Gnome.CanvasGroup" /></param>
<returns>an object of type <see cref="T:Gnome.CanvasText" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -83,8 +148,8 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gnome.CanvasText</summary>
<returns>The GLib Type for the Gnome.CanvasText class.</returns>
<summary>The <see cref="T:GLib.Type" /> for <see cref="T:Gnome.CanvasText" /></summary>
<returns>The <see cref="T:GLib.Type" /> for the <see cref="T:Gnome.CanvasText" /> class.</returns>
<remarks />
</Docs>
</Member>
@ -94,12 +159,11 @@
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -109,12 +173,11 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -124,12 +187,11 @@
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<param name="value">an object of type <see cref="T:System.Int32" /></param>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -139,12 +201,11 @@
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -154,12 +215,11 @@
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -169,12 +229,11 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<param name="value">an object of type <see cref="T:System.Double" /></param>
<returns>an object of type <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -184,12 +243,11 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<param name="value">an object of type <see cref="T:System.Double" /></param>
<returns>an object of type <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -199,12 +257,11 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<param name="value">an object of type <see cref="T:System.Double" /></param>
<returns>an object of type <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -214,12 +271,11 @@
<ReturnValue>
<ReturnType>Pango.Stretch</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.Stretch'</param>
<returns>To be added: an object of type 'Pango.Stretch'</returns>
<param name="value">an object of type <see cref="T:Pango.Stretch" /></param>
<returns>an object of type <see cref="T:Pango.Stretch" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -229,12 +285,11 @@
<ReturnValue>
<ReturnType>Gtk.Justification</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.Justification'</param>
<returns>To be added: an object of type 'Gtk.Justification'</returns>
<param name="value">an object of type <see cref="T:Gtk.Justification" /></param>
<returns>an object of type <see cref="T:Gtk.Justification" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -244,12 +299,11 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<param name="value">an object of type <see cref="T:System.Double" /></param>
<returns>an object of type <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -259,12 +313,11 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<param name="value">an object of type 'double'</param>
<returns>an object of type 'double'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -274,12 +327,11 @@
<ReturnValue>
<ReturnType>Gdk.Drawable</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Drawable'</param>
<returns>To be added: an object of type 'Gdk.Drawable'</returns>
<param name="value">an object of type <see cref="T:Gdk.Drawable" /></param>
<returns>an object of type <see cref="T:Gdk.Drawable" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -289,12 +341,11 @@
<ReturnValue>
<ReturnType>Gtk.AnchorType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.AnchorType'</param>
<returns>To be added: an object of type 'Gtk.AnchorType'</returns>
<param name="value">an object of type <see cref="T:Gtk.AnchorType" /></param>
<returns>an object of type <see cref="T:Gtk.AnchorType" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -304,12 +355,11 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<param name="value">an object of type <see cref="T:System.Double" /></param>
<returns>an object of type <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -319,12 +369,11 @@
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<param name="value">an object of type <see cref="T:System.Int32" /></param>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -334,12 +383,11 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -349,12 +397,11 @@
<ReturnValue>
<ReturnType>Pango.AttrList</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.AttrList'</param>
<returns>To be added: an object of type 'Pango.AttrList'</returns>
<param name="value">an object of type <see cref="T:Pango.AttrList" /></param>
<returns>an object of type <see cref="T:Pango.AttrList" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -364,12 +411,11 @@
<ReturnValue>
<ReturnType>Pango.Underline</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.Underline'</param>
<returns>To be added: an object of type 'Pango.Underline'</returns>
<param name="value">an object of type <see cref="T:Pango.Underline" /></param>
<returns>an object of type <see cref="T:Pango.Underline" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -379,12 +425,11 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<param name="value">an object of type <see cref="T:System.Double" /></param>
<returns>an object of type <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -394,12 +439,11 @@
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'uint'</returns>
<param name="value">an object of type <see cref="T:System.UInt32" /></param>
<returns>an object of type <see cref="T:System.UInt32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -409,12 +453,11 @@
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<param name="value">an object of type <see cref="T:System.Int32" /></param>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -424,12 +467,11 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<param name="value">an object of type <see cref="T:System.Double" /></param>
<returns>an object of type <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -439,12 +481,11 @@
<ReturnValue>
<ReturnType>Pango.Style</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.Style'</param>
<returns>To be added: an object of type 'Pango.Style'</returns>
<param name="value">an object of type <see cref="T:Pango.Style" /></param>
<returns>an object of type <see cref="T:Pango.Style" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -454,12 +495,11 @@
<ReturnValue>
<ReturnType>Pango.Variant</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.Variant'</param>
<returns>To be added: an object of type 'Pango.Variant'</returns>
<param name="value">an object of type <see cref="T:Pango.Variant" /></param>
<returns>an object of type <see cref="T:Pango.Variant" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -469,12 +509,11 @@
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Color'</returns>
<param name="value">an object of type <see cref="T:Gdk.Color" /></param>
<returns>an object of type <see cref="T:Gdk.Color" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -484,12 +523,11 @@
<ReturnValue>
<ReturnType>Pango.FontDescription</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Pango.FontDescription'</param>
<returns>To be added: an object of type 'Pango.FontDescription'</returns>
<param name="value">an object of type <see cref="T:Pango.FontDescription" /></param>
<returns>an object of type <see cref="T:Pango.FontDescription" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -499,12 +537,11 @@
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -514,12 +551,11 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<param name="value">an object of type 'double'</param>
<returns>an object of type 'double'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -529,12 +565,11 @@
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<param name="value">an object of type <see cref="T:System.Double" /></param>
<returns>an object of type <see cref="T:System.Double" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -544,12 +579,11 @@
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Parameters></Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
@ -558,8 +592,8 @@
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
@ -570,4 +604,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

43
doc/en/Gnome/Help.xml
View File

@ -1,5 +1,5 @@
<Type Name="Help" FullName="Gnome.Help">
<TypeSignature Language="C#" Value="public class Help" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class Help" Maintainer="John Luke" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<AssemblyPublicKey />
@ -9,8 +9,8 @@
</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>
<remarks>To be added</remarks>
<summary>Display application and Gnome system help.</summary>
<remarks>These functions provide a way to display help files that are either installed as part of the main Gnome installation or that are specific to the current application.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -31,13 +31,23 @@
<Parameter Name="link_id" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Displays the help file specified by <paramref name="file_name"/> at location <paramref name="link_id"/> within the <paramref name="doc_id"/> domain in the preferred help browser of the user.</summary>
<param name="program">a <see cref="T:Gnome.Program" /></param>
<param name="doc_id">a <see cref="T:System.String" /></param>
<param name="file_name">a <see cref="T:System.String" /></param>
<param name="link_id">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>
Most of the time, you want to call <see cref="M:Gnome.Help.Display(System.String,System.String)"/> instead.
</para>
<para>
This function will display the help through creating a "ghelp" URI, by looking for <paramref name="file_name"/> in the applications installed help location (found by <see cref="F:Gnome.FileDomain.AppHelp"/>) and its <paramref name="app_id"/>. The resulting URI is roughly in the form "ghelp:appid/file_name?link_id". If a matching file cannot be found, <see langword="false"/> is returned.
</para>
<para>
Please note that this only displays application help. To display help files from the global Gnome domain, you will want to use <see cref="M:Gnome.Help.DisplayDesktop(Gnome.Program,System.String,System.String,System.String)"/>.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="ErrorQuark">
@ -64,11 +74,11 @@
<Parameter Name="link_id" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Displays the help file specified by <paramref name="file_name"/> at location <paramref name="link_id"/> in the preferred help browser of the user.</summary>
<param name="file_name">a <see cref="T:System.String" /></param>
<param name="link_id">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DisplayUri">
@ -81,10 +91,10 @@
<Parameter Name="help_uri" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Displays <paramref name="help_uri"/> in the preferred help viewer of the user.</summary>
<param name="help_uri">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>You should never need to call this function directly in code, since it is just a wrapper for <see cref="M:Gnome.Url.Show(System.String)"/> and consequently the viewer used to display the results depends upon the scheme of the URI (so it is not strictly a help-only function).</remarks>
</Docs>
</Member>
<Member MemberName="DisplayDesktop">
@ -100,13 +110,20 @@
<Parameter Name="link_id" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Displays the Gnome system help file specified by <paramref name="file_name"/> at location <paramref name="link_id"/> in the preferred help browser of the user.</summary>
<param name="program">a <see cref="T:Gnome.Program" /></param>
<param name="doc_id">a <see cref="T:System.String" /></param>
<param name="file_name">a <see cref="T:System.String" /></param>
<param name="link_id">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
<remarks>
<para>
This is done by creating a "ghelp" URI, by looking for <paramref name="file_name"/> in the system help domain (<see cref="F:Gnome.FileDomain.Help"/>) and its <paramref name="app_id"/>. This domain is determined when the library is compiled. If a matching file cannot be found, <see langword="false"/> is returned.
</para>
<para>
Please note that this only displays system help. To display help files for an application, you will want to use <see cref="M:Gnome.Help.Display(System.String,System.String)"/>.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -115,9 +132,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Creates a new <see cref="T:Gnome.Help"/> instance.</summary>
<returns>a <see cref="T:Gnome.Help" /></returns>
<remarks>To be added</remarks>
<remarks>This is the default constructor for <see cref="T:Gnome.Help"/>.</remarks>
</Docs>
</Member>
</Members>