From: Jürg Billeter <j@bitron.ch>
Date: Tue, 3 Jun 2008 19:14:22 +0000 (+0000)
Subject: Document enum syntax, based on patch by Phil Housley
X-Git-Tag: VALA_0_3_3~6
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=ea85ff9daf78629d60a0db63702cbbdbf0dd3717;p=thirdparty%2Fvala.git

Document enum syntax, based on patch by Phil Housley

2008-06-03  Jürg Billeter  <j@bitron.ch>

	* doc/vala/enums.xml:

	Document enum syntax, based on patch by Phil Housley

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

diff --git a/ChangeLog b/ChangeLog
index af914600d..91befdbb1 100644
--- a/ChangeLog
+++ b/ChangeLog
@@ -1,3 +1,9 @@
+2008-06-03  Jürg Billeter  <j@bitron.ch>
+
+	* doc/vala/enums.xml:
+
+	Document enum syntax, based on patch by Phil Housley
+
 2008-06-03  Jürg Billeter  <j@bitron.ch>
 
 	* doc/vala/methods.xml:
diff --git a/doc/vala/enums.xml b/doc/vala/enums.xml
index 357514619..c58d7a4c9 100644
--- a/doc/vala/enums.xml
+++ b/doc/vala/enums.xml
@@ -1,17 +1,25 @@
 <?xml version="1.0"?>
 <section id="enums">
 	<h>Enums</h>
+	<p>Enumerated types represent a set of constant values.</p>
 	<section id="declaration">
 		<h>Enum declarations</h>
-		<p>Documentation</p>
-	</section>
-	<section id="members">
-		<h>Enum members</h>
-		<p>Documentation</p>
-	</section>
-	<section id="methods">
-		<h>Methods</h>
-		<p>Documentation</p>
+		<blockquote>
+enum-declaration:
+	[ access-modifier ] <l>enum</l> qualified-identifier <l>{</l> [ enum-members ] <l>}</l>
+
+enum-members:
+	enum-values [ <l>;</l> [ enum-methods ] ]
+
+enum-values:
+	enum-value [ <l>,</l> enum-values ]
+
+enum-value:
+	identifier [ <l>=</l> expression ]
+
+enum-methods:
+	method-declaration [ enum-methods ]
+</blockquote>
 	</section>
 </section>