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

Bug 563150 – G_GU?INT*_MODIFIER/FORMAT docs

Browse Source 
2008-12-07  Behdad Esfahbod  <behdad@gnome.org>

        Bug 563150 – G_GU?INT*_MODIFIER/FORMAT docs

        * glib/tmpl/glib-unused.sgml:
        * glib/tmpl/macros_misc.sgml:
        * glib/tmpl/types.sgml:
        Update docs to mention scanning as well as printing.
        Cross reference these from their respective types.


svn path=/trunk/; revision=7730
This commit is contained in:
Behdad Esfahbod 2008-12-08 02:11:30 +00:00 committed by Behdad Esfahbod
parent 2228a1cd0d
commit 8426d48f39
3 changed files with 51 additions and 18 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
docs/reference/ChangeLog
View File

@ -1,3 +1,13 @@
2008-12-07 Behdad Esfahbod <behdad@gnome.org>
Bug 563150 – G_GU?INT*_MODIFIER/FORMAT docs
* glib/tmpl/glib-unused.sgml:
* glib/tmpl/macros_misc.sgml:
* glib/tmpl/types.sgml:
Update docs to mention scanning as well as printing.
Cross reference these from their respective types.
2008-12-01 Matthias Clasen <mclasen@redhat.com>
* === Released 2.19.2 ===

27
docs/reference/glib/tmpl/macros_misc.sgml
View File

@ -353,16 +353,6 @@ See the GNU C documentation for details.
<!-- ##### MACRO G_HAVE_GNUC_VISIBILITY ##### -->
<para>
This macro is defined as 1 if the compiler supports ELF visibility
attributes (currently only <command>gcc</command>).
</para>
Since: 2.6
<!-- ##### MACRO G_GNUC_INTERNAL ##### -->
<para>
This attribute can be used for marking library functions as being used
@ -454,8 +444,8 @@ Expands to a string identifying the current function.
<!-- ##### MACRO G_GINT16_MODIFIER ##### -->
<para>
The platform dependent length modifier for constructing printf() conversion
specifiers for values of type #gint16 or #guint16. It is a string literal,
The platform dependent length modifier for conversion specifiers for scanning
and printing values of type #gint16 or #guint16. It is a string literal,
but doesn't include the percent-sign, such that you can add precision and
length modifiers between percent-sign and conversion specifier and append a
conversion specifier.
@ -506,8 +496,9 @@ printing values of type #guint16. See also #G_GINT16_FORMAT.
<!-- ##### MACRO G_GINT32_MODIFIER ##### -->
<para>
The platform dependent length modifier for constructing printf() conversion
specifiers for values of type #gint32 or #guint32. See also #G_GINT16_MODIFIER.
The platform dependent length modifier for conversion specifiers for scanning
and printing values of type #gint32 or #guint32. It is a string literal,
See also #G_GINT16_MODIFIER.
</para>
@Since: 2.4
@ -531,8 +522,8 @@ printing values of type #guint32. See also #G_GINT16_FORMAT.
<!-- ##### MACRO G_GINT64_MODIFIER ##### -->
<para>
The platform dependent length modifier for constructing printf() conversion
specifiers for values of type #gint64 or #guint64. See also #G_GINT16_MODIFIER.
The platform dependent length modifier for conversion specifiers for scanning
and printing values of type #gint64 or #guint64. It is a string literal,
</para>
<note>
@ -584,8 +575,8 @@ recommended for parsing anyway; consider using g_strtoull() instead.
<!-- ##### MACRO G_GSIZE_MODIFIER ##### -->
<para>
The platform dependent length modifier for constructing printf() conversion
specifiers for values of type #gsize or #gssize. See also #G_GINT16_MODIFIER.
The platform dependent length modifier for conversion specifiers for scanning
and printing values of type #gsize or #gssize. It is a string literal,
</para>
@Since: 2.6

32
docs/reference/glib/tmpl/types.sgml
View File

@ -138,6 +138,10 @@ Values of this type can range from 0 to 255.
A signed integer guaranteed to be 16 bits on all platforms.
Values of this type can range from -32,768 to 32,767.
</para>
<para>
To print or scan values of this type, use
%G_GINT16_MODIFIER and/or %G_GINT16_FORMAT.
</para>
<!-- ##### TYPEDEF guint16 ##### -->
@ -145,6 +149,10 @@ Values of this type can range from -32,768 to 32,767.
An unsigned integer guaranteed to be 16 bits on all platforms.
Values of this type can range from 0 to 65,535.
</para>
<para>
To print or scan values of this type, use
%G_GINT16_MODIFIER and/or %G_GUINT16_FORMAT.
</para>
<!-- ##### TYPEDEF gint32 ##### -->
@ -152,6 +160,10 @@ Values of this type can range from 0 to 65,535.
A signed integer guaranteed to be 32 bits on all platforms.
Values of this type can range from -2,147,483,648 to 2,147,483,647.
</para>
<para>
To print or scan values of this type, use
%G_GINT32_MODIFIER and/or %G_GINT32_FORMAT.
</para>
<!-- ##### TYPEDEF guint32 ##### -->
@ -159,6 +171,10 @@ Values of this type can range from -2,147,483,648 to 2,147,483,647.
An unsigned integer guaranteed to be 32 bits on all platforms.
Values of this type can range from 0 to 4,294,967,295.
</para>
<para>
To print or scan values of this type, use
%G_GINT32_MODIFIER and/or %G_GUINT32_FORMAT.
</para>
<!-- ##### MACRO G_HAVE_GINT64 ##### -->
@ -177,6 +193,10 @@ A signed integer guaranteed to be 64 bits on all platforms.
Values of this type can range from -9,223,372,036,854,775,808 to
9,223,372,036,854,775,807.
</para>
<para>
To print or scan values of this type, use
%G_GINT64_MODIFIER and/or %G_GINT64_FORMAT.
</para>
<!-- ##### FUNCTION guint64 ##### -->
@ -184,6 +204,10 @@ Values of this type can range from -9,223,372,036,854,775,808 to
An unsigned integer guaranteed to be 64 bits on all platforms.
Values of this type can range from 0 to 18,446,744,073,709,551,615.
</para>
<para>
To print or scan values of this type, use
%G_GINT64_MODIFIER and/or %G_GUINT64_FORMAT.
</para>
@Returns:
@ -227,12 +251,20 @@ to the size_t type defined in C99. This type is wide enough to hold the numeric
value of a pointer, so it is usually 32bit wide on a 32bit platform and
64bit wide on a 64bit platform.
</para>
<para>
To print or scan values of this type, use
%G_GSIZE_MODIFIER and/or %G_GSIZE_FORMAT.
</para>
<!-- ##### TYPEDEF gssize ##### -->
<para>
A signed variant of gsize, corresponding to the ssize_t defined on most platforms.
</para>
<para>
To print or scan values of this type, use
%G_GSIZE_MODIFIER and/or %G_GSSIZE_FORMAT.
</para>
<!-- ##### TYPEDEF goffset ##### -->