diff options
author | Hyunjee Kim <hj0426.kim@samsung.com> | 2019-12-03 09:47:46 +0900 |
---|---|---|
committer | Hyunjee Kim <hj0426.kim@samsung.com> | 2019-12-03 09:47:46 +0900 |
commit | 341683cfae94bb8234f60972c4c022bf95f3c577 (patch) | |
tree | ec0ef91cf025b25f28464768d4794376f9886d36 /docs/reference | |
parent | 2edc4beaf99a0eb139005443a9ed9ebad1d4cf5f (diff) | |
download | glib-341683cfae94bb8234f60972c4c022bf95f3c577.tar.gz glib-341683cfae94bb8234f60972c4c022bf95f3c577.tar.bz2 glib-341683cfae94bb8234f60972c4c022bf95f3c577.zip |
Imported Upstream version 2.55.1
Diffstat (limited to 'docs/reference')
-rw-r--r-- | docs/reference/README | 63 | ||||
-rw-r--r-- | docs/reference/gio/gio-docs.xml | 2 | ||||
-rw-r--r-- | docs/reference/gio/gio-sections.txt | 34 | ||||
-rw-r--r-- | docs/reference/gio/gsettings.xml | 4 | ||||
-rw-r--r-- | docs/reference/gio/meson.build | 7 | ||||
-rw-r--r-- | docs/reference/glib/building.xml | 208 | ||||
-rw-r--r-- | docs/reference/glib/glib-sections.txt | 2 | ||||
-rw-r--r-- | docs/reference/glib/meson.build | 4 | ||||
-rw-r--r-- | docs/reference/gobject/gobject-sections.txt | 2 | ||||
-rw-r--r-- | docs/reference/gobject/meson.build | 7 | ||||
-rw-r--r-- | docs/reference/gobject/tut_gobject.xml | 6 | ||||
-rw-r--r-- | docs/reference/gobject/tut_howto.xml | 2 |
12 files changed, 156 insertions, 185 deletions
diff --git a/docs/reference/README b/docs/reference/README deleted file mode 100644 index 895028105..000000000 --- a/docs/reference/README +++ /dev/null @@ -1,63 +0,0 @@ -This package contains the reference documentation -for GLib. For more information about Glib, -see: - - http://www.gtk.org - -For information about contributing to the -GLib/GTK+ reference documentation project, see: - - http://www.gtk.org/rdp/ - -The GLib reference documentation is freely redistributable, -see the file COPYING for details. - - -REQUIREMENTS -============ - -To build the documentation, you must have the gtk-doc -package installed. To rebuild the template files, -you must have the current version of the GLib -header files installed. - - -BUILD -===== - -First, run configure to generate the makefiles for this -module. There is one option specific to this package - - --with-html-dir=DIR top of installed HTML documentation tree - - -The Makefiles for this module define three targets: - - templates: - - Scan the headers and merge the results with the current - template files - - sgml: - - Generate SGML files using the DocBook DTD from - the template files - - html: - - Generate HTML from the SGML files. - -To build the documentation, do: - - make sgml - make html - -You should only run the 'make templates' step if you -need to regenerate the templates for a more recent -version of the GLib sources. - - -INSTALLATION -============ - - make install diff --git a/docs/reference/gio/gio-docs.xml b/docs/reference/gio/gio-docs.xml index bc23bf946..6abd0ea79 100644 --- a/docs/reference/gio/gio-docs.xml +++ b/docs/reference/gio/gio-docs.xml @@ -167,6 +167,8 @@ <xi:include href="xml/gproxyresolver.xml"/> <xi:include href="xml/gsimpleproxyresolver.xml"/> <xi:include href="xml/gsocketconnectable.xml"/> + <xi:include href="xml/gsocketaddressenumerator.xml"/> + <xi:include href="xml/gproxyaddressenumerator.xml"/> <xi:include href="xml/gnetworkaddress.xml"/> <xi:include href="xml/gnetworkservice.xml"/> <xi:include href="xml/gsrvtarget.xml"/> diff --git a/docs/reference/gio/gio-sections.txt b/docs/reference/gio/gio-sections.txt index e0472f7ca..277ca6184 100644 --- a/docs/reference/gio/gio-sections.txt +++ b/docs/reference/gio/gio-sections.txt @@ -1609,6 +1609,7 @@ g_desktop_app_info_get_keywords g_desktop_app_info_get_startup_wm_class g_desktop_app_info_set_desktop_env g_desktop_app_info_get_string +g_desktop_app_info_get_locale_string g_desktop_app_info_get_boolean g_desktop_app_info_has_key GDesktopAppLaunchCallback @@ -1937,26 +1938,40 @@ GSocketConnectableIface g_socket_connectable_enumerate g_socket_connectable_proxy_enumerate g_socket_connectable_to_string -<SUBSECTION> -GSocketAddressEnumerator -g_socket_address_enumerator_next -g_socket_address_enumerator_next_async -g_socket_address_enumerator_next_finish -<SUBSECTION> -GProxyAddressEnumerator <SUBSECTION Standard> G_IS_SOCKET_CONNECTABLE G_SOCKET_CONNECTABLE G_SOCKET_CONNECTABLE_GET_IFACE G_TYPE_SOCKET_CONNECTABLE +<SUBSECTION Private> +g_socket_connectable_get_type +</SECTION> + +<SECTION> +<FILE>gsocketaddressenumerator</FILE> +<TITLE>GSocketAddressEnumerator</TITLE> +GSocketAddressEnumerator GSocketAddressEnumeratorClass +g_socket_address_enumerator_next +g_socket_address_enumerator_next_async +g_socket_address_enumerator_next_finish +<SUBSECTION Standard> G_IS_SOCKET_ADDRESS_ENUMERATOR G_IS_SOCKET_ADDRESS_ENUMERATOR_CLASS G_SOCKET_ADDRESS_ENUMERATOR G_SOCKET_ADDRESS_ENUMERATOR_CLASS G_SOCKET_ADDRESS_ENUMERATOR_GET_CLASS G_TYPE_SOCKET_ADDRESS_ENUMERATOR +<SUBSECTION Private> +g_socket_address_enumerator_get_type +</SECTION> + +<SECTION> +<FILE>gproxyaddressenumerator</FILE> +<TITLE>GProxyAddressEnumerator</TITLE> +GProxyAddressEnumerator GProxyAddressEnumeratorClass +<SUBSECTION Standard> G_IS_PROXY_ADDRESS_ENUMERATOR G_IS_PROXY_ADDRESS_ENUMERATOR_CLASS G_PROXY_ADDRESS_ENUMERATOR @@ -1966,8 +1981,6 @@ G_TYPE_PROXY_ADDRESS_ENUMERATOR <SUBSECTION Private> GProxyAddressEnumeratorPrivate g_proxy_address_enumerator_get_type -g_socket_address_enumerator_get_type -g_socket_connectable_get_type </SECTION> <SECTION> @@ -3220,6 +3233,9 @@ g_application_run g_application_add_main_option_entries g_application_add_main_option g_application_add_option_group +g_application_set_option_context_parameter_string +g_application_set_option_context_summary +g_application_set_option_context_description <SUBSECTION> g_application_set_default g_application_get_default diff --git a/docs/reference/gio/gsettings.xml b/docs/reference/gio/gsettings.xml index 9528b9dd7..d7dc65db6 100644 --- a/docs/reference/gio/gsettings.xml +++ b/docs/reference/gio/gsettings.xml @@ -75,6 +75,7 @@ <cmdsynopsis> <command>gsettings</command> <arg choice="plain">list-schemas</arg> + <arg choice="opt">--print-paths</arg> </cmdsynopsis> <cmdsynopsis> <command>gsettings</command> @@ -198,7 +199,8 @@ Reset all keys under the given <replaceable>SCHEMA</replaceable>. <listitem><para> Lists the installed, non-relocatable schemas. See <option>list-relocatable-schemas</option> if you are interested in -relocatable schemas. +relocatable schemas. If <optional><option>--print-paths</option></optional> +is given, the path where each schema is mapped is also printed. </para></listitem> </varlistentry> diff --git a/docs/reference/gio/meson.build b/docs/reference/gio/meson.build index e6b1386f6..33d1557ac 100644 --- a/docs/reference/gio/meson.build +++ b/docs/reference/gio/meson.build @@ -1,4 +1,4 @@ -if get_option('with-docs') != 'no' +if get_option('gtk_doc') subdir('xml') ignore_headers = [ @@ -52,9 +52,12 @@ if get_option('with-docs') != 'no' 'gnetworkmonitorbase.h', 'gnetworkmonitornetlink.h', 'gnetworkmonitornm.h', + 'gnetworkmonitorportal.h', 'gnotificationbackend.h', 'gnotification-private.h', + 'gosxappinfo.h', 'gpollfilemonitor.h', + 'gproxyresolverportal.h', 'gregistrysettingsbackend.h', 'gresourcefile.h', 'gsettingsbackendinternal.h', @@ -202,7 +205,7 @@ if get_option('with-docs') != 'no' endif -if get_option('with-man') != 'no' and xsltproc.found() +if get_option('man') manpages = ['gapplication', 'gio-querymodules', 'glib-compile-schemas', 'glib-compile-resources', 'gsettings', 'gresource', 'gdbus', 'gio', 'gdbus-codegen'] diff --git a/docs/reference/glib/building.xml b/docs/reference/glib/building.xml index 492b5ed5a..57c3c8c7d 100644 --- a/docs/reference/glib/building.xml +++ b/docs/reference/glib/building.xml @@ -42,8 +42,15 @@ the standard options. </para> <para> + GLib is compiled with + <ulink url="https://gcc.gnu.org/onlinedocs/gcc/Optimize-Options.html#index-fstrict-aliasing">strict aliasing</ulink> + disabled. It is strongly recommended that this is not re-enabled by + overriding the compiler flags, as GLib has not been tested with strict + aliasing and cannot be guaranteed to work. + </para> + <para> The GTK+ documentation contains - <ulink url="../gtk/gtk-building.html">further details</ulink> + <ulink url="https://developer.gnome.org/gtk3/stable/gtk-building.html">further details</ulink> about the build process and ways to influence it. </para> </refsect1> @@ -52,26 +59,23 @@ <para> Before you can compile the GLib library, you need to have various other tools and libraries installed on your system. - Beyond a C compiler (which must implement C90, but does not need - to implement C99), the two tools needed during the build process - (as differentiated from the tools used in when creating GLib - mentioned above such as <application>autoconf</application>) are - <command>pkg-config</command> and GNU make. + If you are building from a release archive, you will need + <ulink url="https://wiki.gnome.org/Projects/GLib/CompilerRequirements">a compliant C toolchain</ulink>, + GNU Make, and <application>pkg-config</application>; + if you are building directly from a Git repository clone + of GLib, you will also need the GNU Autotools mentioned + above. </para> <itemizedlist> <listitem> <para> - <ulink url="http://www.freedesktop.org/software/pkgconfig/">pkg-config</ulink> + <ulink url="https://www.freedesktop.org/wiki/Software/pkg-config/">pkg-config</ulink> is a tool for tracking the compilation flags needed for libraries that are used by the GLib library. (For each library, a small <literal>.pc</literal> text file is installed in a standard location that contains the compilation flags needed for that library along with version number - information.) The version of <command>pkg-config</command> - needed to build GLib is mirrored in the - <filename>dependencies</filename> directory - on the <ulink url="ftp://ftp.gtk.org/pub/gtk/v2.2/">GTK+ FTP - site.</ulink> + information). </para> </listitem> <listitem> @@ -107,7 +111,7 @@ <para> If your system has an <function>iconv()</function> implementation but you want to use libiconv instead, you can pass the - --with-libiconv option to configure. This forces + <option>--with-libiconv</option> option to configure. This forces libiconv to be used. </para> <para> @@ -151,20 +155,21 @@ <listitem> <para> GRegex uses the <ulink url="http://www.pcre.org/">PCRE library</ulink> - for regular expression matching. The default is to use the internal - version of PCRE that is patched to use GLib for memory management - and Unicode handling. If you prefer to use the system-supplied PCRE - library you can pass the <option>--with-pcre=system</option> option - to, but it is not recommended. + for regular expression matching. The default is to use the system + version of PCRE, to reduce the chances of security fixes going out + of sync. GLib additionally provides an internal copy of PCRE in case + the system version is too old, or does not support UTF-8; the internal + copy is patched to use GLib for memory management and to share the + same Unicode tables. </para> </listitem> <listitem> <para> The optional extended attribute support in GIO requires the - getxattr() family of functions that may be provided by glibc or - by the standalone libattr library. To build GLib without extended - attribute support, use the <option>--disable-xattr</option> - option. + <function>getxattr()</function> family of functions that may be + provided by the C library or by the standalone libattr library. To + build GLib without extended attribute support, use the + <option>--disable-xattr</option> option. </para> </listitem> <listitem> @@ -187,7 +192,9 @@ The optional support for <ulink url="http://sourceware.org/systemtap/">SystemTap</ulink> can be disabled with the <option>--disable-systemtap</option> - configure option. + configure option. Additionally, you can control the location + where GLib installs the SystemTap probes, using the + <option>--with-tapset-install-dir=DIR</option> configure option. </para> </listitem> </itemizedlist> @@ -203,15 +210,16 @@ </para> <formalpara> - <title><systemitem>--enable-debug</systemitem></title> + <title><option>--enable-debug</option></title> <para> Turns on various amounts of debugging support. Setting this to 'no' - disables g_assert(), g_return_if_fail(), g_return_val_if_fail() and - all cast checks between different object types. Setting it to 'minimum' disables only cast checks. Setting it to 'yes' enables - <link linkend="G-DEBUG:CAPS">runtime debugging</link>. - The default is 'minimum'. - Note that 'no' is fast, but dangerous as it tends to destabilize + disables <function>g_assert()</function>, <function>g_return_if_fail()</function>, + <function>g_return_val_if_fail()</function> and all cast checks + between different object types. Setting it to 'minimum' disables + only cast checks. Setting it to 'yes' enables <link linkend="G-DEBUG:CAPS">runtime debugging</link>. + The default is 'minimum' for stable releases, and 'yes' for development + snapshots. Note that 'no' is fast, but dangerous as it tends to destabilize even mostly bug-free software by changing the effect of many bugs from simple warnings into fatal crashes. Thus <option>--enable-debug=no</option> should <emphasis>not</emphasis> @@ -220,26 +228,26 @@ </formalpara> <formalpara> - <title><systemitem>--disable-gc-friendly</systemitem> and - <systemitem>--enable-gc-friendly</systemitem></title> + <title><option>--disable-gc-friendly</option> and + <option>--enable-gc-friendly</option></title> <para> - By default, and with <systemitem>--disable-gc-friendly</systemitem> - as well, Glib does not clear the memory for certain objects before - they are freed. For example, Glib may decide to recycle GList nodes + By default, and with <option>--disable-gc-friendly</option> + as well, GLib does not clear the memory for certain objects before + they are freed. For example, GLib may decide to recycle GList nodes by putting them in a free list. However, memory profiling and debugging tools like <ulink url="http://www.valgrind.org">Valgrind</ulink> work better if an application does not keep dangling pointers to freed memory (even though these pointers are no longer dereferenced), or invalid pointers inside uninitialized memory. - The <systemitem>--enable-gc-friendly</systemitem> option makes Glib + The <option>--enable-gc-friendly</option> option makes GLib clear memory in these situations: </para> <itemizedlist> <listitem> <para> - When shrinking a GArray, Glib will clear the memory no longer + When shrinking a GArray, GLib will clear the memory no longer available in the array: shrink an array from 10 bytes to 7, and the last 3 bytes will be cleared. This includes removals of single and multiple elements. @@ -247,7 +255,7 @@ </listitem> <listitem> <para> - When growing a GArray, Glib will clear the new chunk of memory. + When growing a GArray, GLib will clear the new chunk of memory. Grow an array from 7 bytes to 10 bytes, and the last 3 bytes will be cleared. </para> @@ -259,14 +267,14 @@ </listitem> <listitem> <para> - When freeing a node from a GHashTable, Glib will first clear + When freeing a node from a GHashTable, GLib will first clear the node, which used to have pointers to the key and the value stored at that node. </para> </listitem> <listitem> <para> - When destroying or removing a GTree node, Glib will clear the node, + When destroying or removing a GTree node, GLib will clear the node, which used to have pointers to the node's value, and the left and right subnodes. </para> @@ -275,13 +283,13 @@ <para> Since clearing the memory has a cost, - <systemitem>--disable-gc-friendly</systemitem> is the default. + <option>--disable-gc-friendly</option> is the default. </para> </formalpara> <formalpara> - <title><systemitem>--disable-mem-pools</systemitem> and - <systemitem>--enable-mem-pools</systemitem></title> + <title><option>--disable-mem-pools</option> and + <option>--enable-mem-pools</option></title> <para> Many small chunks of memory are often allocated via collective pools @@ -321,7 +329,7 @@ </formalpara> <formalpara> - <title><systemitem>--with-threads</systemitem></title> + <title><option>--with-threads</option></title> <para> Specify a thread implementation to use. Available options are @@ -331,19 +339,7 @@ </formalpara> <formalpara> - <title><systemitem>--disable-regex</systemitem> and - <systemitem>--enable-regex</systemitem></title> - - <para> - Do not compile GLib with regular expression support. - GLib will be smaller because it will not need the - PCRE library. This is however not recommended, as - programs may need GRegex. - </para> - </formalpara> - - <formalpara> - <title><systemitem>--with-pcre</systemitem></title> + <title><option>--with-pcre</option></title> <para> Specify whether to use the internal or the system-supplied @@ -358,30 +354,34 @@ <listitem> <para> 'system' means that GRegex will be compiled to use - the system-supplied PCRE library. + the system-supplied PCRE library; this is the default + setting. </para> </listitem> </itemizedlist> - Using the internal PCRE is the preferred solution: + Using the internal PCRE is the preferred solution if: <itemizedlist> <listitem> <para> - System-supplied PCRE has a separated copy of the big tables - used for Unicode handling. + your system has strict resource constraints; the system-supplied + PCRE has a separated copy of the tables used for Unicode + handling, whereas the internal copy shares the Unicode tables + used by GLib. </para> </listitem> <listitem> <para> - Some systems have PCRE libraries compiled without some needed - features, such as UTF-8 and Unicode support. + your system has PCRE built without some needed features, + such as UTF-8 and Unicode support. </para> </listitem> <listitem> <para> - PCRE uses some global variables for memory management and - other features. In the rare case of a program using both - GRegex and PCRE (maybe indirectly through a library), - this variables could lead to problems when they are modified. + you are planning to use both GRegex and PCRE API at the same + time, either directly or indirectly through a dependency; PCRE + uses some global variables for memory management and + other features, and if both GLib and PCRE try to access them + at the same time, this could lead to undefined behavior. </para> </listitem> </itemizedlist> @@ -389,31 +389,34 @@ </formalpara> <formalpara> - <title><systemitem>--disable-included-printf</systemitem> and - <systemitem>--enable-included-printf</systemitem></title> + <title><option>--disable-included-printf</option> and + <option>--enable-included-printf</option></title> <para> By default the <command>configure</command> script will try to auto-detect whether the C library provides a suitable set - of printf() functions. In detail, <command>configure</command> - checks that the semantics of snprintf() are as specified by C99 + of <function>printf()</function> functions. In detail, + <command>configure</command> checks that the semantics of + <function>snprintf()</function> are as specified by C99 and that positional parameters as specified in the Single Unix Specification are supported. If this not the case, GLib will - include an implementation of the printf() family. + include an implementation of the <function>printf()</function> + family. </para> <para> These options can be used to explicitly control whether - an implementation of the printf() family should be included or not. + an implementation of the <function>printf()</function> family + should be included or not. </para> </formalpara> <formalpara> - <title><systemitem>--disable-Bsymbolic</systemitem> and - <systemitem>--enable-Bsymbolic</systemitem></title> + <title><option>--disable-Bsymbolic</option> and + <option>--enable-Bsymbolic</option></title> <para> - By default, GLib uses the -Bsymbolic-functions linker - flag to avoid intra-library PLT jumps. A side-effect + By default, GLib uses the <option>-Bsymbolic-functions</option> + linker flag to avoid intra-library PLT jumps. A side-effect of this is that it is no longer possible to override internal uses of GLib functions with <envar>LD_PRELOAD</envar>. Therefore, it may make @@ -424,8 +427,8 @@ </formalpara> <formalpara> - <title><systemitem>--disable-gtk-doc</systemitem> and - <systemitem>--enable-gtk-doc</systemitem></title> + <title><option>--disable-gtk-doc</option> and + <option>--enable-gtk-doc</option></title> <para> By default the <command>configure</command> script will try @@ -442,8 +445,8 @@ </formalpara> <formalpara> - <title><systemitem>--disable-man</systemitem> and - <systemitem>--enable-man</systemitem></title> + <title><option>--disable-man</option> and + <option>--enable-man</option></title> <para> By default the <command>configure</command> script will try @@ -458,23 +461,24 @@ </formalpara> <formalpara> - <title><systemitem>--disable-xattr</systemitem> and - <systemitem>--enable-xattr</systemitem></title> + <title><option>--disable-xattr</option> and + <option>--enable-xattr</option></title> <para> By default the <command>configure</command> script will try - to auto-detect whether the getxattr() family of functions - is available. If it is, then extended attribute support - will be included in GIO. These options can be used to - explicitly control whether extended attribute support - should be included or not. getxattr() and friends can - be provided by glibc or by the standalone libattr library. + to auto-detect whether the <function>getxattr()</function> + family of functions is available. If it is, then extended + attribute support will be included in GIO. These options can + be used to explicitly control whether extended attribute + support should be included or not. <function>getxattr()</function> + and friends can be provided by glibc or by the standalone + libattr library. </para> </formalpara> <formalpara> - <title><systemitem>--disable-selinux</systemitem> and - <systemitem>--enable-selinux</systemitem></title> + <title><option>--disable-selinux</option> and + <option>--enable-selinux</option></title> <para> By default the <command>configure</command> script will @@ -486,8 +490,8 @@ </formalpara> <formalpara> - <title><systemitem>--disable-dtrace</systemitem> and - <systemitem>--enable-dtrace</systemitem></title> + <title><option>--disable-dtrace</option> and + <option>--enable-dtrace</option></title> <para> By default the <command>configure</command> script will @@ -496,8 +500,8 @@ </formalpara> <formalpara> - <title><systemitem>--disable-systemtap</systemitem> and - <systemitem>--enable-systemtap</systemitem></title> + <title><option>--disable-systemtap</option> and + <option>--enable-systemtap</option></title> <para> This option requires DTrace support. If it is available, then @@ -507,8 +511,8 @@ </formalpara> <formalpara> - <title><systemitem>--enable-coverage</systemitem> and - <systemitem>--disable-coverage</systemitem></title> + <title><option>--enable-coverage</option> and + <option>--disable-coverage</option></title> <para> Enable the generation of coverage reports for the GLib tests. @@ -520,7 +524,7 @@ </formalpara> <formalpara> - <title><systemitem>--with-runtime-libdir=RELPATH</systemitem></title> + <title><option>--with-runtime-libdir=RELPATH</option></title> <para> Allows specifying a relative path to where to install the runtime @@ -528,21 +532,21 @@ GLib applications). This can be used in operating system setups where programs using GLib needs to run before e.g. <filename>/usr</filename> is mounted. - For example, if LIBDIR is <filename>/usr/lib</filename> and + For example, if <varname>LIBDIR</varname> is <filename>/usr/lib</filename> and <filename>../../lib</filename> is passed to - <systemitem>--with-runtime-libdir</systemitem> then the + <option>--with-runtime-libdir</option> then the runtime libraries are installed into <filename>/lib</filename> rather than <filename>/usr/lib</filename>. </para> </formalpara> <formalpara> - <title><systemitem>--with-python</systemitem></title> + <title><option>--with-python=PATH</option></title> <para> Allows specifying the Python interpreter to use, either as an absolute path, - or as a program name. GLib can be built with Python 2 (at least version 2.5) - or Python 3. + or as a program name. GLib can be built with Python 2 (at least version 2.7) + or, preferably, with Python 3. </para> </formalpara> </refsect1> diff --git a/docs/reference/glib/glib-sections.txt b/docs/reference/glib/glib-sections.txt index 1aaaf6043..dd1d5dea6 100644 --- a/docs/reference/glib/glib-sections.txt +++ b/docs/reference/glib/glib-sections.txt @@ -401,6 +401,8 @@ G_INLINE_FUNC g_auto g_autoptr g_autofree +g_autolist +g_autoslist G_DEFINE_AUTOPTR_CLEANUP_FUNC G_DEFINE_AUTO_CLEANUP_CLEAR_FUNC G_DEFINE_AUTO_CLEANUP_FREE_FUNC diff --git a/docs/reference/glib/meson.build b/docs/reference/glib/meson.build index 271574dda..f0f915e96 100644 --- a/docs/reference/glib/meson.build +++ b/docs/reference/glib/meson.build @@ -1,4 +1,4 @@ -if get_option('with-docs') != 'no' +if get_option('gtk_doc') subdir('xml') ignore_headers = [ @@ -145,7 +145,7 @@ if get_option('with-docs') != 'no' install: true) endif -if get_option('with-man') != 'no' and xsltproc.found() +if get_option('man') manpages = ['glib-gettextize', 'gtester', 'gtester-report'] foreach page : manpages custom_target(page + '-man', diff --git a/docs/reference/gobject/gobject-sections.txt b/docs/reference/gobject/gobject-sections.txt index 2f4b30079..d1fc4bdc1 100644 --- a/docs/reference/gobject/gobject-sections.txt +++ b/docs/reference/gobject/gobject-sections.txt @@ -279,6 +279,8 @@ g_object_weak_ref g_object_weak_unref g_object_add_weak_pointer g_object_remove_weak_pointer +g_set_weak_pointer +g_clear_weak_pointer GToggleNotify g_object_add_toggle_ref g_object_remove_toggle_ref diff --git a/docs/reference/gobject/meson.build b/docs/reference/gobject/meson.build index 5a7aa4754..de46cf96d 100644 --- a/docs/reference/gobject/meson.build +++ b/docs/reference/gobject/meson.build @@ -1,4 +1,4 @@ -if get_option('with-docs') != 'no' +if get_option('gtk_doc') subdir('xml') ignore_headers = [ @@ -72,12 +72,15 @@ if get_option('with-docs') != 'no' configuration: version_conf ) + gtkdocincl = include_directories('.') + gnome.gtkdoc('gobject', main_xml : 'gobject-docs.xml', namespace : 'g', gobject_typesfile : join_paths(meson.current_source_dir(), 'gobject.types'), mode : 'none', dependencies : [libgobject_dep, libglib_dep], + include_directories : [gtkdocincl], src_dir : 'gobject', scan_args : [ '--deprecated-guards=G_DISABLE_DEPRECATED', @@ -106,7 +109,7 @@ if get_option('with-docs') != 'no' ) endif -if get_option('with-man') != 'no' and xsltproc.found() +if get_option('man') manpages = ['glib-mkenums', 'glib-genmarshal', 'gobject-query'] foreach page : manpages custom_target(page + '-man', diff --git a/docs/reference/gobject/tut_gobject.xml b/docs/reference/gobject/tut_gobject.xml index 8097cb649..ac5c8e1e7 100644 --- a/docs/reference/gobject/tut_gobject.xml +++ b/docs/reference/gobject/tut_gobject.xml @@ -105,9 +105,9 @@ ViewerFile *file = g_object_new (VIEWER_TYPE_FILE, NULL); This will make sure the class structure of this new object is correctly initialized. Here, <function>viewer_file_class_init</function> is expected to override the object's class methods and setup the - class' own methods. In the example above, the constructor method is - the only overridden method: it is set to - <function>viewer_file_constructor</function>. + class' own methods. In the example above, the <literal>constructed</literal> + method is the only overridden method: it is set to + <function>viewer_file_constructed</function>. </para> <para> diff --git a/docs/reference/gobject/tut_howto.xml b/docs/reference/gobject/tut_howto.xml index 0696666be..01391a970 100644 --- a/docs/reference/gobject/tut_howto.xml +++ b/docs/reference/gobject/tut_howto.xml @@ -860,7 +860,7 @@ b_method_to_call (B *obj, gint some_param) <para> The first step is to get the header right. This interface - defines two methods: + defines three methods: <informalexample><programlisting> /* * Copyright/Licensing information. |