Tizen 2.1 base

[platform/upstream/glib2.0.git] / docs / reference / gobject / glib-mkenums.1

diff --git a/docs/reference/gobject/glib-mkenums.1 b/docs/reference/gobject/glib-mkenums.1
index 5b961f3..0b3a7e6 100644 (file)
--- a/docs/reference/gobject/glib-mkenums.1
+++ b/docs/reference/gobject/glib-mkenums.1
@@ -1,13 +1,22 @@
 '\" t
 .\"     Title: glib-mkenums
 .\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
-.\" Generator: DocBook XSL Stylesheets v1.75.1 <http://docbook.sf.net/>
-.\"      Date: 07/05/2009
-.\"    Manual: [FIXME: manual]
-.\"    Source: [FIXME: source]
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 05/14/2012
+.\"    Manual: User Commands
+.\"    Source: User Commands
 .\"  Language: English
 .\"
-.TH "GLIB\-MKENUMS" "1" "07/05/2009" "[FIXME: source]" "[FIXME: manual]"
+.TH "GLIB\-MKENUMS" "1" "05/14/2012" "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
 .\" -----------------------------------------------------------------
@@ -115,6 +124,16 @@ or
 comment\&.
 .RE
 .PP
+\fB\-\-identifier\-prefix\fR \fIprefix\fR
+.RS 4
+Indicates what portion of the enum name should be intepreted as the prefix (eg, the "Gtk" in "GtkDirectionType")\&. Normally this will be figured out automatically, but you may need to override the default if your namespace is capitalized oddly\&.
+.RE
+.PP
+\fB\-\-symbol\-prefix\fR \fIprefix\fR
+.RS 4
+Indicates what prefix should be used to correspond to the identifier prefix in related C function names (eg, the "gtk" in "gtk_direction_type_get_type"\&. Equivalently, this is the lowercase version of the prefix component of the enum value names (eg, the "GTK" in "GTK_DIR_UP"\&. The default value is the identifier prefix, converted to lowercase\&.
+.RE
+.PP
 \fB\-\-help\fR
 .RS 4
 Print brief help and exit\&.
@@ -172,6 +191,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)\&.
@@ -205,7 +235,7 @@ The base name of the input file currently being processed (e\&.g\&. foo\&.h)\&.
 Some C comments are treated specially in the parsed enum definitions, such comments start out with the trigraph sequence
 /*<
 and end with the trigraph sequence
->*/\&. Per enum definition, the options "skip" and "flags" can be specified, to indicate this enum definition to be skipped, or for it to be treated as a flags definition, or to specify the common prefix to be stripped from all values to generate value nicknames, respectively\&. The "lowercase_name" option can be used to specify the word separation used in the *_get_type() function\&. For instance, /*< lowercase_name=gnome_vfs_uri_hide_options >*/\&.
+>*/\&. Per enum definition, the options "skip" and "flags" can be specified, to indicate this enum definition to be skipped, or for it to be treated as a flags definition, or to specify the common prefix to be stripped from all values to generate value nicknames, respectively\&. The "underscore_name" option can be used to specify the word separation used in the *_get_type() function\&. For instance, /*< underscore_name=gnome_vfs_uri_hide_options >*/\&.
 .PP
 Per value definition, the options "skip" and "nick" are supported\&. The former causes the value to be skipped, and the latter can be used to specify the otherwise auto\-generated nickname\&. Examples:
 .sp
@@ -231,4 +261,5 @@ typedef enum /*< flags,prefix=PREFIX >*/
 .sp
 .SH "SEE ALSO"
 .PP
-\fBglib\-genmarshal\fR(1)
+
+\fBglib-genmarshal\fR(1)