From 4f8ba849e7e6cc8e2096d03b99438e7700ab1f54 Mon Sep 17 00:00:00 2001 From: Hyunjee Kim Date: Tue, 3 Dec 2019 09:48:48 +0900 Subject: Imported Upstream version 2.55.2 --- docs/reference/gio/gdbus-codegen.xml | 103 ++++++++++++++++++++++++++++++-- docs/reference/gio/gio-sections.txt | 1 + docs/reference/glib/glib-sections.txt | 1 + docs/reference/gobject/glib-mkenums.xml | 44 +++++++------- 4 files changed, 121 insertions(+), 28 deletions(-) (limited to 'docs') diff --git a/docs/reference/gio/gdbus-codegen.xml b/docs/reference/gio/gdbus-codegen.xml index 27b25ffa2..b1145e5ef 100644 --- a/docs/reference/gio/gdbus-codegen.xml +++ b/docs/reference/gio/gdbus-codegen.xml @@ -35,7 +35,11 @@ none|objects|all OUTDIR OUTFILES + FILE + + + OUTFILE @@ -55,13 +59,17 @@ Description gdbus-codegen is used to generate code and/or - documentation for one or more D-Bus interfaces. The tool reads + documentation for one or more D-Bus interfaces. + + + gdbus-codegen reads D-Bus - Introspection XML files and generates output files. The - tool currently supports generating C code (via - ) and Docbook XML (via - ). + Introspection XML from files passed as additional + arguments on the command line and generates output files. + It currently supports generating C source code (via + ) or header (via ) + and Docbook XML (via ). @@ -80,6 +88,20 @@ #GDBusConnection either directly or via a #GDBusObjectManagerServer instance. + + For C code generation either that + generates source code, or that + generates headers, can be used. These options must be used along with + , which is used to specify the file to output to. + + + Both files can be generated at the same time by using + , but this option is deprecated. + In this case cannot be used due to the + generation of multiple files. Instead pass + to specify the directory to put + the output files in. By default the current directory will be used. + The name of each generated C type is derived from the D-Bus interface name stripped with the prefix given with @@ -152,6 +174,7 @@ FILE + This option is deprecated; use positional arguments instead. The D-Bus introspection XML file. @@ -179,6 +202,11 @@ NAME is a place-holder for the interface name, e.g. net.Corp.FooBar and so on. + + Pass to specify the directory + to put the output files in. By default the current directory + will be used. + @@ -210,6 +238,17 @@ + + + + + If this option is passed, the + #pragma once + preprocessor directive is used instead of include guards. + + + + @@ -242,6 +281,60 @@ Directory to output generated source to. Equivalent to changing directory before generation. + + This option cannot be used with neither nor + , and must be used. + + + + + + + + + + If this option is passed, it will generate the header code and write it to the disk by + using the path and file name provided by . + + + Using , or + are not allowed to be used along with + and options, because these options + are used to generate only one file. + + + + + + + + + If this option is passed, it will generate the source code and write it to the disk by + using the path and file name provided by . + + + Using , or + are not allowed to be used along with + and options, because these options + are used to generate only one file. + + + + + + OUTFILE + + + The full path where the header () or the source code + () will be written, using the path and filename provided by + . The full path could be something like + $($OUTFILE).{c,h}. + + + Using , or + is not allowed along with + , because the latter is used to generate only one file. + diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt index 277ca6184..2eb7efc74 100644 --- a/docs/reference/gio/gio-sections.txt +++ b/docs/reference/gio/gio-sections.txt @@ -91,6 +91,7 @@ g_file_hash g_file_equal g_file_get_basename g_file_get_path +g_file_peek_path g_file_get_uri g_file_get_parse_name g_file_get_parent diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt index dd1d5dea6..2832983ee 100644 --- a/docs/reference/glib/glib-sections.txt +++ b/docs/reference/glib/glib-sections.txt @@ -1987,6 +1987,7 @@ g_key_file_has_key g_key_file_get_value g_key_file_get_string g_key_file_get_locale_string +g_key_file_get_locale_for_key g_key_file_get_boolean g_key_file_get_integer g_key_file_get_int64 diff --git a/docs/reference/gobject/glib-mkenums.xml b/docs/reference/gobject/glib-mkenums.xml index 545857f22..a59cacf43 100644 --- a/docs/reference/gobject/glib-mkenums.xml +++ b/docs/reference/gobject/glib-mkenums.xml @@ -32,17 +32,16 @@ Description -glib-mkenums is a small perl-script utility that -parses C code to extract enum definitions and produces enum descriptions based -on text templates specified by the user. Most frequently this script is used to -produce C code that contains enum values as strings so programs can provide -value name strings for introspection. +glib-mkenums is a small utility that parses C code to +extract enum definitions and produces enum descriptions based on text templates +specified by the user. Typically, you can use this tool to generate enumeration +types for the GType type system, for #GObject properties and signal marshalling; +additionally, you can use it to generate enumeration values of #GSettings schemas. glib-mkenums takes a list of valid C code files as -input. The options specified control the text that is output, certain -substitutions are performed on the text templates for keywords enclosed -in @ characters. +input. The options specified control the text that generated, substituting various +keywords enclosed in @ characters in the templates. Production text substitutions @@ -63,7 +62,7 @@ typedef enum The name of the enum currently being processed, enum names are assumed to be properly namespaced and to use mixed capitalization to separate -words (e.g. PrefixTheXEnum). +words (e.g. PrefixTheXEnum). @@ -71,7 +70,7 @@ words (e.g. PrefixTheXEnum). @enum_name@ The enum name with words lowercase and word-separated by underscores -(e.g. prefix_the_xenum). +(e.g. prefix_the_xenum). @@ -79,7 +78,7 @@ The enum name with words lowercase and word-separated by underscores @ENUMNAME@ The enum name with words uppercase and word-separated by underscores -(e.g. PREFIX_THE_XENUM). +(e.g. PREFIX_THE_XENUM). @@ -87,14 +86,14 @@ The enum name with words uppercase and word-separated by underscores @ENUMSHORT@ The enum name with words uppercase and word-separated by underscores, -prefix stripped (e.g. THE_XENUM). +prefix stripped (e.g. THE_XENUM). @ENUMPREFIX@ -The prefix of the enum name (e.g. PREFIX). +The prefix of the enum name (e.g. PREFIX). @@ -104,7 +103,7 @@ The prefix of the enum name (e.g. PREFIX). The enum value name currently being processed with words uppercase and word-separated by underscores, this is the assumed literal notation of enum values in the C sources -(e.g. PREFIX_THE_XVALUE). +(e.g. PREFIX_THE_XVALUE). @@ -114,19 +113,17 @@ this is the assumed literal notation of enum values in the C sources 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). +minus (e.g. the-xvalue). @valuenum@ -The integer value for the enum value currently being processed. This is -calculated by using perl to attempt to evaluate the -expression as it appears in the C source code. If evaluation fails then -glib-mkenums will exit with an error status, but this -only happens if @valuenum@ appears in your value -production template. (Since: 2.26) +The integer value for the enum value currently being processed. If the +evaluation fails then glib-mkenums will exit with an +error status, but this only happens if @valuenum@ +appears in your value production template. (Since: 2.26) @@ -162,7 +159,8 @@ The name of the input file currently being processed (e.g. foo.h). @basename@ -The base name of the input file currently being processed (e.g. foo.h). (Since: 2.22) +The base name of the input file currently being processed (e.g. foo.h). Typically +you want to use @basename@ in place of @filename@ in your templates, to improve the reproducibility of the build. (Since: 2.22) @@ -178,7 +176,7 @@ 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 >*/. +function. For instance, /*< underscore_name=gnome_vfs_uri_hide_options >*/. Per value definition, the options "skip" and "nick" are supported. -- cgit v1.2.3