luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2025-01-11 15:06:14 +01:00
Code Issues Packages Projects Releases Wiki Activity

Fix links in gio docs

Browse Source
This commit is contained in:
Matthias Clasen 2011-06-04 18:44:44 -04:00
parent cb9c92cdb4
commit 01f63b19f9
16 changed files with 82 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/reference/gio/migrating-gconf.xml
View File

@ -160,10 +160,9 @@
<para>
If you are porting your application from GConf, most likely you already
have a GConf schema. GConf comes with a commandline tool
<link linkend="gsettings-schema-convert">gsettings-schema-convert</link>
that can help with the task of converting a GConf schema into
an equivalent GSettings schema. The tool is not perfect and
may need assistence in some cases.
gsettings-schema-convert that can help with the task of converting
a GConf schema into an equivalent GSettings schema. The tool is not
perfect and may need assistence in some cases.
</para>
<example><title>An example for using gsettings-schema-convert</title>
<para>Running <userinput>gsettings-schema-convert --gconf --xml --schema-id "org.gnome.font-rendering" --output org.gnome.font-rendering.gschema.xml destop_gnome_font_rendering.schemas</userinput> on the following <filename>desktop_gnome_font_rendering.schemas</filename> file:

16
gio/gaction.c
View File

@ -266,15 +266,15 @@ g_action_get_parameter_type (GAction *action)
*
* Queries the type of the state of @action.
*
* If the action is stateful (ie: was created with
* g_action_new_stateful()) then this function returns the #GVariantType
* of the state. This is the type of the initial value given as the
* state. All calls to g_action_set_state() must give a #GVariant of
* this type and g_action_get_state() will return a #GVariant of the
* same type.
* If the action is stateful (e.g. created with
* g_simple_action_new_stateful()) then this function returns the
* #GVariantType of the state. This is the type of the initial value
* given as the state. All calls to g_action_set_state() must give a
* #GVariant of this type and g_action_get_state() will return a
* #GVariant of the same type.
*
* If the action is not stateful (ie: created with g_action_new()) then
* this function will return %NULL. In that case, g_action_get_state()
* If the action is not stateful (e.g. created with g_simple_action_new())
* then this function will return %NULL. In that case, g_action_get_state()
* will return %NULL and you must not call g_action_set_state().
*
* Returns: (allow-none): the state type, if the action is stateful

34
gio/gactiongroup.c
View File

@ -41,8 +41,8 @@
* forces' (eg: UI, incoming D-Bus messages, etc.) are supposed to have
* with actions. 'Internal' APIs (ie: ones meant only to be accessed by
* the action group implementation) are found on subclasses. This is
* why you will find -- for example -- g_action_group_get_enabled() but
* not an equivalent <function>set()</function> call.
* why you will find -- for example -- g_action_group_get_action_enabled()
* but not an equivalent <function>set()</function> call.
*
* Signals are emitted on the action group in response to state changes
* on individual actions.
@ -69,8 +69,9 @@ g_action_group_default_init (GActionGroupInterface *class)
* @action_group: the #GActionGroup that changed
* @action_name: the name of the action in @action_group
*
* Signals that a new action was just added to the group. This signal
* is emitted after the action has been added and is now visible.
* Signals that a new action was just added to the group.
* This signal is emitted after the action has been added
* and is now visible.
*
* Since: 2.28
**/
@ -205,9 +206,9 @@ g_action_group_has_action (GActionGroup *action_group,
* Queries the type of the parameter that must be given when activating
* the named action within @action_group.
*
* When activating the action using g_action_group_activate(), the
* #GVariant given to that function must be of the type returned by this
* function.
* When activating the action using g_action_group_activate_action(),
* the #GVariant given to that function must be of the type returned
* by this function.
*
* In the case that this function returns %NULL, you must not give any
* #GVariant, but %NULL instead.
@ -239,13 +240,14 @@ g_action_group_get_action_parameter_type (GActionGroup *action_group,
* @action_group.
*
* If the action is stateful then this function returns the
* #GVariantType of the state. All calls to g_action_group_set_state()
* must give a #GVariant of this type and g_action_group_get_state()
* will return a #GVariant of the same type.
* #GVariantType of the state. All calls to
* g_action_group_change_action_state() must give a #GVariant of this
* type and g_action_group_get_action_state() will return a #GVariant
* of the same type.
*
* If the action is not stateful then this function will return %NULL.
* In that case, g_action_group_get_state() will return %NULL and you
* must not call g_action_group_set_state().
* In that case, g_action_group_get_action_state() will return %NULL
* and you must not call g_action_group_change_action_state().
*
* The state type of a particular action will never change but it is
* possible for an action to be removed and for a new action to be added
@ -336,7 +338,7 @@ g_action_group_get_action_enabled (GActionGroup *action_group,
*
* If the action is not stateful then %NULL will be returned. If the
* action is stateful then the type of the return value is the type
* given by g_action_group_get_state_type().
* given by g_action_group_get_action_state_type().
*
* The return value (if non-%NULL) should be freed with
* g_variant_unref() when it is no longer required.
@ -365,11 +367,11 @@ g_action_group_get_action_state (GActionGroup *action_group,
* changed to @value.
*
* The action must be stateful and @value must be of the correct type.
* See g_action_group_get_state_type().
* See g_action_group_get_action_state_type().
*
* This call merely requests a change. The action may refuse to change
* its state or may change its state to something other than @value.
* See g_action_group_get_state_hint().
* See g_action_group_get_action_state_hint().
*
* If the @value GVariant is floating, it is consumed.
*
@ -399,7 +401,7 @@ g_action_group_change_action_state (GActionGroup *action_group,
* If the action is expecting a parameter, then the correct type of
* parameter must be given as @parameter. If the action is expecting no
* parameters then @parameter must be %NULL. See
* g_action_group_get_parameter_type().
* g_action_group_get_action_parameter_type().
*
* Since: 2.28
**/

22
gio/gactiongroup.h
View File

@ -45,17 +45,17 @@ typedef struct _GActionGroupInterface GActionGroupInterfac
* GActionGroupInterface:
* @has_action: the virtual function pointer for g_action_group_has_action()
* @list_actions: the virtual function pointer for g_action_group_list_actions()
* @get_parameter_type: the virtual function pointer for g_action_group_get_parameter_type()
* @get_state_type: the virtual function pointer for g_action_group_get_state_type()
* @get_state_hint: the virtual function pointer for g_action_group_get_state_hint()
* @get_enabled: the virtual function pointer for g_action_group_get_enabled()
* @get_state: the virtual function pointer for g_action_group_get_state()
* @set_state: the virtual function pointer for g_action_group_set_state()
* @activate: the virtual function pointer for g_action_group_activate()
* @action_added: the class closure for the action-added signal
* @action_removed: the class closure for the action-removed signal
* @action_enabled_changed: the class closure for the action-enabled-changed signal
* @action_state_changed: the class closure for the action-enabled-changed signal
* @get_action_parameter_type: the virtual function pointer for g_action_group_get_action_parameter_type()
* @get_action_state_type: the virtual function pointer for g_action_group_get_action_state_type()
* @get_action_state_hint: the virtual function pointer for g_action_group_get_action_state_hint()
* @get_action_enabled: the virtual function pointer for g_action_group_get_action_enabled()
* @get_action_state: the virtual function pointer for g_action_group_get_action_state()
* @set_action_state: the virtual function pointer for g_action_group_set_action_state()
* @activate_action: the virtual function pointer for g_action_group_activate_action()
* @action_added: the class closure for the #GActionGroup::action-added signal
* @action_removed: the class closure for the #GActionGroup::action-removed signal
* @action_enabled_changed: the class closure for the #GActionGroup::action-enabled-changed signal
* @action_state_changed: the class closure for the #GActionGroup::action-enabled-changed signal
*
* The virtual function table for #GActionGroup.
*

10
gio/gappinfo.c
View File

@ -39,7 +39,7 @@
* (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
* %%U</literal> and a single URI,
* &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
@ -313,11 +313,11 @@ g_app_info_set_as_default_for_type (GAppInfo *appinfo,
* @appinfo: a #GAppInfo.
* @content_type: the content type.
* @error: a #GError.
*
*
* Sets the application as the last used application for a given type.
* This will make the application appear as first in the list returned by
* #g_app_info_get_recommended_for_type, regardless of the default application
* for that content type.
* This will make the application appear as first in the list returned
* by g_app_info_get_recommended_for_type(), regardless of the default
* application for that content type.
*
* Returns: %TRUE on success, %FALSE on error.
**/

19
gio/gasyncinitable.c
View File

@ -309,7 +309,7 @@ g_async_initable_real_init_finish (GAsyncInitable *initable,
* @...: the value of the first property, followed by other property
* value pairs, and ended by %NULL.
*
* Helper function for constructing #GAsyncInitiable object. This is
* Helper function for constructing #GAsyncInitable object. This is
* similar to g_object_new() but also initializes the object asynchronously.
*
* When the initialization is finished, @callback will be called. You can
@ -349,7 +349,7 @@ g_async_initable_new_async (GType object_type,
* finished
* @user_data: the data to pass to callback function
*
* Helper function for constructing #GAsyncInitiable object. This is
* Helper function for constructing #GAsyncInitable object. This is
* similar to g_object_newv() but also initializes the object asynchronously.
*
* When the initialization is finished, @callback will be called. You can
@ -391,7 +391,7 @@ g_async_initable_newv_async (GType object_type,
* finished
* @user_data: the data to pass to callback function
*
* Helper function for constructing #GAsyncInitiable object. This is
* Helper function for constructing #GAsyncInitable object. This is
* similar to g_object_new_valist() but also initializes the object
* asynchronously.
*
@ -427,15 +427,14 @@ g_async_initable_new_valist_async (GType object_type,
/**
* g_async_initable_new_finish:
* @initable: the #GAsyncInitable from the callback
* @res: the #GAsyncResult.from the callback
* @error: a #GError location to store the error occuring, or %NULL to
* ignore.
* @res: the #GAsyncResult from the callback
* @error: return location for errors, or %NULL to ignore
*
* Finishes the async construction for the various g_async_initable_new calls,
* returning the created object or %NULL on error.
* Finishes the async construction for the various g_async_initable_new
* calls, returning the created object or %NULL on error.
*
* Returns: (transfer full): a newly created #GObject, or %NULL on error. Free with
* g_object_unref().
* Returns: (transfer full): a newly created #GObject, or %NULL on error.
* Free with g_object_unref().
*
* Since: 2.22
*/

8
gio/gdbusconnection.c
View File

@ -2849,15 +2849,13 @@ static guint _global_filter_id = 1;
* added as a filter more than once, in which case it will be run more
* than once. Filters added during a filter callback won't be run on
* the message being processed. Filter functions are allowed to modify
* and even drop messages - see the #GDBusMessageFilterResult
* enumeration for details.
* and even drop messages.
*
* Note that filters are run in a dedicated message handling thread so
* they can't block and, generally, can't do anything but signal a
* worker thread. Also note that filters are rarely needed - use API
* such as g_dbus_connection_send_message_with_reply(),
* g_dbus_connection_signal_subscribe() or
* g_dbus_connection_call() instead.
* g_dbus_connection_signal_subscribe() or g_dbus_connection_call() instead.
*
* If a filter consumes an incoming message the message is not
* dispatched anywhere else - not even the standard dispatch machinery
@ -6401,7 +6399,7 @@ g_bus_get (GBusType bus_type,
* The returned object is a singleton, that is, shared with other
* callers of g_bus_get() and g_bus_get_sync() for @bus_type. In the
* event that you need a private message bus connection, use
* g_dbus_address_get_for_bus() and
* g_dbus_address_get_for_bus_sync() and
* g_dbus_connection_new_for_address().
*
* Note that the returned #GDBusConnection object will (usually) have

2
gio/gfileinfo.c
View File

@ -1954,7 +1954,7 @@ g_file_info_set_icon (GFileInfo *info,
/**
* g_file_info_set_content_type:
* @info: a #GFileInfo.
* @content_type: a content type. See #GContentType.
* @content_type: a content type. See <link linkend="gio-GContentType">GContentType</link>.
*
* Sets the content type attribute for a given #GFileInfo.
* See %G_FILE_ATTRIBUTE_STANDARD_CONTENT_TYPE.

2
gio/gicon.c
View File

@ -188,7 +188,7 @@ g_icon_to_string_tokenized (GIcon *icon, GString *s)
* (such as <literal>/path/to/my icon.png</literal>) 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%%20icon.png</literal>).
* (such as <literal>sftp://path/to/my&percnt;20icon.png</literal>).
* </para></listitem>
* <listitem><para>
* If @icon is a #GThemedIcon with exactly one name, the encoding is

2
gio/gproxy.c
View File

@ -157,7 +157,7 @@ g_proxy_connect_async (GProxy *proxy,
/**
* g_proxy_connect_finish:
* @proxy: a #GProxy
* @result: a #GAsyncRetult
* @result: a #GAsyncResult
* @error: return #GError
*
* See g_proxy_connect().

6
gio/gsocketclient.c
View File

@ -423,7 +423,7 @@ g_socket_client_set_protocol (GSocketClient *client,
*
* See g_socket_client_set_local_address() for details.
*
* Returns: (transfer none): a #GSocketAddres or %NULL. don't free
* Returns: (transfer none): a #GSocketAddress or %NULL. Do not free.
*
* Since: 2.22
*/
@ -1420,7 +1420,7 @@ g_socket_client_enumerator_callback (GObject *object,
/**
* g_socket_client_connect_async:
* @client: a #GTcpClient
* @client: a #GSocketClient
* @connectable: a #GSocketConnectable specifying the remote address.
* @cancellable: (allow-none): a #GCancellable, or %NULL
* @callback: (scope async): a #GAsyncReadyCallback
@ -1468,7 +1468,7 @@ g_socket_client_connect_async (GSocketClient *client,
/**
* g_socket_client_connect_to_host_async:
* @client: a #GTcpClient
* @client: a #GSocketClient
* @host_and_port: the name and optionally the port of the host to connect to
* @default_port: the default port to connect to
* @cancellable: (allow-none): a #GCancellable, or %NULL

22
gio/gsocketservice.c
View File

@ -28,9 +28,9 @@
* @short_description: Make it easy to implement a network service
* @see_also: #GThreadedSocketService, #GSocketListener.
*
* A #GSocketService is an object that represents a service that is
* provided to the network or over local sockets. When a new
* connection is made to the service the #GSocketService:incoming
* A #GSocketService is an object that represents a service that
* is provided to the network or over local sockets. When a new
* connection is made to the service the #GSocketService::incoming
* signal is emitted.
*
* A #GSocketService is a subclass of #GSocketListener and you need
@ -39,7 +39,7 @@
*
* There are two options for implementing a network service based on
* #GSocketService. The first is to create the service using
* g_socket_service_new() and to connect to the #GSocketService:incoming
* g_socket_service_new() and to connect to the #GSocketService::incoming
* signal. The second is to subclass #GSocketService and override the
* default signal handler implementation.
*
@ -174,7 +174,7 @@ g_socket_service_is_active (GSocketService *service)
* from the added sockets when the mainloop runs.
*
* This call is threadsafe, so it may be called from a thread
* handling an incomming client request.
* handling an incoming client request.
*
* Since: 2.22
*/
@ -204,7 +204,7 @@ g_socket_service_start (GSocketService *service)
* from the added sockets when the mainloop runs.
*
* This call is threadsafe, so it may be called from a thread
* handling an incomming client request.
* handling an incoming client request.
*
* Since: 2.22
*/
@ -251,17 +251,17 @@ g_socket_service_class_init (GSocketServiceClass *class)
/**
* GSocketService::incoming:
* @service: the #GSocketService.
* @connection: a new #GSocketConnection object.
* @source_object: the source_object passed to g_socket_listener_add_address().
* @service: the #GSocketService
* @connection: a new #GSocketConnection object
* @source_object: the source_object passed to g_socket_listener_add_address()
*
* The ::incoming signal is emitted when a new incoming connection
* to @service needs to be handled. The handler must initiate the
* handling of @connection, but may not block; in essence,
* asynchronous operations must be used.
*
* @connection will be unreffed once the signal handler returns, so
* you need to ref it yourself if you are planning to use it.
* @connection will be unreffed once the signal handler returns,
* so you need to ref it yourself if you are planning to use it.
*
* Returns: %TRUE to stop other handlers from being called
*

6
gio/gthreadedsocketservice.c
View File

@ -30,8 +30,8 @@
*
* A #GThreadedSocketService is a simple subclass of #GSocketService
* that handles incoming connections by creating a worker thread and
* dispatching the connection to it by emitting the ::run signal in
* the new thread.
* dispatching the connection to it by emitting the
* #GThreadedSocketService::run signal in the new thread.
*
* The signal handler may perform blocking IO and need not return
* until the connection is closed.
@ -41,7 +41,7 @@
* The service automatically stops the #GSocketService from accepting
* new connections when all threads are busy.
*
* As with #GSocketService, you may connect to #GThreadedSocketService:run,
* As with #GSocketService, you may connect to #GThreadedSocketService::run,
* or subclass and override the default handler.
*/

6
gio/gtlsconnection.c
View File

@ -195,8 +195,8 @@ g_tls_connection_class_init (GTlsConnectionClass *klass)
* GTlsConnection:peer-certificate-errors:
*
* The errors noticed-and-ignored while verifying
* #GTlsConnection:peer-certificate. Normally this should be %0, but
* it may not be if #GTlsClientConnection::validation-flags is not
* #GTlsConnection:peer-certificate. Normally this should be 0, but
* it may not be if #GTlsClientConnection:validation-flags is not
* %G_TLS_CERTIFICATE_VALIDATE_ALL, or if
* #GTlsConnection::accept-certificate overrode the default
* behavior.
@ -569,7 +569,7 @@ g_tls_connection_set_rehandshake_mode (GTlsConnection *conn,
* @conn: a #GTlsConnection
*
* Gets @conn rehandshaking mode. See
* g_tls_connection_set_rehandshake() for details.
* g_tls_connection_set_rehandshake_mode() for details.
*
* Return value: @conn's rehandshaking mode
*

2
gio/gunixcredentialsmessage.c
View File

@ -321,7 +321,7 @@ g_unix_credentials_message_class_init (GUnixCredentialsMessageClass *class)
/**
* g_unix_credentials_message_is_supported:
*
* Checks if passing a #GCredential on a #GSocket is supported on this platform.
* Checks if passing #GCredentials on a #GSocket is supported on this platform.
*
* Returns: %TRUE if supported, %FALSE otherwise
*

2
gio/gunixmounts.c
View File

@ -1137,7 +1137,7 @@ g_unix_mount_at (const char *mount_path,
* Gets a #GList of #GUnixMountPoint containing the unix mount points.
* If @time_read is set, it will be filled with the mount timestamp,
* allowing for checking if the mounts have changed with
* g_unix_mounts_points_changed_since().
* g_unix_mount_points_changed_since().
*
* Returns: (element-type GUnixMountPoint) (transfer full):
* a #GList of the UNIX mountpoints.