From a986ad5de082157fa426ec9dde119b6edae3a24b Mon Sep 17 00:00:00 2001
From: Mike Kestner <mkestner@gmail.com>
Date: Fri, 2 Jul 2004 19:18:25 +0000
Subject: [PATCH] more glib docs
svn path=/trunk/gtk-sharp/; revision=30689
---
doc/en/GLib/SList.xml | 12 ++++++------
doc/en/GLib/SignalAttribute.xml | 26 ++++++++++++++++++--------
2 files changed, 24 insertions(+), 14 deletions(-)
diff --git a/doc/en/GLib/SList.xml b/doc/en/GLib/SList.xml
index d059b98a0..26343356b 100644
--- a/doc/en/GLib/SList.xml
+++ b/doc/en/GLib/SList.xml
@@ -77,9 +77,9 @@
</ReturnValue>
<Parameters />
<Docs>
- <summary>To be added</summary>
- <returns>a <see cref="T:System.Object" /></returns>
- <remarks>To be added</remarks>
+ <summary>Creates a copy of the list.</summary>
+ <returns>a copy of the list as an <see cref="T:System.Object" /></returns>
+ <remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
@@ -90,10 +90,10 @@
<Parameter Name="element_type" Type="System.Type" />
</Parameters>
<Docs>
- <summary>To be added</summary>
- <param name="element_type">a <see cref="T:System.Type" /></param>
+ <summary>Public Constructor.</summary>
+ <param name="element_type">the <see cref="T:System.Type" /> of the list elements.</param>
<returns>a <see cref="T:GLib.SList" /></returns>
- <remarks>To be added</remarks>
+ <remarks />
</Docs>
</Member>
</Members>
diff --git a/doc/en/GLib/SignalAttribute.xml b/doc/en/GLib/SignalAttribute.xml
index c87bd01e6..7d4c0b25a 100644
--- a/doc/en/GLib/SignalAttribute.xml
+++ b/doc/en/GLib/SignalAttribute.xml
@@ -10,8 +10,18 @@
</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>Marks events genrated from <see cref="N:GLib" /> signals</summary>
- <remarks>This attribute indentifies events generated from <see cref="N:GLib" /> signals and allows obtaining its original name.</remarks>
+ <summary>Marks events generated from <see cref="T:GLib.Object" /> signals</summary>
+ <remarks>
+ <para>
+This attribute indentifies events generated from <see cref="N:GLib" /> signals and allows obtaining its original name.
+</para>
+ <example>
+ <code lang="C#">
+[GLib.Signal("destroy")]
+public event System.EventHandler Destroyed { add; remove; }
+</code>
+ </example>
+ </remarks>
</Docs>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
@@ -27,10 +37,10 @@
<Parameter Name="cname" Type="System.String" />
</Parameters>
<Docs>
- <summary>To be added</summary>
- <param name="cname">an object of type <see cref="T:System.String" /></param>
+ <summary>Public Constructor.</summary>
+ <param name="cname">a <see cref="T:System.String" /> containing the C name of the signal.</param>
<returns>an object of type <see cref="T:GLib.SignalAttribute" /></returns>
- <remarks>To be added</remarks>
+ <remarks />
</Docs>
</Member>
<Member MemberName="CName">
@@ -40,9 +50,9 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
- <summary>To be added</summary>
- <returns>an object of type <see cref="T:System.String" /></returns>
- <remarks>To be added</remarks>
+ <summary>The C name of the signal.</summary>
+ <returns>the C name of the signal as a <see cref="T:System.String" /></returns>
+ <remarks />
</Docs>
</Member>
</Members>