luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-08-05 00:43:40 +02:00
Code Issues Packages Projects Releases Wiki Activity

Docs: replace <literal> by `

Browse Source
This commit is contained in:
Matthias Clasen
2014-02-06 08:04:52 -05:00
parent a35d8a4c77
commit 3232425785
62 changed files with 369 additions and 404 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
gio/gappinfo.c
View File

@@ -40,15 +40,13 @@
* As of GLib 2.20, URIs will always be converted to POSIX paths
* (using g_file_get_path()) when using g_app_info_launch() even if
* the application requested an URI and not a POSIX path. For example
* for an desktop-file based application with Exec key <literal>totem
* &percnt;U</literal> and a single URI,
* <literal>sftp://foo/file.avi</literal>, then
* <literal>/home/user/.gvfs/sftp on foo/file.avi</literal> will be
* passed. This will only work if a set of suitable GIO extensions
* (such as gvfs 2.26 compiled with FUSE support), is available and
* operational; if this is not the case, the URI will be passed
* unmodified to the application. Some URIs, such as
* <literal>mailto:</literal>, of course cannot be mapped to a POSIX
* for an desktop-file based application with Exec key `totem
* &percnt;U` and a single URI, `sftp://foo/file.avi`, then
* `/home/user/.gvfs/sftp on foo/file.avi` will be passed. This will
* only work if a set of suitable GIO extensions (such as gvfs 2.26
* compiled with FUSE support), is available and operational; if this
* is not the case, the URI will be passed unmodified to the application.
* Some URIs, such as `mailto:`, of course cannot be mapped to a POSIX
* path (in gvfs there's no FUSE mount for it); such URIs will be
* passed unmodified to the application.
*
@@ -61,31 +59,30 @@
* equal to the result of g_file_get_uri(). The following snippet
* illustrates this:
*
* <programlisting>
* |[
* GFile *f;
* char *uri;
*
* file = g_file_new_for_commandline_arg (uri_from_commandline);
*
* uri = g_file_get_uri (file);
* strcmp (uri, uri_from_commandline) == 0; // FALSE
* strcmp (uri, uri_from_commandline) == 0;
* g_free (uri);
*
* if (g_file_has_uri_scheme (file, "cdda"))
* {
* // do something special with uri
* /&ast; do something special with uri &ast;/
* }
* g_object_unref (file);
* </programlisting>
* ]|
*
* This code will work when both <literal>cdda://sr0/Track
* 1.wav</literal> and <literal>/home/user/.gvfs/cdda on sr0/Track
* 1.wav</literal> is passed to the application. It should be noted
* that it's generally not safe for applications to rely on the format
* of a particular URIs. Different launcher applications (e.g. file
* managers) may have different ideas of what a given URI means.
*
**/
* This code will work when both `cdda://sr0/Track 1.wav` and
* `/home/user/.gvfs/cdda on sr0/Track 1.wav` is passed to the
* application. It should be noted that it's generally not safe
* for applications to rely on the format of a particular URIs.
* Different launcher applications (e.g. file managers) may have
* different ideas of what a given URI means.
*/
typedef GAppInfoIface GAppInfoInterface;
G_DEFINE_INTERFACE (GAppInfo, g_app_info, G_TYPE_OBJECT)
@@ -926,7 +923,7 @@ g_app_launch_context_unsetenv (GAppLaunchContext *context,
* Gets the complete environment variable list to be passed to
* the child process when @context is used to launch an application.
* This is a %NULL-terminated array of strings, where each string has
* the form <literal>KEY=VALUE</literal>.
* the form `KEY=VALUE`.
*
* Return value: (array zero-terminated=1) (transfer full): the
* child's environment

6
gio/gapplicationcommandline.c
View File

@@ -149,9 +149,9 @@
* }
* ]|
* In this example of split commandline handling, options that start
* with <literal>--local-</literal> are handled locally, all other
* options are passed to the #GApplication::command-line handler
* which runs in the primary instance.
* with `--local-` are handled locally, all other options are passed
* to the #GApplication::command-line handler which runs in the primary
* instance.
*
* The complete example can be found here:
* [gapplication-example-cmdline2.c](https://git.gnome.org/browse/glib/tree/gio/tests/gapplication-example-cmdline2.c)

13
gio/gasyncresult.c
View File

@@ -170,13 +170,12 @@ g_async_result_get_source_object (GAsyncResult *res)
* g_simple_async_result_propagate_error(). Otherwise it returns
* %FALSE.
*
* This can be used for legacy error handling in async
* <literal>_finish ()</literal> wrapper functions that traditionally
* handled #GSimpleAsyncResult error returns themselves rather than
* calling into the virtual method. This should not be used in new
* code; #GAsyncResult errors that are set by virtual methods should
* also be extracted by virtual methods, to enable subclasses to chain
* up correctly.
* This can be used for legacy error handling in async *_finish()
* wrapper functions that traditionally handled #GSimpleAsyncResult
* error returns themselves rather than calling into the virtual method.
* This should not be used in new code; #GAsyncResult errors that are
* set by virtual methods should also be extracted by virtual methods,
* to enable subclasses to chain up correctly.
*
* Returns: %TRUE if @error is has been filled in with an error from
* @res, %FALSE if not.

4
gio/gdbusauthobserver.c
View File

@@ -178,7 +178,7 @@ g_dbus_auth_observer_class_init (GDBusAuthObserverClass *klass)
/**
* GDBusAuthObserver::allow-mechanism:
* @observer: The #GDBusAuthObserver emitting the signal.
* @mechanism: The name of the mechanism, e.g. <literal>DBUS_COOKIE_SHA1</literal>.
* @mechanism: The name of the mechanism, e.g. `DBUS_COOKIE_SHA1`.
*
* Emitted to check if @mechanism is allowed to be used.
*
@@ -253,7 +253,7 @@ g_dbus_auth_observer_authorize_authenticated_peer (GDBusAuthObserver *observer,
/**
* g_dbus_auth_observer_allow_mechanism:
* @observer: A #GDBusAuthObserver.
* @mechanism: The name of the mechanism, e.g. <literal>DBUS_COOKIE_SHA1</literal>.
* @mechanism: The name of the mechanism, e.g. `DBUS_COOKIE_SHA1`.
*
* Emits the #GDBusAuthObserver::allow-mechanism signal on @observer.
*

14
gio/gdbusconnection.c
View File

@@ -960,11 +960,11 @@ g_dbus_connection_class_init (GDBusConnectionClass *klass)
* GDBusConnection:exit-on-close:
*
* A boolean specifying whether the process will be terminated (by
* calling <literal>raise(SIGTERM)</literal>) if the connection
* is closed by the remote peer.
* calling `raise(SIGTERM)`) if the connection is closed by the
* remote peer.
*
* Note that #GDBusConnection objects returned by g_bus_get_finish() and
* g_bus_get_sync() will (usually) have this property set to %TRUE.
* Note that #GDBusConnection objects returned by g_bus_get_finish()
* and g_bus_get_sync() will (usually) have this property set to %TRUE.
*
* Since: 2.26
*/
@@ -5097,13 +5097,13 @@ obj_message_func (GDBusConnection *connection,
*
* Note that all #GVariant values passed to functions in @vtable will match
* the signature given in @interface_info - if a remote caller passes
* incorrect values, the <literal>org.freedesktop.DBus.Error.InvalidArgs</literal>
* incorrect values, the `org.freedesktop.DBus.Error.InvalidArgs`
* is returned to the remote caller.
*
* Additionally, if the remote caller attempts to invoke methods or
* access properties not mentioned in @interface_info the
* <literal>org.freedesktop.DBus.Error.UnknownMethod</literal> resp.
* <literal>org.freedesktop.DBus.Error.InvalidArgs</literal> errors
* `org.freedesktop.DBus.Error.UnknownMethod` resp.
* `org.freedesktop.DBus.Error.InvalidArgs` errors
* are returned to the caller.
*
* It is considered a programming error if the

2
gio/gdbuserror.c
View File

@@ -790,7 +790,7 @@ g_dbus_error_strip_remote_error (GError *error)
* D-Bus error name will be returned.
*
* Otherwise the a name of the form
* <literal>org.gtk.GDBus.UnmappedGError.Quark._ESCAPED_QUARK_NAME.Code_ERROR_CODE</literal>
* `org.gtk.GDBus.UnmappedGError.Quark._ESCAPED_QUARK_NAME.Code_ERROR_CODE`
* will be used. This allows other GDBus applications to map the error
* on the wire back to a #GError using g_dbus_error_new_for_dbus_error().
*

2
gio/gdbusinterfaceskeleton.c
View File

@@ -379,7 +379,7 @@ g_dbus_interface_skeleton_get_properties (GDBusInterfaceSkeleton *interface_)
*
* For example, an exported D-Bus interface may queue up property
* changes and emit the
* <literal>org.freedesktop.DBus.Properties::PropertiesChanged</literal>
* `org.freedesktop.DBus.Properties::Propert``
* signal later (e.g. in an idle handler). This technique is useful
* for collapsing multiple property changes into one.
*

4
gio/gdbusintrospection.c
View File

@@ -780,7 +780,7 @@ g_dbus_property_info_generate_xml (GDBusPropertyInfo *info,
*
* This function is typically used for generating introspection XML
* documents at run-time for handling the
* <literal>org.freedesktop.DBus.Introspectable.Introspect</literal>
* `org.freedesktop.DBus.Introspectable.Introspect`
* method.
*
* Since: 2.26
@@ -828,7 +828,7 @@ g_dbus_interface_info_generate_xml (GDBusInterfaceInfo *info,
* Appends an XML representation of @info (and its children) to @string_builder.
*
* This function is typically used for generating introspection XML documents at run-time for
* handling the <literal>org.freedesktop.DBus.Introspectable.Introspect</literal> method.
* handling the `org.freedesktop.DBus.Introspectable.Introspect` method.
*
* Since: 2.26
*/

5
gio/gdbusmethodinvocation.c
View File

@@ -575,9 +575,8 @@ g_dbus_method_invocation_return_value_with_unix_fd_list (GDBusMethodInvocation *
* will be returned on the wire. In a nutshell, if the given error is
* registered using g_dbus_error_register_error() the name given
* during registration is used. Otherwise, a name of the form
* <literal>org.gtk.GDBus.UnmappedGError.Quark...</literal> is
* used. This provides transparent mapping of #GError between
* applications using GDBus.
* `org.gtk.GDBus.UnmappedGError.Quark...` is used. This provides
* transparent mapping of #GError between applications using GDBus.
*
* If you are writing an application intended to be portable,
* always register errors with g_dbus_error_register_error()

2
gio/gdbusobjectmanagerclient.c
View File

@@ -86,7 +86,7 @@
* is set to the new name owner (this includes emission of the
* #GObject::notify signal). Furthermore, you are guaranteed that
* #GDBusObjectManagerClient:name-owner will alternate between a name owner
* (e.g. <literal>:1.42</literal>) and %NULL even in the case where
* (e.g. `:1.42`) and %NULL even in the case where
* the name of interest is atomically replaced
*
* Ultimately, #GDBusObjectManagerClient is used to obtain #GDBusProxy

8
gio/gdbusproxy.c
View File

@@ -370,8 +370,8 @@ g_dbus_proxy_class_init (GDBusProxyClass *klass)
* - Received signals that have a type signature mismatch are dropped and
* a warning is logged via g_warning().
*
* - Properties received via the initial <literal>GetAll()</literal> call
* or via the <literal>::PropertiesChanged</literal> signal (on the
* - Properties received via the initial `GetAll()` call or via the
* `::PropertiesChanged` signal (on the
* [org.freedesktop.DBus.Properties](http://dbus.freedesktop.org/doc/dbus-specification.html#standard-interfaces-properties)
* interface) or set using g_dbus_proxy_set_cached_property()
* with a type signature mismatch are ignored and a warning is
@@ -585,8 +585,8 @@ g_dbus_proxy_class_init (GDBusProxyClass *klass)
* @invalidated_properties will always be empty.
*
* This signal corresponds to the
* <literal>PropertiesChanged</literal> D-Bus signal on the
* <literal>org.freedesktop.DBus.Properties</literal> interface.
* `PropertiesChanged` D-Bus signal on the
* `org.freedesktop.DBus.Properties` interface.
*
* Since: 2.26
*/

31
gio/gdesktopappinfo.c
View File

@@ -1564,7 +1564,7 @@ g_desktop_app_info_get_nodisplay (GDesktopAppInfo *info)
*
* Checks if the application info should be shown in menus that list available
* applications for a specific name of the desktop, based on the
* <literal>OnlyShowIn</literal> and <literal>NotShowIn</literal> keys.
* `OnlyShowIn` and `NotShowIn` keys.
*
* If @desktop_env is %NULL, then the name of the desktop set with
* g_desktop_app_info_set_desktop_env() is used.
@@ -1573,7 +1573,7 @@ g_desktop_app_info_get_nodisplay (GDesktopAppInfo *info)
* %NULL for @desktop_env) as well as additional checks.
*
* Returns: %TRUE if the @info should be shown in @desktop_env according to the
* <literal>OnlyShowIn</literal> and <literal>NotShowIn</literal> keys, %FALSE
* `OnlyShowIn` and `NotShowIn` keys, %FALSE
* otherwise.
*
* Since: 2.30
@@ -2473,21 +2473,19 @@ g_desktop_app_info_launch_uris_as_manager (GDesktopAppInfo *appinfo,
* Sets the name of the desktop that the application is running in.
* This is used by g_app_info_should_show() and
* g_desktop_app_info_get_show_in() to evaluate the
* <literal>OnlyShowIn</literal> and <literal>NotShowIn</literal>
* `OnlyShowIn` and `NotShowIn`
* desktop entry fields.
*
* The
* [Desktop Menu specification](http://standards.freedesktop.org/menu-spec/latest/)
* recognizes the following:
* <simplelist>
* <member>GNOME</member>
* <member>KDE</member>
* <member>ROX</member>
* <member>XFCE</member>
* <member>LXDE</member>
* <member>Unity</member>
* <member>Old</member>
* </simplelist>
* - GNOME
* - KDE
* - ROX
* - XFCE
* - LXDE
* - Unity
* - Old
*
* Should be called only once; subsequent calls are ignored.
*/
@@ -3587,13 +3585,12 @@ g_desktop_app_info_search (const gchar *search_string)
* on this system.
*
* For desktop files, this includes applications that have
* <literal>NoDisplay=true</literal> set or are excluded from
* display by means of <literal>OnlyShowIn</literal> or
* <literal>NotShowIn</literal>. See g_app_info_should_show().
* `NoDisplay=true` set or are excluded from display by means
* of `OnlyShowIn` or `NotShowIn`. See g_app_info_should_show().
* The returned list does not include applications which have
* the <literal>Hidden</literal> key set.
* the `Hidden` key set.
*
* Returns: (element-type GAppInfo) (transfer full): a newly allocated #GList of references to #GAppInfo<!---->s.
* Returns: (element-type GAppInfo) (transfer full): a newly allocated #GList of references to #GAppInfos.
**/
GList *
g_app_info_get_all (void)

6
gio/gfile.c
View File

@@ -7609,9 +7609,9 @@ g_file_real_measure_disk_usage_finish (GFile *file,
*
* Recursively measures the disk usage of @file.
*
* This is essentially an analog of the '<literal>du</literal>' command,
* but it also reports the number of directories and non-directory files
* encountered (including things like symbolic links).
* This is essentially an analog of the 'du' command, but it also
* reports the number of directories and non-directory files encountered
* (including things like symbolic links).
*
* By default, errors are only reported against the toplevel file
* itself. Errors found while recursing are silently ignored, unless

6
gio/gicon.c
View File

@@ -194,13 +194,13 @@ g_icon_to_string_tokenized (GIcon *icon, GString *s)
* in the following two cases
*
* - If @icon is a #GFileIcon, the returned string is a native path
* (such as <literal>/path/to/my icon.png</literal>) without escaping
* (such as `/path/to/my icon.png`) without escaping
* if the #GFile for @icon is a native file. If the file is not
* native, the returned string is the result of g_file_get_uri()
* (such as <literal>sftp://path/to/my&percnt;20icon.png</literal>).
* (such as `sftp://path/to/my&percnt;20icon.png`).
*
* - If @icon is a #GThemedIcon with exactly one name, the encoding is
* simply the name (such as <literal>network-server</literal>).
* simply the name (such as `network-server`).
*
* Virtual: to_tokens
* Returns: An allocated NUL-terminated UTF8 string or %NULL if @icon can't

2
gio/ginetsocketaddress.c
View File

@@ -267,7 +267,7 @@ g_inet_socket_address_class_init (GInetSocketAddressClass *klass)
/**
* GInetSocketAddress:flowinfo:
*
* The <literal>sin6_flowinfo</literal> field, for IPv6 addresses.
* The `sin6_flowinfo` field, for IPv6 addresses.
*
* Since: 2.32
*/

6
gio/gmount.c
View File

@@ -946,10 +946,10 @@ get_private (GMount *mount)
* situation, a #GVolumeMonitor implementation would create two
* #GVolume objects (for example, one for the camera functionality of
* the device and one for a SD card reader on the device) with
* activation URIs <literal>gphoto2://[usb:001,002]/store1/</literal>
* and <literal>gphoto2://[usb:001,002]/store2/</literal>. When the
* activation URIs `gphoto2://[usb:001,002]/store1/`
* and `gphoto2://[usb:001,002]/store2/`. When the
* underlying mount (with root
* <literal>gphoto2://[usb:001,002]/</literal>) is mounted, said
* `gphoto2://[usb:001,002]/`) is mounted, said
* #GVolumeMonitor implementation would create two #GMount objects
* (each with their root matching the corresponding volume activation
* root) that would shadow the original mount.

2
gio/gnetworking.c
View File

@@ -28,7 +28,7 @@
* @short_description: System networking includes
* @include: gio/gnetworking.h
*
* The <literal>gnetworking.h</literal> header can be included to get
* The `&lt;gio/gnetworking.h&gt;` header can be included to get
* various low-level networking-related system headers, automatically
* taking care of certain portability issues for you.
*

12
gio/gproxyresolver.c
View File

@@ -97,18 +97,18 @@ g_proxy_resolver_is_supported (GProxyResolver *resolver)
* @error: return location for a #GError, or %NULL
*
* Looks into the system proxy configuration to determine what proxy,
* if any, to use to connect to @uri. The returned proxy URIs are of the
* form <literal>&lt;protocol&gt;://[user[:password]@]host:port</literal>
* or <literal>direct://</literal>, where &lt;protocol&gt; could be
* http, rtsp, socks or other proxying protocol.
* if any, to use to connect to @uri. The returned proxy URIs are of
* the form `&lt;protocol&gt;://[user[:password]@]host:port` or
* `direct://`, where &lt;protocol&gt; could be http, rtsp, socks
* or other proxying protocol.
*
* If you don't know what network protocol is being used on the
* socket, you should use <literal>none</literal> as the URI protocol.
* socket, you should use `none` as the URI protocol.
* In this case, the resolver might still return a generic proxy type
* (such as SOCKS), but would not return protocol-specific proxy types
* (such as http).
*
* <literal>direct://</literal> is used when no proxy is needed.
* `direct://` is used when no proxy is needed.
* Direct connection should not be attempted unless it is part of the
* returned array of proxies.
*

6
gio/gremoteactiongroup.c
View File

@@ -35,10 +35,10 @@
* or receive action invocations in the local process from other
* processes.
*
* The interface has <literal>_full</literal> variants of the two
* The interface has `_full` variants of the two
* methods on #GActionGroup used to activate actions:
* g_action_group_activate_action() and
* g_action_group_change_action_state(). These variants allow a
* g_action_group_change_action_state(). These variants allow a
* "platform data" #GVariant to be specified: a dictionary providing
* context for the action invocation (for example: timestamps, startup
* notification IDs, etc).
@@ -48,7 +48,7 @@
*
* Additionally, g_dbus_connection_export_action_group() will check if
* the exported #GActionGroup implements #GRemoteActionGroup and use the
* <literal>_full</literal> variants of the calls if available. This
* `_full` variants of the calls if available. This
* provides a mechanism by which to receive platform data for action
* invocations that arrive by way of D-Bus.
*

6
gio/gresource.c
View File

@@ -64,16 +64,16 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref)
* is very useful e.g. for larger text files that are parsed once (or rarely) and then thrown away.
*
* Resource files can also be marked to be preprocessed, by setting the value of the
* <literal>preprocess</literal> attribute to a comma-separated list of preprocessing options.
* `preprocess` attribute to a comma-separated list of preprocessing options.
* The only options currently supported are:
*
* <literal>xml-stripblanks</literal> which will use the xmllint command
* `xml-stripblanks` which will use the xmllint command
* to strip ignorable whitespace from the xml file. For this to work,
* the `XMLLINT` environment variable must be set to the full path to
* the xmllint executable, or xmllint must be in the `PATH`; otherwise
* the preprocessing step is skipped.
*
* <literal>to-pixdata</literal> which will use the gdk-pixbuf-pixdata command to convert
* `to-pixdata` which will use the gdk-pixbuf-pixdata command to convert
* images to the GdkPixdata format, which allows you to create pixbufs directly using the data inside
* the resource file, rather than an (uncompressed) copy if it. For this, the gdk-pixbuf-pixdata
* program must be in the PATH, or the `GDK_PIXBUF_PIXDATA` environment variable must be

41
gio/gsettingsschema.c
View File

@@ -267,8 +267,8 @@ g_settings_schema_source_unref (GSettingsSchemaSource *source)
* source, the lookup will recurse to the parent.
*
* Second, any references to other schemas specified within this
* source (ie: <literal>child</literal> or <literal>extends</literal>)
* references may be resolved from the @parent.
* source (ie: `child` or `extends`) references may be resolved
* from the @parent.
*
* For this second reason, except in very unusual situations, the
* @parent should probably be given as the default schema source, as
@@ -1592,31 +1592,28 @@ g_settings_schema_key_get_default_value (GSettingsSchemaKey *key)
* This function will return a #GVariant that fully describes the range
* of values that are valid for @key.
*
* The type of #GVariant returned is <literal>(sv)</literal>. The
* string describes the type of range restriction in effect. The type
* and meaning of the value contained in the variant depends on the
* string.
* The type of #GVariant returned is `(sv)`. The string describes
* the type of range restriction in effect. The type and meaning of
* the value contained in the variant depends on the string.
*
* If the string is <literal>'type'</literal> then the variant contains
* an empty array. The element type of that empty array is the expected
* type of value and all values of that type are valid.
* If the string is `'type'` then the variant contains an empty array.
* The element type of that empty array is the expected type of value
* and all values of that type are valid.
*
* If the string is <literal>'enum'</literal> then the variant contains
* an array enumerating the possible values. Each item in the array is
* If the string is `'enum'` then the variant contains an array
* enumerating the possible values. Each item in the array is
* a possible valid value and no other values are valid.
*
* If the string is <literal>'flags'</literal> then the variant contains
* an array. Each item in the array is a value that may appear zero or
* one times in an array to be used as the value for this key. For
* example, if the variant contained the array <literal>['x',
* 'y']</literal> then the valid values for the key would be
* <literal>[]</literal>, <literal>['x']</literal>,
* <literal>['y']</literal>, <literal>['x', 'y']</literal> and
* <literal>['y', 'x']</literal>.
* If the string is `'flags'` then the variant contains an array. Each
* item in the array is a value that may appear zero or one times in an
* array to be used as the value for this key. For example, if the
* variant contained the array `['x', 'y']` then the valid values for
* the key would be `[]`, `['x']`, `['y']`, `['x', 'y']` and
* `['y', 'x']`.
*
* Finally, if the string is <literal>'range'</literal> then the variant
* contains a pair of like-typed values -- the minimum and maximum
* permissible values for this key.
* Finally, if the string is `'range'` then the variant contains a pair
* of like-typed values -- the minimum and maximum permissible values
* for this key.
*
* This information should not be used by normal programs. It is
* considered to be a hint for introspection purposes. Normal programs

44
gio/gsocket.c
View File

@@ -1856,12 +1856,12 @@ g_socket_listen (GSocket *socket,
* used to initiate connections, though this is not normally required.
*
* If @socket is a TCP socket, then @allow_reuse controls the setting
* of the <literal>SO_REUSEADDR</literal> socket option; normally it
* should be %TRUE for server sockets (sockets that you will
* eventually call g_socket_accept() on), and %FALSE for client
* sockets. (Failing to set this flag on a server socket may cause
* g_socket_bind() to return %G_IO_ERROR_ADDRESS_IN_USE if the server
* program is stopped and then immediately restarted.)
* of the `SO_REUSEADDR` socket option; normally it should be %TRUE for
* server sockets (sockets that you will eventually call
* g_socket_accept() on), and %FALSE for client sockets. (Failing to
* set this flag on a server socket may cause g_socket_bind() to return
* %G_IO_ERROR_ADDRESS_IN_USE if the server program is stopped and then
* immediately restarted.)
*
* If @socket is a UDP socket, then @allow_reuse determines whether or
* not other UDP sockets can be bound to the same address at the same
@@ -4507,17 +4507,16 @@ g_socket_get_credentials (GSocket *socket,
/**
* g_socket_get_option:
* @socket: a #GSocket
* @level: the "API level" of the option (eg, <literal>SOL_SOCKET</literal>)
* @optname: the "name" of the option (eg, <literal>SO_BROADCAST</literal>)
* @level: the "API level" of the option (eg, `SOL_SOCKET`)
* @optname: the "name" of the option (eg, `SO_BROADCAST`)
* @value: (out): return location for the option value
* @error: #GError for error reporting, or %NULL to ignore.
*
* Gets the value of an integer-valued option on @socket, as with
* <literal>getsockopt ()</literal>. (If you need to fetch a
* non-integer-valued option, you will need to call
* <literal>getsockopt ()</literal> directly.)
* getsockopt(). (If you need to fetch a non-integer-valued option,
* you will need to call getsockopt() directly.)
*
* The <link linkend="gio-gnetworking.h"><literal>&lt;gio/gnetworking.h&gt;</literal></link>
* The <link linkend="gio-gnetworking.h">`&lt;gio/gnetworking.h&gt;`</link>
* header pulls in system headers that will define most of the
* standard/portable socket options. For unusual socket protocols or
* platform-dependent options, you may need to include additional
@@ -4528,9 +4527,8 @@ g_socket_get_credentials (GSocket *socket,
* g_socket_get_option() will handle the conversion internally.
*
* Returns: success or failure. On failure, @error will be set, and
* the system error value (<literal>errno</literal> or
* <literal>WSAGetLastError ()</literal>) will still be set to the
* result of the <literal>getsockopt ()</literal> call.
* the system error value (`errno` or WSAGetLastError()) will still
* be set to the result of the getsockopt() call.
*
* Since: 2.36
*/
@@ -4576,26 +4574,24 @@ g_socket_get_option (GSocket *socket,
/**
* g_socket_set_option:
* @socket: a #GSocket
* @level: the "API level" of the option (eg, <literal>SOL_SOCKET</literal>)
* @optname: the "name" of the option (eg, <literal>SO_BROADCAST</literal>)
* @level: the "API level" of the option (eg, `SOL_SOCKET`)
* @optname: the "name" of the option (eg, `SO_BROADCAST`)
* @value: the value to set the option to
* @error: #GError for error reporting, or %NULL to ignore.
*
* Sets the value of an integer-valued option on @socket, as with
* <literal>setsockopt ()</literal>. (If you need to set a
* non-integer-valued option, you will need to call
* <literal>setsockopt ()</literal> directly.)
* setsockopt(). (If you need to set a non-integer-valued option,
* you will need to call setsockopt() directly.)
*
* The <link linkend="gio-gnetworking.h"><literal>&lt;gio/gnetworking.h&gt;</literal></link>
* The <link linkend="gio-gnetworking.h">`&lt;gio/gnetworking.h&gt;`</link>
* header pulls in system headers that will define most of the
* standard/portable socket options. For unusual socket protocols or
* platform-dependent options, you may need to include additional
* headers.
*
* Returns: success or failure. On failure, @error will be set, and
* the system error value (<literal>errno</literal> or
* <literal>WSAGetLastError ()</literal>) will still be set to the
* result of the <literal>setsockopt ()</literal> call.
* the system error value (`errno` or WSAGetLastError()) will still
* be set to the result of the setsockopt() call.
*
* Since: 2.36
*/

7
gio/gsubprocess.c
View File

@@ -36,16 +36,15 @@
* comprehensive API for asynchronous I/O, such
* g_output_stream_splice_async(). This makes GSubprocess
* significantly more powerful and flexible than equivalent APIs in
* some other languages such as the <literal>subprocess.py</literal>
* some other languages such as the `subprocess.py`
* included with Python. For example, using #GSubprocess one could
* create two child processes, reading standard output from the first,
* processing it, and writing to the input stream of the second, all
* without blocking the main loop.
*
* A powerful g_subprocess_communicate() API is provided similar to the
* <literal>communicate()</literal> method of
* <literal>subprocess.py</literal>. This enables very easy interaction
* with a subprocess that has been opened with pipes.
* `communicate()` method of `subprocess.py`. This enables very easy
* interaction with a subprocess that has been opened with pipes.
*
* #GSubprocess defaults to tight control over the file descriptors open
* in the child process, avoiding dangling-fd issues that are caused by

21
gio/gtask.c
View File

@@ -489,9 +489,9 @@
* (You can use g_task_set_check_cancellable() to turn off that
* behavior.) On the other hand, g_task_run_in_thread()
* guarantees that it will always run your
* <literal>task_func</literal>, even if the task's #GCancellable
* `task_func`, even if the task's #GCancellable
* is already cancelled before the task gets a chance to run;
* you can start your <literal>task_func</literal> with a
* you can start your `task_func` with a
* g_task_return_error_if_cancelled() check if you need the
* old behavior.
* - The "return" methods (eg, g_task_return_pointer())
@@ -509,18 +509,18 @@
* prevent it from being freed twice.
* - With #GSimpleAsyncResult, it was common to call
* g_simple_async_result_propagate_error() from the
* <literal>_finish()</literal> wrapper function, and have
* `_finish()` wrapper function, and have
* virtual method implementations only deal with successful
* returns. This behavior is deprecated, because it makes it
* difficult for a subclass to chain to a parent class's async
* methods. Instead, the wrapper function should just be a
* simple wrapper, and the virtual method should call an
* appropriate <literal>g_task_propagate_</literal> function.
* appropriate `g_task_propagate_` function.
* Note that wrapper methods can now use
* g_async_result_legacy_propagate_error() to do old-style
* #GSimpleAsyncResult error-returning behavior, and
* g_async_result_is_tagged() to check if a result is tagged as
* having come from the <literal>_async()</literal> wrapper
* having come from the `_async()` wrapper
* function (for "short-circuit" results, such as when passing
* 0 to g_input_stream_read_async()).
*/
@@ -961,9 +961,9 @@ g_task_ref_source_object (GAsyncResult *res)
* g_task_get_task_data:
* @task: a #GTask
*
* Gets @task's <literal>task_data</literal>.
* Gets @task's `task_data`.
*
* Returns: (transfer none): @task's <literal>task_data</literal>.
* Returns: (transfer none): @task's `task_data`.
*
* Since: 2.36
*/
@@ -1165,7 +1165,7 @@ g_task_return (GTask *task,
*
* Other than in that case, @task will be completed when the
* #GTaskThreadFunc returns, not when it calls a
* <literal>g_task_return_</literal> function.
* `g_task_return_` function.
*
* Since: 2.36
*/
@@ -1349,7 +1349,7 @@ g_task_run_in_thread (GTask *task,
* See #GTaskThreadFunc for more details about how @task_func is handled.
*
* Normally this is used with tasks created with a %NULL
* <literal>callback</literal>, but note that even if the task does
* `callback`, but note that even if the task does
* have a callback, it will not be invoked when @task_func returns.
*
* Since: 2.36
@@ -1382,8 +1382,7 @@ g_task_run_in_thread_sync (GTask *task,
* to wait for a #GSource to trigger. Attaches @source to @task's
* #GMainContext with @task's <link
* linkend="io-priority">priority</link>, and sets @source's callback
* to @callback, with @task as the callback's
* <literal>user_data</literal>.
* to @callback, with @task as the callback's `user_data`.
*
* This takes a reference on @task until @source is destroyed.
*

10
gio/gtlscertificate.c
View File

@@ -138,7 +138,7 @@ g_tls_certificate_class_init (GTlsCertificateClass *class)
* but cannot be read.
*
* PKCS#8 format is supported since 2.32; earlier releases only
* support PKCS#1. You can use the <literal>openssl rsa</literal>
* support PKCS#1. You can use the `openssl rsa`
* tool to convert PKCS#8 keys to PKCS#1.
*
* Since: 2.28
@@ -155,14 +155,14 @@ g_tls_certificate_class_init (GTlsCertificateClass *class)
* GTlsCertificate:private-key-pem:
*
* The PEM (ASCII) encoded representation of the certificate's
* private key in either PKCS#1 format ("<literal>BEGIN RSA PRIVATE
* KEY</literal>") or unencrypted PKCS#8 format ("<literal>BEGIN
* PRIVATE KEY</literal>"). This property (or the
* private key in either PKCS#1 format ("`BEGIN RSA PRIVATE
* KEY`") or unencrypted PKCS#8 format ("`BEGIN
* PRIVATE KEY`"). This property (or the
* #GTlsCertificate:private-key property) can be set when
* constructing a key (eg, from a file), but cannot be read.
*
* PKCS#8 format is supported since 2.32; earlier releases only
* support PKCS#1. You can use the <literal>openssl rsa</literal>
* support PKCS#1. You can use the `openssl rsa`
* tool to convert PKCS#8 keys to PKCS#1.
*
* Since: 2.28

16
gio/gtlsconnection.c
View File

@@ -677,16 +677,16 @@ g_tls_connection_get_require_close_notify (GTlsConnection *conn)
*
* %G_TLS_REHANDSHAKE_SAFELY means that the connection will allow a
* rehandshake only if the other end of the connection supports the
* TLS <literal>renegotiation_info</literal> extension. This is the
* default behavior, but means that rehandshaking will not work
* against older implementations that do not support that extension.
* TLS `renegotiation_info` extension. This is the default behavior,
* but means that rehandshaking will not work against older
* implementations that do not support that extension.
*
* %G_TLS_REHANDSHAKE_UNSAFELY means that the connection will allow
* rehandshaking even without the
* <literal>renegotiation_info</literal> extension. On the server side
* in particular, this is not recommended, since it leaves the server
* open to certain attacks. However, this mode is necessary if you
* need to allow renegotiation with older client software.
* rehandshaking even without the `renegotiation_info` extension. On
* the server side in particular, this is not recommended, since it
* leaves the server open to certain attacks. However, this mode is
* necessary if you need to allow renegotiation with older client
* software.
*
* Since: 2.28
*/

2
gio/gunixsocketaddress.c
View File

@@ -376,7 +376,7 @@ g_unix_socket_address_new_abstract (const gchar *path,
* zero-padded buffer will be considered the name. (As above, if
* @path_len is -1, then @path is assumed to be NUL-terminated.) In
* this case, g_socket_address_get_native_size() will always return
* the full size of a <literal>struct sockaddr_un</literal>, although
* the full size of a `struct sockaddr_un`, although
* g_unix_socket_address_get_path_len() will still return just the
* length of @path.
*