Update the docs for the new network APIs

This imports the network APIs into the gio reference docs, and cleans up a bunch of gtk-doc warnings and documentation issues.
2025-07-25 19:37:52 +02:00 · 2009-05-18 13:02:11 +02:00
parent e1afc6e79b
commit 6ea86cc57f
30 changed files with 576 additions and 151 deletions
--- a/docs/reference/gio/gio-docs.xml
+++ b/docs/reference/gio/gio-docs.xml
@@ -45,9 +45,11 @@

        <xi:include href="xml/ginputstream.xml"/>        
        <xi:include href="xml/goutputstream.xml"/>
+        <xi:include href="xml/giostream.xml"/>

        <xi:include href="xml/gfileinputstream.xml"/>
        <xi:include href="xml/gfileoutputstream.xml"/>
+        <xi:include href="xml/gfileiostream.xml"/>

        <xi:include href="xml/gfilterinputstream.xml"/>        
        <xi:include href="xml/gfilteroutputstream.xml"/>
@@ -90,19 +92,38 @@
    	<xi:include href="xml/gemblemedicon.xml"/>
    	<xi:include href="xml/gemblem.xml"/>
    </chapter>
-    <chapter id="networking">
-    	<title>Networking</title>
-        <xi:include href="xml/gresolver.xml"/>
-        <xi:include href="xml/ginetaddress.xml"/>
-        <xi:include href="xml/gsocketaddress.xml"/>
-        <xi:include href="xml/ginetsocketaddress.xml"/>
-        <xi:include href="xml/gunixsocketaddress.xml"/>
-        <xi:include href="xml/gsrvtarget.xml"/>
-        <xi:include href="xml/gsocketconnectable.xml"/>
-        <xi:include href="xml/gnetworkaddress.xml"/>
-        <xi:include href="xml/gnetworkservice.xml"/>
+    <chapter id="failable_initialization">
+    	<title>Failable Initialization</title>
+    	<xi:include href="xml/ginitable.xml"/>
+    	<xi:include href="xml/gasyncinitable.xml"/>
    </chapter>
-    <chapter id="utils">   
+    <chapter id="networking">
+      <title>Lowlevel platform-independent network support</title>
+      <xi:include href="xml/gsocket.xml"/>
+      <xi:include href="xml/ginetaddress.xml"/>
+      <xi:include href="xml/gsocketaddress.xml"/>
+      <xi:include href="xml/ginetsocketaddress.xml"/>
+      <xi:include href="xml/gunixsocketaddress.xml"/>
+      <xi:include href="xml/gsocketcontrolmessage.xml"/>
+      <xi:include href="xml/gunixfdmessage.xml"/>
+    </chapter>
+    <chapter id="resolver">
+      <title>DNS resolution</title>
+      <xi:include href="xml/gresolver.xml"/>
+      <xi:include href="xml/gsocketconnectable.xml"/>
+      <xi:include href="xml/gnetworkaddress.xml"/>
+      <xi:include href="xml/gnetworkservice.xml"/>
+      <xi:include href="xml/gsrvtarget.xml"/>
+    </chapter>
+    <chapter id="highlevel-socket">
+      <title>Highlevel network functionallity</title>
+      <xi:include href="xml/gsocketclient.xml"/>
+      <xi:include href="xml/gsocketconnection.xml"/>
+      <xi:include href="xml/gsocketlistener.xml"/>
+      <xi:include href="xml/gsocketservice.xml"/>
+      <xi:include href="xml/gthreadedsocketservice.xml"/>
+    </chapter>
+    <chapter id="utils">
    	<title>Utilities</title>
        <xi:include href="xml/gfilenamecompleter.xml"/>
    </chapter>
--- a/docs/reference/gio/gio-sections.txt
+++ b/docs/reference/gio/gio-sections.txt
@@ -1,3 +1,43 @@
+<SECTION>
+<FILE>ginitable</FILE>
+<TITLE>GInitable</TITLE>
+GInitable
+GInitableIface
+g_initable_init
+g_initable_new
+g_initable_new_valist
+g_initable_newv
+<SUBSECTION Standard>
+G_INITABLE
+G_INITABLE_GET_IFACE
+G_IS_INITABLE
+G_TYPE_INITABLE
+G_TYPE_IS_INITABLE
+<SUBSECTION Private>
+g_initable_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gasyncinitable</FILE>
+<TITLE>GAsyncInitable</TITLE>
+GAsyncInitable
+GAsyncInitableIface
+g_async_initable_init_async
+g_async_initable_init_finish
+g_async_initable_new_async
+g_async_initable_new_finish
+g_async_initable_new_valist_async
+g_async_initable_newv_async
+<SUBSECTION Standard>
+G_ASYNC_INITABLE
+G_ASYNC_INITABLE_GET_IFACE
+G_IS_ASYNC_INITABLE
+G_TYPE_ASYNC_INITABLE
+G_TYPE_IS_ASYNC_INITABLE
+<SUBSECTION Private>
+g_async_initable_get_type
+</SECTION>
+
 <SECTION>
 <FILE>gvfs</FILE>
 <TITLE>GVfs</TITLE>
@@ -125,6 +165,15 @@ g_file_replace_contents
 g_file_replace_contents_async
 g_file_replace_contents_finish
 g_file_copy_attributes
+g_file_create_readwrite
+g_file_create_readwrite_async
+g_file_create_readwrite_finish
+g_file_open_readwrite
+g_file_open_readwrite_async
+g_file_open_readwrite_finish
+g_file_replace_readwrite
+g_file_replace_readwrite_async
+g_file_replace_readwrite_finish
 <SUBSECTION Standard>
 G_FILE
 G_IS_FILE
@@ -453,6 +502,7 @@ g_emblem_new_with_origin
 g_emblem_get_icon
 g_emblem_get_origin
 <SUBSECTION Private>
+GEmblemClass
 g_emblem_get_type
 G_EMBLEM
 G_EMBLEM_CLASS
@@ -530,7 +580,6 @@ G_IS_FILTER_INPUT_STREAM_CLASS
 G_FILTER_INPUT_STREAM_GET_CLASS
 <SUBSECTION Private>
 g_filter_input_stream_get_type
-GFilterInputStreamPrivate
 </SECTION>

 <SECTION>
@@ -712,7 +761,6 @@ G_IS_FILTER_OUTPUT_STREAM_CLASS
 G_FILTER_OUTPUT_STREAM_GET_CLASS
 <SUBSECTION Private>
 g_filter_output_stream_get_type
-GFilterOutputStreamPrivate
 </SECTION>

 <SECTION>
@@ -786,7 +834,6 @@ G_DATA_OUTPUT_STREAM_GET_CLASS
 <SUBSECTION Private>
 g_data_output_stream_get_type
 GDataOutputStreamPrivate
-
 </SECTION>

 <SECTION>
@@ -810,6 +857,53 @@ g_unix_output_stream_get_type
 GUnixOutputStreamPrivate
 </SECTION>

+<SECTION>
+<FILE>giostream</FILE>
+<TITLE>GIOStream</TITLE>
+GIOStream
+g_io_stream_clear_pending
+g_io_stream_close
+g_io_stream_close_async
+g_io_stream_close_finish
+g_io_stream_get_input_stream
+g_io_stream_get_output_stream
+g_io_stream_has_pending
+g_io_stream_is_closed
+g_io_stream_set_pending
+<SUBSECTION Standard>
+GIOStreamClass
+G_IO_STREAM
+G_IO_STREAM_CLASS
+G_IO_STREAM_GET_CLASS
+G_IS_IO_STREAM
+G_IS_IO_STREAM_CLASS
+G_TYPE_IO_STREAM
+<SUBSECTION Private>
+GIOStreamPrivate
+g_io_stream_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gfileiostream</FILE>
+<TITLE>GFileIOStream</TITLE>
+GFileIOStream
+g_file_io_stream_get_etag
+g_file_io_stream_query_info
+g_file_io_stream_query_info_async
+g_file_io_stream_query_info_finish
+<SUBSECTION Standard>
+GFileIOStreamClass
+G_FILE_IO_STREAM
+G_FILE_IO_STREAM_CLASS
+G_FILE_IO_STREAM_GET_CLASS
+G_IS_FILE_IO_STREAM
+G_IS_FILE_IO_STREAM_CLASS
+G_TYPE_FILE_IO_STREAM
+<SUBSECTION Private>
+GFileIOStreamPrivate
+g_file_io_stream_get_type
+</SECTION>
+
 <SECTION>
 <FILE>gseekable</FILE>
 <TITLE>GSeekable</TITLE>
@@ -1449,8 +1543,7 @@ g_srv_target_get_hostname
 g_srv_target_get_port
 g_srv_target_get_priority
 g_srv_target_get_weight
-g_srv_target_get_expires
-g_srv_target_array_sort
+g_srv_target_list_sort
 <SUBSECTION Standard>
 G_TYPE_SRV_TARGET
 <SUBSECTION Private>
@@ -1491,8 +1584,8 @@ g_socket_connectable_get_type
 GNetworkAddress
 g_network_address_new
 g_network_address_get_hostname
-g_network_address_get_ascii_name
 g_network_address_get_port
+g_network_address_parse
 <SUBSECTION Standard>
 GNetworkAddressClass
 GNetworkAddressPrivate
@@ -1514,7 +1607,6 @@ g_network_service_new
 g_network_service_get_service
 g_network_service_get_protocol
 g_network_service_get_domain
-g_network_service_get_expires
 <SUBSECTION Standard>
 GNetworkServiceClass
 GNetworkServicePrivate
@@ -1527,3 +1619,247 @@ G_TYPE_NETWORK_SERVICE
 <SUBSECTION Private>
 g_network_service_get_type
 </SECTION>
+
+<SECTION>
+<FILE>gsocket</FILE>
+<TITLE>GSocket</TITLE>
+GSocket
+GSocketSourceFunc
+GSocketType
+GSocketMsgFlags
+g_socket_new
+g_socket_new_from_fd
+g_socket_bind
+g_socket_listen
+g_socket_accept
+g_socket_connect
+g_socket_check_pending_error
+g_socket_receive
+g_socket_receive_from
+g_socket_receive_message
+g_socket_send
+g_socket_send_to
+g_socket_send_message
+g_socket_close
+g_socket_is_closed
+g_socket_is_connected
+g_socket_create_source
+g_socket_condition_check
+g_socket_condition_wait
+g_socket_set_listen_backlog
+g_socket_get_listen_backlog
+g_socket_get_blocking
+g_socket_set_blocking
+g_socket_get_keepalive
+g_socket_set_keepalive
+g_socket_get_family
+g_socket_get_fd
+g_socket_get_local_address
+g_socket_get_protocol_id
+g_socket_get_protocol_name
+g_socket_get_remote_address
+g_socket_get_socket_type
+g_socket_protocol_id_lookup_by_name
+<SUBSECTION Standard>
+GSocketClass
+G_IS_SOCKET
+G_IS_SOCKET_CLASS
+G_SOCKET
+G_SOCKET_CLASS
+G_TYPE_SOCKET
+G_SOCKET_GET_CLASS
+<SUBSECTION Private>
+g_socket_get_type
+GSocketPrivate
+</SECTION>
+
+<SECTION>
+<FILE>gsocketclient</FILE>
+<TITLE>GSocketClient</TITLE>
+GSocketClient
+g_socket_client_new
+g_socket_client_connect
+g_socket_client_connect_async
+g_socket_client_connect_finish
+g_socket_client_connect_to_host
+g_socket_client_connect_to_host_async
+g_socket_client_connect_to_host_finish
+g_socket_client_set_family
+g_socket_client_set_local_address
+g_socket_client_set_protocol
+g_socket_client_set_socket_type
+g_socket_client_get_family
+g_socket_client_get_local_address
+g_socket_client_get_protocol
+g_socket_client_get_socket_type
+<SUBSECTION Standard>
+GSocketClientClass
+G_IS_SOCKET_CLIENT
+G_IS_SOCKET_CLIENT_CLASS
+G_SOCKET_CLIENT
+G_SOCKET_CLIENT_CLASS
+G_SOCKET_CLIENT_GET_CLASS
+G_TYPE_SOCKET_CLIENT
+<SUBSECTION Private>
+GSocketClientPrivate
+g_socket_client_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gsocketconnection</FILE>
+<TITLE>GSocketConnection</TITLE>
+GSocketConnection
+g_socket_connection_get_local_address
+g_socket_connection_get_remote_address
+g_socket_connection_get_socket
+<SUBSECTION>
+GTcpConnection
+<SUBSECTION>
+GUnixConnection
+g_unix_connection_receive_fd
+g_unix_connection_send_fd
+<SUBSECTION>
+g_socket_connection_factory_create_connection
+g_socket_connection_factory_lookup_type
+g_socket_connection_factory_register_type
+<SUBSECTION Standard>
+GSocketConnectionClass
+G_IS_SOCKET_CONNECTION
+G_IS_SOCKET_CONNECTION_CLASS
+G_SOCKET_CONNECTION
+G_SOCKET_CONNECTION_CLASS
+G_SOCKET_CONNECTION_GET_CLASS
+G_TYPE_SOCKET_CONNECTION
+GTcpConnectionClass
+G_IS_TCP_CONNECTION
+G_IS_TCP_CONNECTION_CLASS
+G_TCP_CONNECTION
+G_TCP_CONNECTION_CLASS
+G_TCP_CONNECTION_GET_CLASS
+G_TYPE_TCP_CONNECTION
+GUnixConnectionClass
+G_IS_UNIX_CONNECTION
+G_IS_UNIX_CONNECTION_CLASS
+G_TYPE_UNIX_CONNECTION
+G_UNIX_CONNECTION
+G_UNIX_CONNECTION_CLASS
+G_UNIX_CONNECTION_GET_CLASS
+<SUBSECTION Private>
+GSocketConnectionPrivate
+g_socket_connection_get_type
+GTcpConnectionPrivate
+g_tcp_connection_get_type
+GUnixConnectionPrivate
+g_unix_connection_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gsocketcontrolmessage</FILE>
+<TITLE>GSocketControlMessage</TITLE>
+GSocketControlMessage
+g_socket_control_message_deserialize
+g_socket_control_message_get_level
+g_socket_control_message_get_msg_type
+g_socket_control_message_get_size
+g_socket_control_message_serialize
+<SUBSECTION Standard>
+GSocketControlMessageClass
+G_IS_SOCKET_CONTROL_MESSAGE
+G_IS_SOCKET_CONTROL_MESSAGE_CLASS
+G_SOCKET_CONTROL_MESSAGE
+G_SOCKET_CONTROL_MESSAGE_CLASS
+G_SOCKET_CONTROL_MESSAGE_GET_CLASS
+G_TYPE_SOCKET_CONTROL_MESSAGE
+<SUBSECTION Private>
+GSocketControlMessagePrivate
+g_socket_control_message_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gsocketlistener</FILE>
+<TITLE>GSocketListener</TITLE>
+GSocketListener
+g_socket_listener_new
+g_socket_listener_add_socket
+g_socket_listener_add_address
+g_socket_listener_add_inet_port
+g_socket_listener_accept
+g_socket_listener_accept_async
+g_socket_listener_accept_finish
+g_socket_listener_accept_socket
+g_socket_listener_accept_socket_async
+g_socket_listener_accept_socket_finish
+g_socket_listener_close
+g_socket_listener_set_backlog
+<SUBSECTION Standard>
+GSocketListenerClass
+G_IS_SOCKET_LISTENER
+G_IS_SOCKET_LISTENER_CLASS
+G_SOCKET_LISTENER
+G_SOCKET_LISTENER_CLASS
+G_SOCKET_LISTENER_GET_CLASS
+G_TYPE_SOCKET_INPUT_STREAM
+G_TYPE_SOCKET_LISTENER
+<SUBSECTION Private>
+GSocketListenerPrivate
+g_socket_listener_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gsocketservice</FILE>
+<TITLE>GSocketService</TITLE>
+GSocketService
+g_socket_service_new
+g_socket_service_start
+g_socket_service_stop
+g_socket_service_is_active
+<SUBSECTION Standard>
+GSocketServiceClass
+G_IS_SOCKET_SERVICE
+G_IS_SOCKET_SERVICE_CLASS
+G_SOCKET_SERVICE
+G_SOCKET_SERVICE_CLASS
+G_SOCKET_SERVICE_GET_CLASS
+G_TYPE_SOCKET_SERVICE
+<SUBSECTION Private>
+GSocketServicePrivate
+g_socket_service_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gthreadedsocketservice</FILE>
+<TITLE>GThreadedSocketService</TITLE>
+GThreadedSocketService
+g_threaded_socket_service_new
+<SUBSECTION Standard>
+GThreadedSocketServiceClass
+G_IS_THREADED_SOCKET_SERVICE
+G_IS_THREADED_SOCKET_SERVICE_CLASS
+G_THREADED_SOCKET_SERVICE
+G_THREADED_SOCKET_SERVICE_CLASS
+G_THREADED_SOCKET_SERVICE_GET_CLASS
+G_TYPE_THREADED_SOCKET_SERVICE
+<SUBSECTION Private>
+GThreadedSocketServicePrivate
+g_threaded_socket_service_get_type
+</SECTION>
+
+<SECTION>
+<FILE>gunixfdmessage</FILE>
+<TITLE>GUnixFDMessage</TITLE>
+GUnixFDMessage
+g_unix_fd_message_new
+g_unix_fd_message_append_fd
+g_unix_fd_message_steal_fds
+<SUBSECTION Standard>
+GUnixFDMessageClass
+G_IS_UNIX_FD_MESSAGE
+G_IS_UNIX_FD_MESSAGE_CLASS
+G_TYPE_UNIX_FD_MESSAGE
+G_UNIX_FD_MESSAGE
+G_UNIX_FD_MESSAGE_CLASS
+G_UNIX_FD_MESSAGE_GET_CLASS
+<SUBSECTION Private>
+GUnixFDMessagePrivate
+g_unix_fd_message_get_type
+</SECTION>
--- a/docs/reference/gio/gio.types
+++ b/docs/reference/gio/gio.types
@@ -2,6 +2,7 @@ g_app_info_create_flags_get_type
 g_app_info_get_type
 g_app_launch_context_get_type
 g_ask_password_flags_get_type
+g_async_initable_get_type
 g_async_result_get_type
 g_buffered_input_stream_get_type
 g_buffered_output_stream_get_type
@@ -13,8 +14,8 @@ g_data_stream_newline_type_get_type
 g_desktop_app_info_get_type
 g_desktop_app_info_lookup_get_type
 g_drive_get_type
-g_emblemed_icon_get_type
 g_emblem_get_type
+g_emblemed_icon_get_type
 g_file_attribute_info_flags_get_type
 g_file_attribute_status_get_type
 g_file_attribute_type_get_type
@@ -25,22 +26,25 @@ g_file_get_type
 g_file_icon_get_type
 g_file_info_get_type
 g_file_input_stream_get_type
+g_file_io_stream_get_type
 g_file_monitor_event_get_type
 g_file_monitor_flags_get_type
 g_file_monitor_get_type
-g_filename_completer_get_type
 g_file_output_stream_get_type
 g_file_query_info_flags_get_type
-g_filesystem_preview_type_get_type
 g_file_type_get_type
+g_filename_completer_get_type
+g_filesystem_preview_type_get_type
 g_filter_input_stream_get_type
 g_filter_output_stream_get_type
 g_icon_get_type
 g_inet_address_get_type
 g_inet_socket_address_get_type
+g_initable_get_type
 g_input_stream_get_type
 g_io_error_enum_get_type
 g_io_module_get_type
+g_io_stream_get_type
 g_loadable_icon_get_type
 g_local_directory_monitor_get_type
 g_local_file_monitor_get_type
@@ -62,8 +66,18 @@ g_seekable_get_type
 g_simple_async_result_get_type
 g_socket_address_enumerator_get_type
 g_socket_address_get_type
+g_socket_client_get_type
 g_socket_connectable_get_type
+g_socket_connection_get_type
+g_socket_control_message_get_type
+g_socket_get_type
+g_socket_listener_get_type
+g_socket_service_get_type
+g_tcp_connection_get_type
 g_themed_icon_get_type
+g_threaded_socket_service_get_type
+g_unix_connection_get_type
+g_unix_fd_message_get_type
 g_unix_input_stream_get_type
 g_unix_mount_monitor_get_type
 g_unix_output_stream_get_type
--- a/docs/reference/gio/overview.xml
+++ b/docs/reference/gio/overview.xml
@@ -53,6 +53,10 @@
         <term>GOutputStream</term>
         <listitem><para>write data</para></listitem>
       </varlistentry>
+       <varlistentry>
+         <term>GIOStream</term>
+         <listitem><para>read and write data</para></listitem>
+       </varlistentry>
       <varlistentry>
         <term>GSeekable</term>
         <listitem><para>interface optionally implemented by streams to support seeking</para></listitem>
@@ -70,6 +74,30 @@
          <listitem><para>abstract type for file and application icons</para></listitem>
       </varlistentry>
    </variablelist>
+    There is support for network programming, including name resolution, lowlevel socket
+    APIs and highlevel client and server helper classes:
+    <variablelist>
+       <varlistentry>
+          <term>GSocket</term>
+          <listitem><para>lowlevel platform independent socket object</para></listitem>
+       </varlistentry>
+       <varlistentry>
+          <term>GResolver</term>
+          <listitem><para>asynchronous and cancellable DNS resolver</para></listitem>
+       </varlistentry>
+       <varlistentry>
+          <term>GSocketClient</term>
+          <listitem><para>high-level network client helper</para></listitem>
+       </varlistentry>
+       <varlistentry>
+          <term>GSocketService</term>
+          <listitem><para>high-level network server helper</para></listitem>
+       </varlistentry>
+       <varlistentry>
+          <term>GSocketConnection</term>
+          <listitem><para>network connection stream</para></listitem>
+       </varlistentry>
+    </variablelist>
    Beyond these, GIO provides facilities for file monitoring,
    asynchronous I/O and filename completion. In addition to the 
    interfaces, GIO provides implementations for the local case. 
--- a/docs/reference/glib/tmpl/glib-unused.sgml
+++ b/docs/reference/glib/tmpl/glib-unused.sgml
@@ -900,6 +900,73 @@ Turns the argument into a string literal by using the '#' stringizing operator.
 </para>


+<!-- ##### VARIABLE glib_binary_age ##### -->
+<para>
+This is the binary age passed to <application>libtool</application>. If 
+<application>libtool</application> means nothing to you, don't worry 
+about it. ;-)
+</para>
+
+
+<!-- ##### FUNCTION glib_check_version ##### -->
+<para>
+
+</para>
+
+@required_major: 
+@required_minor: 
+@required_micro: 
+@Returns: 
+
+<!-- ##### VARIABLE glib_interface_age ##### -->
+<para>
+This is the interface age passed to <application>libtool</application>. If 
+<application>libtool</application> means nothing to you, don't worry 
+about it. ;-)
+</para>
+
+
+<!-- ##### VARIABLE glib_major_version ##### -->
+<para>
+The major version number of the GLib library. 
+(e.g. in GLib version 1.2.5 this is 1.)
+</para>
+
+<para>
+This variable is in the library, so represents the
+GLib library you have linked against. Contrast with the
+#GLIB_MAJOR_VERSION macro, which represents the major version of the
+GLib headers you have included.
+</para>
+
+
+<!-- ##### VARIABLE glib_micro_version ##### -->
+<para>
+The micro version number of the GLib library.
+(e.g. in GLib version 1.2.5 this is 5.)
+</para>
+
+<para>
+This variable is in the library, so represents the GLib library you
+have linked against. Contrast with the #GLIB_MICRO_VERSION macro, which
+represents the micro version of the GLib headers you have included.
+</para>
+
+
+<!-- ##### VARIABLE glib_minor_version ##### -->
+<para>
+The minor version number of the GLib library.
+(e.g. in GLib version 1.2.5 this is 2.)
+</para>
+
+<para>
+This variable is in the library, so represents the
+GLib library you have linked against. Contrast with the
+#GLIB_MINOR_VERSION macro, which represents the minor version of the
+GLib headers you have included.
+</para>
+
+
 <!-- ##### MACRO lseek ##### -->
 <para>

--- a/docs/reference/glib/tmpl/macros_misc.sgml
+++ b/docs/reference/glib/tmpl/macros_misc.sgml
@@ -403,7 +403,7 @@ Since: 2.14



-<!-- ##### FUNCTION G_LIKELY ##### -->
+<!-- ##### MACRO G_LIKELY ##### -->
 <para>
 Hints the compiler that the expression is likely to evaluate to a true
 value. The compiler may use this information for optimizations.
@@ -413,10 +413,9 @@ if (G_LIKELY (random () != 1))
  g_print ("not one");
 </programlisting></informalexample>

+@expr: the expression
@Returns: the value of @expr
@Since: 2.2
-<!-- # Unused Parameters # -->
-@expr: the expression


 <!-- ##### MACRO G_UNLIKELY ##### -->
--- a/docs/reference/glib/tmpl/version.sgml
+++ b/docs/reference/glib/tmpl/version.sgml
@@ -19,74 +19,6 @@ typically use the features described here.
 <!-- ##### SECTION Stability_Level ##### -->


-<!-- ##### VARIABLE glib_major_version ##### -->
-<para>
-The major version number of the GLib library. 
-(e.g. in GLib version 1.2.5 this is 1.)
-</para>
-
-<para>
-This variable is in the library, so represents the
-GLib library you have linked against. Contrast with the
-#GLIB_MAJOR_VERSION macro, which represents the major version of the
-GLib headers you have included.
-</para>
-
-
-<!-- ##### VARIABLE glib_minor_version ##### -->
-<para>
-The minor version number of the GLib library.
-(e.g. in GLib version 1.2.5 this is 2.)
-</para>
-
-<para>
-This variable is in the library, so represents the
-GLib library you have linked against. Contrast with the
-#GLIB_MINOR_VERSION macro, which represents the minor version of the
-GLib headers you have included.
-</para>
-
-
-<!-- ##### VARIABLE glib_micro_version ##### -->
-<para>
-The micro version number of the GLib library.
-(e.g. in GLib version 1.2.5 this is 5.)
-</para>
-
-<para>
-This variable is in the library, so represents the GLib library you
-have linked against. Contrast with the #GLIB_MICRO_VERSION macro, which
-represents the micro version of the GLib headers you have included.
-</para>
-
-
-<!-- ##### VARIABLE glib_binary_age ##### -->
-<para>
-This is the binary age passed to <application>libtool</application>. If 
-<application>libtool</application> means nothing to you, don't worry 
-about it. ;-)
-</para>
-
-
-<!-- ##### VARIABLE glib_interface_age ##### -->
-<para>
-This is the interface age passed to <application>libtool</application>. If 
-<application>libtool</application> means nothing to you, don't worry 
-about it. ;-)
-</para>
-
-
-<!-- ##### FUNCTION glib_check_version ##### -->
-<para>
-
-</para>
-
-@required_major: 
-@required_minor: 
-@required_micro: 
-@Returns: 
-
-
 <!-- ##### MACRO GLIB_MAJOR_VERSION ##### -->
 <para>
 The major version number of the GLib library.