Docs: don't use the structname tag

Just avoid explicit docbook markup.
This commit is contained in:
Matthias Clasen 2014-01-31 00:29:14 -05:00
parent 6f3c465535
commit 3d42934b71
11 changed files with 86 additions and 93 deletions

View File

@ -132,8 +132,8 @@
/** /**
* GApplicationCommandLineClass: * GApplicationCommandLineClass:
* *
* The <structname>GApplicationCommandLineClass</structname> structure * The #GApplicationCommandLineClass-struct
* contains private data only * contains private data only.
* *
* Since: 2.28 * Since: 2.28
**/ **/

View File

@ -1547,9 +1547,9 @@ g_ptr_array_foreach (GPtrArray *array,
* elements are added to the #GByteArray. * elements are added to the #GByteArray.
* @len: the number of elements in the #GByteArray. * @len: the number of elements in the #GByteArray.
* *
* The <structname>GByteArray</structname> struct allows access to the * The #GByteArray-struct allows access to the public fields of
* public fields of a <structname>GByteArray</structname>. * a #GByteArray.
**/ */
/** /**
* g_byte_array_new: * g_byte_array_new:

View File

@ -117,8 +117,8 @@
* @tv_usec: microseconds * @tv_usec: microseconds
* *
* Represents a precise time, with seconds and microseconds. * Represents a precise time, with seconds and microseconds.
* Similar to the <structname>struct timeval</structname> returned by * Similar to the struct timeval returned by the gettimeofday()
* the gettimeofday() UNIX system call. * UNIX system call.
* *
* GLib is attempting to unify around the use of 64bit integers to * GLib is attempting to unify around the use of 64bit integers to
* represent microsecond-precision time. As such, this type will be * represent microsecond-precision time. As such, this type will be
@ -137,29 +137,32 @@
* @year: the day of the day-month-year representation of the date * @year: the day of the day-month-year representation of the date
* *
* Represents a day between January 1, Year 1 and a few thousand years in * Represents a day between January 1, Year 1 and a few thousand years in
* the future. None of its members should be accessed directly. If the * the future. None of its members should be accessed directly.
* <structname>GDate</structname> is obtained from g_date_new(), it will *
* be safe to mutate but invalid and thus not safe for calendrical * If the #GDate-struct is obtained from g_date_new(), it will be safe
* computations. If it's declared on the stack, it will contain garbage * to mutate but invalid and thus not safe for calendrical computations.
* so must be initialized with g_date_clear(). g_date_clear() makes the *
* date invalid but sane. An invalid date doesn't represent a day, it's * If it's declared on the stack, it will contain garbage so must be
* "empty." A date becomes valid after you set it to a Julian day or you * initialized with g_date_clear(). g_date_clear() makes the date invalid
* set a day, month, and year. * but sane. An invalid date doesn't represent a day, it's "empty." A date
* becomes valid after you set it to a Julian day or you set a day, month,
* and year.
*/ */
/** /**
* GTime: * GTime:
* *
* Simply a replacement for <type>time_t</type>. It has been deprecated * Simply a replacement for time_t. It has been deprecated
* since it is <emphasis>not</emphasis> equivalent to <type>time_t</type> * since it is <emphasis>not</emphasis> equivalent to time_t
* on 64-bit platforms with a 64-bit <type>time_t</type>. * on 64-bit platforms with a 64-bit time_t. Unrelated to #GTimer.
* Unrelated to #GTimer.
* *
* Note that <type>GTime</type> is defined to always be a 32bit integer, * Note that #GTime is defined to always be a 32bit integer,
* unlike <type>time_t</type> which may be 64bit on some systems. * unlike time_t which may be 64bit on some systems. Therefore,
* Therefore, <type>GTime</type> will overflow in the year 2038, and * #GTime will overflow in the year 2038, and you cannot use the
* you cannot use the address of a <type>GTime</type> variable as argument * address of a #GTime variable as argument to the UNIX time()
* to the UNIX time() function. Instead, do the following: * function.
*
* Instead, do the following:
* |[ * |[
* time_t ttime; * time_t ttime;
* GTime gtime; * GTime gtime;
@ -1936,12 +1939,11 @@ g_date_compare (const GDate *lhs,
/** /**
* g_date_to_struct_tm: * g_date_to_struct_tm:
* @date: a #GDate to set the <structname>struct tm</structname> from * @date: a #GDate to set the struct tm from
* @tm: <structname>struct tm</structname> to fill * @tm: struct tm to fill
* *
* Fills in the date-related bits of a <structname>struct tm</structname> * Fills in the date-related bits of a struct tm using the @date value.
* using the @date value. Initializes the non-date parts with something * Initializes the non-date parts with something sane but meaningless.
* sane but meaningless.
*/ */
void void
g_date_to_struct_tm (const GDate *d, g_date_to_struct_tm (const GDate *d,

View File

@ -59,8 +59,7 @@
* The default behaviour is to call the hooks @destroy function * The default behaviour is to call the hooks @destroy function
* @dummy: unused * @dummy: unused
* *
* The <structname>GHookList</structname> struct represents a * The #GHookList-struct represents a list of hook functions.
* list of hook functions.
*/ */
/** /**
@ -157,8 +156,7 @@
* @destroy: the default @finalize_hook function of a #GHookList calls * @destroy: the default @finalize_hook function of a #GHookList calls
* this member of the hook that is being finalized * this member of the hook that is being finalized
* *
* The <structname>GHook</structname> struct represents a single hook * The #GHook-struct represents a single hook function in a #GHookList.
* function in a #GHookList.
*/ */
/** /**

View File

@ -56,10 +56,9 @@
/** /**
* GPatternSpec: * GPatternSpec:
* *
* A <structname>GPatternSpec</structname> is the 'compiled' form of a * A #GPatternSpec-struct is the 'compiled' form of a pattern. This
* pattern. This structure is opaque and its fields cannot be accessed * structure is opaque and its fields cannot be accessed directly.
* directly. */
**/
/* keep enum and structure of gpattern.c and patterntest.c in sync */ /* keep enum and structure of gpattern.c and patterntest.c in sync */
typedef enum typedef enum

View File

@ -101,10 +101,9 @@
* doesn't yield equally distributed numbers. * doesn't yield equally distributed numbers.
* *
* GLib changed the seeding algorithm for the pseudo-random number * GLib changed the seeding algorithm for the pseudo-random number
* generator Mersenne Twister, as used by * generator Mersenne Twister, as used by #GRand and #GRandom.
* <structname>GRand</structname> and <structname>GRandom</structname>.
* This was necessary, because some seeds would yield very bad * This was necessary, because some seeds would yield very bad
* pseudo-random streams. Also the pseudo-random integers generated by * pseudo-random streams. Also the pseudo-random integers generated by
* <function>g_rand*_int_range()</function> will have a slightly better * <function>g_rand*_int_range()</function> will have a slightly better
* equal distribution with the new version of GLib. * equal distribution with the new version of GLib.
* *

View File

@ -74,8 +74,8 @@
* See your C library manual for more details about access(). * See your C library manual for more details about access().
* *
* Returns: zero if the pathname refers to an existing file system * Returns: zero if the pathname refers to an existing file system
* object that has all the tested permissions, or -1 otherwise or on * object that has all the tested permissions, or -1 otherwise
* error. * or on error.
* *
* Since: 2.8 * Since: 2.8
*/ */
@ -126,7 +126,7 @@ g_access (const gchar *filename,
* *
* See your C library manual for more details about chmod(). * See your C library manual for more details about chmod().
* *
* Returns: zero if the operation succeeded, -1 on error. * Returns: 0 if the operation succeeded, -1 on error
* *
* Since: 2.8 * Since: 2.8
*/ */
@ -181,8 +181,9 @@ g_chmod (const gchar *filename,
* *
* See your C library manual for more details about open(). * See your C library manual for more details about open().
* *
* Returns: a new file descriptor, or -1 if an error occurred. The * Returns: a new file descriptor, or -1 if an error occurred.
* return value can be used exactly like the return value from open(). * The return value can be used exactly like the return value
* from open().
* *
* Since: 2.6 * Since: 2.6
*/ */
@ -243,8 +244,9 @@ g_open (const gchar *filename,
* *
* See your C library manual for more details about creat(). * See your C library manual for more details about creat().
* *
* Returns: a new file descriptor, or -1 if an error occurred. The * Returns: a new file descriptor, or -1 if an error occurred.
* return value can be used exactly like the return value from creat(). * The return value can be used exactly like the return value
* from creat().
* *
* Since: 2.8 * Since: 2.8
*/ */
@ -432,41 +434,40 @@ g_chdir (const gchar *path)
/** /**
* GStatBuf: * GStatBuf:
* *
* A type corresponding to the appropriate struct type for the stat * A type corresponding to the appropriate struct type for the stat()
* system call, depending on the platform and/or compiler being used. * system call, depending on the platform and/or compiler being used.
* *
* See g_stat() for more information. * See g_stat() for more information.
**/ */
/** /**
* g_stat: * g_stat:
* @filename: a pathname in the GLib file name encoding (UTF-8 on Windows) * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
* @buf: a pointer to a <structname>stat</structname> struct, which * @buf: a pointer to a stat struct, which will be filled with the file
* will be filled with the file information * information
* *
* A wrapper for the POSIX stat() function. The stat() function * A wrapper for the POSIX stat() function. The stat() function
* returns information about a file. On Windows the stat() function in * returns information about a file. On Windows the stat() function in
* the C library checks only the FAT-style READONLY attribute and does * the C library checks only the FAT-style READONLY attribute and does
* not look at the ACL at all. Thus on Windows the protection bits in * not look at the ACL at all. Thus on Windows the protection bits in
* the st_mode field are a fabrication of little use. * the @st_mode field are a fabrication of little use.
* *
* On Windows the Microsoft C libraries have several variants of the * On Windows the Microsoft C libraries have several variants of the
* <structname>stat</structname> struct and stat() function with names * stat struct and stat() function with names like _stat(), _stat32(),
* like "_stat", "_stat32", "_stat32i64" and "_stat64i32". The one * _stat32i64() and _stat64i32(). The one used here is for 32-bit code
* used here is for 32-bit code the one with 32-bit size and time * the one with 32-bit size and time fields, specifically called _stat32().
* fields, specifically called "_stat32".
* *
* In Microsoft's compiler, by default "struct stat" means one with * In Microsoft's compiler, by default struct stat means one with
* 64-bit time fields while in MinGW "struct stat" is the legacy one * 64-bit time fields while in MinGW struct stat is the legacy one
* with 32-bit fields. To hopefully clear up this messs, the gstdio.h * with 32-bit fields. To hopefully clear up this messs, the gstdio.h
* header defines a type GStatBuf which is the appropriate struct type * header defines a type #GStatBuf which is the appropriate struct type
* depending on the platform and/or compiler being used. On POSIX it * depending on the platform and/or compiler being used. On POSIX it
* is just "struct stat", but note that even on POSIX platforms, * is just struct stat, but note that even on POSIX platforms, stat()
* "stat" might be a macro. * might be a macro.
* *
* See your C library manual for more details about stat(). * See your C library manual for more details about stat().
* *
* Returns: 0 if the information was successfully retrieved, -1 if an error * Returns: 0 if the information was successfully retrieved,
* occurred * -1 if an error occurred
* *
* Since: 2.6 * Since: 2.6
*/ */
@ -508,8 +509,8 @@ g_stat (const gchar *filename,
/** /**
* g_lstat: * g_lstat:
* @filename: a pathname in the GLib file name encoding (UTF-8 on Windows) * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
* @buf: a pointer to a <structname>stat</structname> struct, which * @buf: a pointer to a stat struct, which will be filled with the file
* will be filled with the file information * information
* *
* A wrapper for the POSIX lstat() function. The lstat() function is * A wrapper for the POSIX lstat() function. The lstat() function is
* like stat() except that in the case of symbolic links, it returns * like stat() except that in the case of symbolic links, it returns
@ -519,8 +520,8 @@ g_stat (const gchar *filename,
* *
* See your C library manual for more details about lstat(). * See your C library manual for more details about lstat().
* *
* Returns: 0 if the information was successfully retrieved, -1 if an error * Returns: 0 if the information was successfully retrieved,
* occurred * -1 if an error occurred
* *
* Since: 2.6 * Since: 2.6
*/ */
@ -678,24 +679,22 @@ g_rmdir (const gchar *filename)
/** /**
* g_fopen: * g_fopen:
* @filename: a pathname in the GLib file name encoding (UTF-8 on Windows) * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
* @mode: a string describing the mode in which the file should be * @mode: a string describing the mode in which the file should be opened
* opened
* *
* A wrapper for the stdio fopen() function. The fopen() function * A wrapper for the stdio fopen() function. The fopen() function
* opens a file and associates a new stream with it. * opens a file and associates a new stream with it.
* *
* Because file descriptors are specific to the C library on Windows, * Because file descriptors are specific to the C library on Windows,
* and a file descriptor is partof the <type>FILE</type> struct, the * and a file descriptor is part of the FILE struct, the FILE* returned
* <type>FILE</type> pointer returned by this function makes sense * by this function makes sense only to functions in the same C library.
* only to functions in the same C library. Thus if the GLib-using * Thus if the GLib-using code uses a different C library than GLib does,
* code uses a different C library than GLib does, the * the FILE* returned by this function cannot be passed to C library
* <type>FILE</type> pointer returned by this function cannot be * functions like fprintf() or fread().
* passed to C library functions like fprintf() or fread().
* *
* See your C library manual for more details about fopen(). * See your C library manual for more details about fopen().
* *
* Returns: A <type>FILE</type> pointer if the file was successfully * Returns: A FILE* if the file was successfully opened, or %NULL if
* opened, or %NULL if an error occurred * an error occurred
* *
* Since: 2.6 * Since: 2.6
*/ */
@ -740,8 +739,7 @@ g_fopen (const gchar *filename,
/** /**
* g_freopen: * g_freopen:
* @filename: a pathname in the GLib file name encoding (UTF-8 on Windows) * @filename: a pathname in the GLib file name encoding (UTF-8 on Windows)
* @mode: a string describing the mode in which the file should be * @mode: a string describing the mode in which the file should be opened
* opened
* @stream: (allow-none): an existing stream which will be reused, or %NULL * @stream: (allow-none): an existing stream which will be reused, or %NULL
* *
* A wrapper for the POSIX freopen() function. The freopen() function * A wrapper for the POSIX freopen() function. The freopen() function
@ -749,8 +747,8 @@ g_fopen (const gchar *filename,
* *
* See your C library manual for more details about freopen(). * See your C library manual for more details about freopen().
* *
* Returns: A <literal>FILE</literal> pointer if the file was successfully * Returns: A FILE* if the file was successfully opened, or %NULL if
* opened, or %NULL if an error occurred. * an error occurred.
* *
* Since: 2.6 * Since: 2.6
*/ */
@ -804,8 +802,7 @@ g_freopen (const gchar *filename,
* See your C library manual for more details about how utime() works * See your C library manual for more details about how utime() works
* on your system. * on your system.
* *
* Returns: 0 if the operation was successful, -1 if an error * Returns: 0 if the operation was successful, -1 if an error occurred
* occurred
* *
* Since: 2.18 * Since: 2.18
*/ */

View File

@ -47,7 +47,7 @@
* bytes of the element * bytes of the element
* *
* Each piece of memory that is pushed onto the stack * Each piece of memory that is pushed onto the stack
* is cast to a <structname>GTrashStack*</structname>. * is cast to a GTrashStack*.
*/ */
/** /**

View File

@ -73,10 +73,9 @@ typedef struct _GTreeNode GTreeNode;
/** /**
* GTree: * GTree:
* *
* The <structname>GTree</structname> struct is an opaque data * The #GTree-struct is an opaque data structure representing a <link
* structure representing a <link * linkend="glib-Balanced-Binary-Trees">Balanced Binary Tree</link>.
* linkend="glib-Balanced-Binary-Trees">Balanced Binary Tree</link>. It * It should be accessed only by using the following functions.
* should be accessed only by using the following functions.
*/ */
struct _GTree struct _GTree
{ {

View File

@ -82,7 +82,7 @@
* it must ensure that it is never unloaded, by calling g_module_make_resident(). * it must ensure that it is never unloaded, by calling g_module_make_resident().
* *
* <example> * <example>
* <title>Calling a function defined in a <structname>GModule</structname></title> * <title>Calling a function defined in a GModule</title>
* <programlisting> * <programlisting>
* /&ast; the function signature for 'say_hello' &ast;/ * /&ast; the function signature for 'say_hello' &ast;/
* typedef void (* SayHelloFunc) (const char *message); * typedef void (* SayHelloFunc) (const char *message);

View File

@ -4422,10 +4422,9 @@ gobject_init_ctor (void)
* G_TYPE_INSTANCE_GET_PRIVATE() macro. * G_TYPE_INSTANCE_GET_PRIVATE() macro.
* *
* The following example shows attaching a private structure * The following example shows attaching a private structure
* <structname>MyObjectPrivate</structname> to an object * MyObjectPrivate to an object MyObject defined in the standard
* <structname>MyObject</structname> defined in the standard GObject * GObject fashion in the type's class_init() function.
* fashion. *
* type's class_init() function.
* Note the use of a structure member "priv" to avoid the overhead * Note the use of a structure member "priv" to avoid the overhead
* of repeatedly calling MY_OBJECT_GET_PRIVATE(). * of repeatedly calling MY_OBJECT_GET_PRIVATE().
* *