From: Ryan Lortie <desrt@desrt.ca>
Date: Thu, 13 May 2010 23:54:30 +0000 (+0200)
Subject: documentation for glib-mkenums @valuenum@
X-Git-Tag: 2.25.4~12
X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=62c0454b34191b56d439521e537915b0514f8dbb;p=platform%2Fupstream%2Fglib.git

documentation for glib-mkenums @valuenum@
---

diff --git a/docs/reference/gobject/glib-mkenums.1 b/docs/reference/gobject/glib-mkenums.1
index f598893..f44c320 100644
--- a/docs/reference/gobject/glib-mkenums.1
+++ b/docs/reference/gobject/glib-mkenums.1
@@ -2,12 +2,21 @@
 .\"     Title: glib-mkenums
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
 .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/>
-.\"      Date: 04/19/2010
+.\"      Date: 05/14/2010
 .\"    Manual: User Commands
 .\"    Source: User Commands
 .\"  Language: English
 .\"
-.TH "GLIB\-MKENUMS" "1" "04/19/2010" "User Commands" "User Commands"
+.TH "GLIB\-MKENUMS" "1" "05/14/2010" "User Commands" "User Commands"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -172,6 +181,17 @@ The enum value name currently being processed with words uppercase and word\-sep
 A nick name for the enum value currently being processed, this is usually generated by stripping common prefix words of all the enum values of the current enum, the words are lowercase and underscores are substituted by a minus (e\&.g\&. the\-xvalue)\&.
 .RE
 .PP
+@valuenum@
+.RS 4
+The integer value for the enum value currently being processed\&. This is calculated by using
+\fBperl\fR
+to attempt to evaluate the expression as it appears in the C source code\&. If evaluation fails then
+\fBglib\-mkenums\fR
+will exit with an error status, but this only happens if
+@valuenum@
+appears in your value production template\&. (Since: 2\&.26)
+.RE
+.PP
 @type@
 .RS 4
 This is substituted either by "enum" or "flags", depending on whether the enum value definitions contained bit\-shift operators or not (e\&.g\&. flags)\&.
diff --git a/docs/reference/gobject/glib-mkenums.xml b/docs/reference/gobject/glib-mkenums.xml
index 9702ed5..38e400d 100644
--- a/docs/reference/gobject/glib-mkenums.xml
+++ b/docs/reference/gobject/glib-mkenums.xml
@@ -201,6 +201,18 @@ minus (e.g. the-xvalue).
 </varlistentry>
 
 <varlistentry>
+<term>@valuenum@</term>
+<listitem><para>
+The integer value for the enum value currently being processed.  This is
+calculated by using <command>perl</command> to attempt to evaluate the
+expression as it appears in the C source code.  If evaluation fails then
+<command>glib-mkenums</command> will exit with an error status, but this
+only happens if <literal>@valuenum@</literal> appears in your value
+production template.  (Since: 2.26)
+</para></listitem>
+</varlistentry>
+
+<varlistentry>
 <term>@type@</term>
 <listitem><para>
 This is substituted either by "enum" or "flags", depending on whether the