From: Raffaele Sandrini <raffaele@sandrini.ch>
Date: Sun, 24 Feb 2008 11:36:37 +0000 (+0000)
Subject: add some interface documentation, patch by Johannes Schmid
X-Git-Tag: VALA_0_1_7~45
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=f74c2c427757bb42420f9fbdc935f6d5a199c933;p=platform%2Fupstream%2Fvala.git

add some interface documentation, patch by Johannes Schmid

2008-02-24  Raffaele Sandrini  <raffaele@sandrini.ch>

	* doc/vala/interfaces.xml: add some interface documentation,
	  patch by Johannes Schmid

svn path=/trunk/; revision=1046
---

diff --git a/ChangeLog b/ChangeLog
index 188f624..f2f7eac 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,5 +1,10 @@
 2008-02-24  Raffaele Sandrini  <raffaele@sandrini.ch>
 
+	* doc/vala/interfaces.xml: add some interface documentation,
+	  patch by Johannes Schmid
+
+2008-02-24  Raffaele Sandrini  <raffaele@sandrini.ch>
+
 	* vapi/packages/pango/: fix Layout.get_size binding,
 	  fixes bug 518143
 	* vapi/pango.vapi: regenerated
diff --git a/doc/vala/interfaces.xml b/doc/vala/interfaces.xml
index 6f5f2ba..fa473ea 100644
--- a/doc/vala/interfaces.xml
+++ b/doc/vala/interfaces.xml
@@ -1,21 +1,41 @@
 <?xml version="1.0"?>
 <section id="interfaces">
 	<h>Interfaces</h>
+	<p>Interfaces can be implemented by classes to provide functionality with a common interface. Each class
+	can implement multiple interface and interfaces can require other interfaces to be implemented.</p>
 	<section id="declaration">
 		<h>Interface declarations</h>
-		<p>Documentation</p>
+		<blockcode>
+		public interface InterfaceName : RequiredInterface &lt;optional&gt;
+		{
+			&lt;interface members&gt;
+		}
+		</blockcode>
 	</section>
 	<section id="methods">
 		<h>Methods</h>
-		<p>Documentation</p>
+		<p>Interfaces can contain abstract and non abstract methods.</p>
+		<blockcode>
+		public abstract void MethodName ();
+		public void MethodName2 ()
+		{
+			&lt;Implementation&gt;
+		}
+		</blockcode>
 	</section>
-	<section id="properties">
-		<h>Properties</h>
-		<p>Documentation</p>
+	<section id="delegates">
+		<h>Delegates</h>
+		<p>Interfaces can also contain delegates</p>
+		<blockcode>
+		public delegate void DelegateName (void* data);
+		</blockcode>
 	</section>
 	<section id="signals">
 		<h>Signals</h>
-		<p>Documentation</p>
+		<p>Signals are also supported by interfaces</p>
+		<blockcode>
+		public signal void SignalName ();
+		</blockcode>
 	</section>
 </section>