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 af914600de9178f6b791af227519a962779aa57e..91befdbb1797af56092eb2df83cf7987d3ac7355 100644 (file)
--- 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 357514619395a7f46e99428eea76606816ff7c83..c58d7a4c99e235d0c0e20f3e1cb0ca6a7f9281e9 100644 (file)
--- 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>