luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-26 15:36:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

documentation for glib-mkenums @valuenum@

Browse Source
This commit is contained in:
Ryan Lortie 2010-05-14 01:54:30 +02:00
parent e1fb92551f
commit 62c0454b34
2 changed files with 34 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

24
docs/reference/gobject/glib-mkenums.1
View File

@ -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)\&.

12
docs/reference/gobject/glib-mkenums.xml
View File

@ -200,6 +200,18 @@ minus (e.g. the-xvalue).
</para></listitem>
</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>