luc14n0/glib
1
0
Fork 0
mirror of https://gitlab.gnome.org/GNOME/glib.git synced 2024-12-24 14:36:13 +01:00
Code Issues Packages Projects Releases Wiki Activity

Don't use <filename> in docs

Browse Source 
Switch to simpler markdown, `foo`.
This commit is contained in:
Matthias Clasen 2014-02-05 20:17:46 -05:00
parent 111803030d
commit 0cc20b7e0b
27 changed files with 106 additions and 116 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
gio/gdesktopappinfo.c
View File

@ -58,9 +58,9 @@
* #GDesktopAppInfo is an implementation of #GAppInfo based on
* desktop files.
*
* Note that <filename>&lt;gio/gdesktopappinfo.h&gt;</filename> belongs to
* the UNIX-specific GIO interfaces, thus you have to use the
* <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
* Note that `<gio/gdesktopappinfo.h>` belongs to the UNIX-specific
* GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
* file when using it.
*/
#define DEFAULT_APPLICATIONS_GROUP "Default Applications"
@ -1306,13 +1306,13 @@ g_desktop_app_info_new_from_filename (const char *filename)
*
* A desktop file id is the basename of the desktop file, including the
* .desktop extension. GIO is looking for a desktop file with this name
* in the <filename>applications</filename> subdirectories of the XDG
* in the `applications` subdirectories of the XDG
* data directories (i.e. the directories specified in the `XDG_DATA_HOME`
* and `XDG_DATA_DIRS` environment variables). GIO also supports the
* prefix-to-subdirectory mapping that is described in the
* <ulink url="http://standards.freedesktop.org/menu-spec/latest/">Menu
* Spec</ulink> (i.e. a desktop id of kde-foo.desktop will match
* <filename>/usr/share/applications/kde/foo.desktop</filename>).
* `/usr/share/applications/kde/foo.desktop`).
*
* Returns: a new #GDesktopAppInfo, or %NULL if no desktop file with that id
*/

6
gio/gfiledescriptorbased.c
View File

@ -32,9 +32,9 @@
* #GFileDescriptorBased is implemented by streams (implementations of
* #GInputStream or #GOutputStream) that are based on file descriptors.
*
* Note that <filename>&lt;gio/gfiledescriptorbased.h&gt;</filename> belongs to
* the UNIX-specific GIO interfaces, thus you have to use the
* <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
* Note that `<gio/gfiledescriptorbased.h>` belongs to the UNIX-specific
* GIO interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
* file when using it.
*
* Since: 2.24
*

7
gio/gresource.c
View File

@ -45,9 +45,10 @@ G_DEFINE_BOXED_TYPE (GResource, g_resource, g_resource_ref, g_resource_unref)
* @short_description: Resource framework
* @include: gio/gio.h
*
* Applications and libraries often contain binary or textual data that is really part of the
* application, rather than user data. For instance #GtkBuilder .ui files, splashscreen images,
* GMenu markup xml, CSS files, icons, etc. These are often shipped as files in <filename>$datadir/appname</filename>, or
* Applications and libraries often contain binary or textual data that is
* really part of the application, rather than user data. For instance
* #GtkBuilder .ui files, splashscreen images, GMenu markup xml, CSS files,
* icons, etc. These are often shipped as files in `$datadir/appname`, or
* manually included as literal strings in the code.
*
* The #GResource API and the <link linkend="glib-compile-resources">glib-compile-resources</link> program

5
gio/gsettings.c
View File

@ -98,8 +98,7 @@
* A DTD for the gschema XML format can be found here: <ulink url="https://git.gnome.org/browse/glib/tree/gio/gschema.dtd">gschema.dtd</ulink>
*
* The <link linkend="glib-compile-schemas">glib-compile-schemas</link>
* tool expects schema files to have the extension
* <filename>.gschema.xml</filename>
* tool expects schema files to have the extension `.gschema.xml`.
*
* At runtime, schemas are identified by their id (as specified
* in the <tag class="attribute">id</tag> attribute of the
@ -205,7 +204,7 @@
* ]|
*
* glib-compile-schemas expects schema files to have the extension
* <filename>.gschema.override</filename>
* `.gschema.override`.
*
* ## Binding
*

2
gio/gsettingsbackend.c
View File

@ -79,7 +79,7 @@ static gboolean g_settings_has_backend;
* implementations, but does not carry the same stability guarantees
* as the public GIO API. For this reason, you have to define the
* C preprocessor symbol %G_SETTINGS_ENABLE_BACKEND before including
* <filename>gio/gsettingsbackend.h</filename>
* `gio/gsettingsbackend.h`.
**/
static gboolean

15
gio/gsettingsschema.c
View File

@ -250,16 +250,15 @@ g_settings_schema_source_unref (GSettingsSchemaSource *source)
* This function is not required for normal uses of #GSettings but it
* may be useful to authors of plugin management systems.
*
* The directory should contain a file called
* <filename>gschemas.compiled</filename> as produced by the
* The directory should contain a file called `gschemas.compiled` as
* produced by the
* <link linkend="glib-compile-schemas">glib-compile-schemas</link> tool.
*
* If @trusted is %TRUE then <filename>gschemas.compiled</filename> is
* trusted not to be corrupted. This assumption has a performance
* advantage, but can result in crashes or inconsistent behaviour in the
* case of a corrupted file. Generally, you should set @trusted to
* %TRUE for files installed by the system and to %FALSE for files in
* the home directory.
* If @trusted is %TRUE then `gschemas.compiled` is trusted not to be
* corrupted. This assumption has a performance advantage, but can result
* in crashes or inconsistent behaviour in the case of a corrupted file.
* Generally, you should set @trusted to %TRUE for files installed by the
* system and to %FALSE for files in the home directory.
*
* If @parent is non-%NULL then there are two effects.
*

8
gio/gtestdbus.c
View File

@ -338,13 +338,13 @@ _g_test_watcher_remove_pid (GPid pid)
* code tree.
*
* The first thing you will need is a separate service description file for the
* D-Bus daemon. Typically a <filename>services</filename> subdirectory of
* your <filename>tests</filename> directory is a good place to put this file.
* D-Bus daemon. Typically a `services` subdirectory of your `tests` directory
* is a good place to put this file.
*
* The service file should list your service along with an absolute path to the
* uninstalled service executable in your source tree. Using autotools we would
* achieve this by adding a file such as <filename>my-server.service.in</filename>
* in the services directory and have it processed by configure.
* achieve this by adding a file such as `my-server.service.in` in the services
* directory and have it processed by configure.
* |[
* [D-BUS Service]
* Name=org.gtk.GDBus.Examples.ObjectManager

6
gio/gunixconnection.c
View File

@ -39,9 +39,9 @@
* It contains functions to do some of the UNIX socket specific
* functionality like passing file descriptors.
*
* Note that <filename>&lt;gio/gunixconnection.h&gt;</filename> belongs to
* the UNIX-specific GIO interfaces, thus you have to use the
* <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
* Note that `<gio/gunixconnection.h>` belongs to the UNIX-specific
* GIO interfaces, thus you have to use the `gio-unix-2.0.pc`
* pkg-config file when using it.
*
* Since: 2.22
*/

6
gio/gunixfdlist.c
View File

@ -26,9 +26,9 @@
* the %G_SOCKET_ADDRESS_UNIX family by using g_socket_send_message()
* and received using g_socket_receive_message().
*
* Note that <filename>&lt;gio/gunixfdlist.h&gt;</filename> belongs to
* the UNIX-specific GIO interfaces, thus you have to use the
* <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
* Note that `<gio/gunixfdlist.h>` belongs to the UNIX-specific GIO
* interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
* file when using it.
*/
#include "config.h"

8
gio/gunixfdmessage.c
View File

@ -29,10 +29,10 @@
* stream-oriented UNIX sockets, see g_unix_connection_send_fd() and
* g_unix_connection_receive_fd().
*
* Note that <filename>&lt;gio/gunixfdmessage.h&gt;</filename> belongs to
* the UNIX-specific GIO interfaces, thus you have to use the
* <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
**/
* Note that `<gio/gunixfdmessage.h>` belongs to the UNIX-specific GIO
* interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
* file when using it.
*/
#include "config.h"

6
gio/gunixinputstream.c
View File

@ -51,9 +51,9 @@
* asynchronous I/O. If it refers to a regular file, it will fall back
* to doing asynchronous I/O in another thread.)
*
* Note that <filename>&lt;gio/gunixinputstream.h&gt;</filename> belongs
* to the UNIX-specific GIO interfaces, thus you have to use the
* <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
* Note that `<gio/gunixinputstream.h>` belongs to the UNIX-specific GIO
* interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
* file when using it.
*/
enum {

9
gio/gunixmounts.c
View File

@ -79,9 +79,9 @@ static const char *_resolve_dev_root (void);
*
* Routines for managing mounted UNIX mount points and paths.
*
* Note that <filename>&lt;gio/gunixmounts.h&gt;</filename> belongs to the
* UNIX-specific GIO interfaces, thus you have to use the
* <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
* Note that `<gio/gunixmounts.h>` belongs to the UNIX-specific GIO
* interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config
* file when using it.
*/
/*
@ -217,8 +217,7 @@ is_in (const char *value, const char *set[])
/**
* g_unix_is_mount_path_system_internal:
* @mount_path: a mount path, e.g. <filename>/media/disk</filename>
* or <filename>/usr</filename>
* @mount_path: a mount path, e.g. `/media/disk` or `/usr`
*
* Determines if @mount_path is considered an implementation of the
* OS. This is primarily used for hiding mountable and mounted volumes

6
gio/gunixoutputstream.c
View File

@ -51,9 +51,9 @@
* asynchronous I/O. If it refers to a regular file, it will fall back
* to doing asynchronous I/O in another thread.)
*
* Note that <filename>&lt;gio/gunixoutputstream.h&gt;</filename> belongs
* to the UNIX-specific GIO interfaces, thus you have to use the
* <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
* Note that `<gio/gunixoutputstream.h>` belongs to the UNIX-specific GIO
* interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config file
* when using it.
*/
enum {

6
gio/gunixsocketaddress.c
View File

@ -44,9 +44,9 @@
* errors. You can use g_unix_socket_address_abstract_names_supported()
* to see if abstract names are supported.
*
* Note that <filename>&lt;gio/gunixsocketaddress.h&gt;</filename> belongs to
* the UNIX-specific GIO interfaces, thus you have to use the
* <filename>gio-unix-2.0.pc</filename> pkg-config file when using it.
* Note that `<gio/gunixsocketaddress.h>` belongs to the UNIX-specific GIO
* interfaces, thus you have to use the `gio-unix-2.0.pc` pkg-config file
* when using it.
*/
/**

9
gio/gvolume.c
View File

@ -63,11 +63,10 @@
* to an application via the commandline). For this purpose, GIO
* allows to obtain an 'identifier' for the volume. There can be
* different kinds of identifiers, such as Hal UDIs, filesystem labels,
* traditional Unix devices (e.g. <filename>/dev/sda2</filename>),
* uuids. GIO uses predefind strings as names for the different kinds
* of identifiers: #G_VOLUME_IDENTIFIER_KIND_HAL_UDI,
* #G_VOLUME_IDENTIFIER_KIND_LABEL, etc. Use g_volume_get_identifier()
* to obtain an identifier for a volume.
* traditional Unix devices (e.g. `/dev/sda2`), UUIDs. GIO uses predefined
* strings as names for the different kinds of identifiers:
* #G_VOLUME_IDENTIFIER_KIND_HAL_UDI, #G_VOLUME_IDENTIFIER_KIND_LABEL, etc.
* Use g_volume_get_identifier() to obtain an identifier for a volume.
* </para>
*
* Note that #G_VOLUME_IDENTIFIER_KIND_HAL_UDI will only be available

6
gio/gwin32inputstream.c
View File

@ -44,9 +44,9 @@
* #GWin32InputStream implements #GInputStream for reading from a
* Windows file handle.
*
* Note that <filename>&lt;gio/gwin32inputstream.h&gt;</filename> belongs
* to the Windows-specific GIO interfaces, thus you have to use the
* <filename>gio-windows-2.0.pc</filename> pkg-config file when using it.
* Note that `<gio/gwin32inputstream.h>` belongs to the Windows-specific GIO
* interfaces, thus you have to use the `gio-windows-2.0.pc` pkg-config file
* when using it.
*/
enum {

6
gio/gwin32outputstream.c
View File

@ -45,9 +45,9 @@
* #GWin32OutputStream implements #GOutputStream for writing to a
* Windows file handle.
*
* Note that <filename>&lt;gio/gwin32outputstream.h&gt;</filename> belongs
* to the Windows-specific GIO interfaces, thus you have to use the
* <filename>gio-windows-2.0.pc</filename> pkg-config file when using it.
* Note that `<gio/gwin32outputstream.h>` belongs to the Windows-specific GIO
* interfaces, thus you have to use the `gio-windows-2.0.pc` pkg-config file
* when using it.
*/
enum {

4
glib/docs.c
View File

@ -2319,8 +2319,8 @@
* @static: empty or "static"
* @dll_name: the name of the (pointer to the) char array where
* the DLL name will be stored. If this is used, you must also
* include <filename>windows.h</filename>. If you need a more
* complex DLL entry point function, you cannot use this
* include `windows.h`. If you need a more complex DLL entry
* point function, you cannot use this
*
* On Windows, this macro defines a DllMain() function that stores
* the actual DLL name that the code being compiled will be included in.

3
glib/gconvert.c
View File

@ -110,8 +110,7 @@
* encoding for file names in the <link
* linkend="G_FILENAME_ENCODING">`G_FILENAME_ENCODING`</link>
* environment variable. For example, if your installation uses
* ISO-8859-1 for file names, you can put this in your
* <filename>~/.profile</filename>:
* ISO-8859-1 for file names, you can put this in your `~/.profile`
* <programlisting>
* export G_FILENAME_ENCODING=ISO-8859-1
* </programlisting>

6
glib/ggettext.c
View File

@ -473,9 +473,9 @@ g_dngettext (const gchar *domain,
* easy-to-use form.
*
* In order to use these macros in an application, you must include
* <filename>glib/gi18n.h</filename>. For use in a library, you must include
* <filename>glib/gi18n-lib.h</filename> after defining the %GETTEXT_PACKAGE
* macro suitably for your library:
* `&lt;glib/gi18n.h&gt;`. For use in a library, you must include
* `&lt;glib/gi18n-lib.h&gt;`
* after defining the %GETTEXT_PACKAGE macro suitably for your library:
* |[<!-- language="C" -->
* #define GETTEXT_PACKAGE "gtk20"
* #include <glib/gi18n-lib.h>

4
glib/grand.c
View File

@ -208,8 +208,8 @@ g_rand_new_with_seed_array (const guint32 *seed,
* g_rand_new:
*
* Creates a new random number generator initialized with a seed taken
* either from <filename>/dev/urandom</filename> (if existing) or from
* the current time (as a fallback).
* either from `/dev/urandom` (if existing) or from the current time
* (as a fallback).
*
* On Windows, the seed is taken from rand_s().
*

8
glib/gstrfuncs.c
View File

@ -65,11 +65,9 @@
*
* Note that the functions g_printf(), g_fprintf(), g_sprintf(),
* g_snprintf(), g_vprintf(), g_vfprintf(), g_vsprintf() and g_vsnprintf()
* are declared in the header <filename>gprintf.h</filename> which is
* not included in <filename>glib.h</filename>
* (otherwise using <filename>glib.h</filename> would drag in
* <filename>stdio.h</filename>), so you'll have to explicitly include
* <literal>&lt;glib/gprintf.h&gt;</literal> in order to use the GLib
* are declared in the header `gprintf.h` which is not included in `glib.h`
* (otherwise using `glib.h` would drag in `stdio.h`), so you'll have to
* explicitly include `&lt;glib/gprintf.h&gt;` in order to use the GLib
* printf() functions.
*
* <para id="string-precision">

16
glib/gtestutils.c
View File

@ -188,16 +188,16 @@
/**
* GTestTrapFlags:
* @G_TEST_TRAP_SILENCE_STDOUT: Redirect stdout of the test child to
* <filename>/dev/null</filename> so it cannot be observed on the
* console during test runs. The actual output is still captured
* though to allow later tests with g_test_trap_assert_stdout().
* `/dev/null` so it cannot be observed on the console during test
* runs. The actual output is still captured though to allow later
* tests with g_test_trap_assert_stdout().
* @G_TEST_TRAP_SILENCE_STDERR: Redirect stderr of the test child to
* <filename>/dev/null</filename> so it cannot be observed on the
* console during test runs. The actual output is still captured
* though to allow later tests with g_test_trap_assert_stderr().
* `/dev/null` so it cannot be observed on the console during test
* runs. The actual output is still captured though to allow later
* tests with g_test_trap_assert_stderr().
* @G_TEST_TRAP_INHERIT_STDIN: If this flag is given, stdin of the
* child process is shared with stdin of its parent process.
* It is redirected to <filename>/dev/null</filename> otherwise.
* It is redirected to `/dev/null` otherwise.
*
* Test traps are guards around forked tests.
* These flags determine what traps to set.
@ -211,7 +211,7 @@
* GTestSubprocessFlags:
* @G_TEST_SUBPROCESS_INHERIT_STDIN: If this flag is given, the child
* process will inherit the parent's stdin. Otherwise, the child's
* stdin is redirected to <filename>/dev/null</filename>.
* stdin is redirected to `/dev/null`.
* @G_TEST_SUBPROCESS_INHERIT_STDOUT: If this flag is given, the child
* process will inherit the parent's stdout. Otherwise, the child's
* stdout will not be visible, but it will be captured to allow

11
glib/gtimezone.c
View File

@ -1316,7 +1316,7 @@ rules_from_identifier (const gchar *identifier,
* time values to be added to Coordinated Universal Time (UTC) to get
* the local time.
*
* In Unix, the `TZ` environment variable typically corresponds
* In UNIX, the `TZ` environment variable typically corresponds
* to the name of a file in the zoneinfo database, or string in
* "std offset [dst [offset],start[/time],end[/time]]" (POSIX) format.
* There are no spaces in the specification. The name of standard
@ -1340,11 +1340,10 @@ rules_from_identifier (const gchar *identifier,
*
* g_time_zone_new_local() calls this function with the value of the
* `TZ` environment variable. This function itself is independent of
* the value of `TZ`, but if @identifier is %NULL then
* <filename>/etc/localtime</filename> will be consulted
* to discover the correct time zone on Unix and the registry will be
* consulted or GetTimeZoneInformation() will be used to get the local
* time zone on Windows.
* the value of `TZ`, but if @identifier is %NULL then `/etc/localtime`
* will be consulted to discover the correct time zone on UNIX and the
* registry will be consulted or GetTimeZoneInformation() will be used
* to get the local time zone on Windows.
*
* If intervals are not available, only time zone rules from `TZ`
* environment variable or other means, then they will be computed

12
glib/gunidecomp.c
View File

@ -26,12 +26,12 @@
* @See_also: g_locale_to_utf8(), g_locale_from_utf8()
*
* This section describes a number of functions for dealing with
* Unicode characters and strings. There are analogues of the
* traditional <filename>ctype.h</filename> character classification
* and case conversion functions, UTF-8 analogues of some string utility
* functions, functions to perform normalization, case conversion and
* collation on UTF-8 strings and finally functions to convert between
* the UTF-8, UTF-16 and UCS-4 encodings of Unicode.
* Unicode characters and strings. There are analogues of the
* traditional `ctype.h` character classification and case conversion
* functions, UTF-8 analogues of some string utility functions,
* functions to perform normalization, case conversion and collation
* on UTF-8 strings and finally functions to convert between the UTF-8,
* UTF-16 and UCS-4 encodings of Unicode.
*
* The implementations of the Unicode functions in GLib are based
* on the Unicode Character Data tables, which are available from

26
glib/gutils.c
View File

@ -764,10 +764,10 @@ g_get_user_name (void)
/**
* g_get_real_name:
*
* Gets the real name of the user. This usually comes from the user's entry
* in the <filename>passwd</filename> file. The encoding of the returned
* string is system-defined. (On Windows, it is, however, always UTF-8.)
* If the real user name cannot be determined, the string "Unknown" is
* Gets the real name of the user. This usually comes from the user's
* entry in the `passwd` file. The encoding of the returned string is
* system-defined. (On Windows, it is, however, always UTF-8.) If the
* real user name cannot be determined, the string "Unknown" is
* returned.
*
* Returns: the user's real name.
@ -789,18 +789,16 @@ g_get_real_name (void)
*
* As with most UNIX tools, this function will return the value of the
* `HOME` environment variable if it is set to an existing absolute path
* name, falling back to the <filename>passwd</filename>
* file in the case that it is unset.
* name, falling back to the `passwd` file in the case that it is unset.
*
* If the path given in `HOME` is non-absolute, does not exist, or is
* not a directory, the result is undefined.
*
* Before version 2.36 this function would ignore the `HOME` environment
* variable, taking the value from the <filename>passwd</filename>
* database instead. This was changed to increase the compatibility
* of GLib with other programs (and the XDG basedir specification)
* and to increase testability of programs based on GLib (by making
* it easier to run them from test frameworks).
* variable, taking the value from the `passwd` database instead. This was
* changed to increase the compatibility of GLib with other programs (and
* the XDG basedir specification) and to increase testability of programs
* based on GLib (by making it easier to run them from test frameworks).
*
* If your program has a strong requirement for either the new or the
* old behaviour (and if you don't wish to increase your GLib
@ -1696,10 +1694,10 @@ g_reload_user_special_dirs_cache (void)
*
* Returns the full path of a special directory using its logical id.
*
* On Unix this is done using the XDG special user directories.
* On UNIX this is done using the XDG special user directories.
* For compatibility with existing practise, %G_USER_DIRECTORY_DESKTOP
* falls back to <filename>$HOME/Desktop</filename> when XDG special
* user directories have not been set up.
* falls back to `$HOME/Desktop` when XDG special user directories have
* not been set up.
*
* Depending on the platform, the user might be able to change the path
* of the special directory without requiring the session to restart; GLib

11
gmodule/gmodule.c
View File

@ -891,8 +891,8 @@ g_module_name (GModule *module)
/**
* g_module_build_path:
* @directory: (allow-none): the directory where the module is. This can be %NULL
* or the empty string to indicate that the standard platform-specific
* @directory: (allow-none): the directory where the module is. This can be
* %NULL or the empty string to indicate that the standard platform-specific
* directories will be used, though that is not recommended
* @module_name: the name of the module
*
@ -906,10 +906,9 @@ g_module_name (GModule *module)
* since the wrong module may be found.
*
* For example, calling g_module_build_path() on a Linux system with a
* @directory of <filename>/lib</filename> and a @module_name of "mylibrary"
* will return <filename>/lib/libmylibrary.so</filename>. On a Windows system,
* using <filename>\Windows</filename> as the directory it will return
* <filename>\Windows\mylibrary.dll</filename>.
* @directory of `/lib` and a @module_name of "mylibrary" will return
* `/lib/libmylibrary.so`. On a Windows system, using `\Windows` as the
* directory it will return `\Windows\mylibrary.dll`.
*
* Returns: the complete path of the module, including the standard library
* prefix and suffix. This should be freed when no longer needed