Commit 3de6638d authored by Sebastian Wilhelmi's avatar Sebastian Wilhelmi Committed by Sebastian Wilhelmi

Added documentation for G_MAXU(INT|SHORT|LONG).


2000-10-30  Sebastian Wilhelmi  <wilhelmi@ira.uka.de>

	* glib/tmpl/limits.sgml: Added documentation for
	G_MAXU(INT|SHORT|LONG).

	* glib/tmpl/macros_misc.sgml: Added documentation for
	G_G(U)INT(16|32|64)_FORMAT.

	* glib/tmpl/types.sgml: Mention G_MAXU(INT|SHORT|LONG) in
	documentation for gu(int|short|long).
parent f8314fd1
2000-10-30 Sebastian Wilhelmi <wilhelmi@ira.uka.de>
* glib/tmpl/limits.sgml: Added documentation for
G_MAXU(INT|SHORT|LONG).
* glib/tmpl/macros_misc.sgml: Added documentation for
G_G(U)INT(16|32|64)_FORMAT.
* glib/tmpl/types.sgml: Mention G_MAXU(INT|SHORT|LONG) in
documentation for gu(int|short|long).
* glib/glib-sections.txt, glib/tmpl/linked_lists_double.sgml,
glib/tmpl/caches.sgml: Move GCompareFunc to GList and introduce
and document GEqualFunc in GHashTable.
......
......@@ -31,7 +31,7 @@ The maximum value which can be held in a #gint.
<!-- ##### MACRO G_MAXUINT ##### -->
<para>
The maximum value which can be held in a #guint.
</para>
......@@ -52,7 +52,7 @@ The maximum value which can be held in a #gshort.
<!-- ##### MACRO G_MAXUSHORT ##### -->
<para>
The maximum value which can be held in a #gushort.
</para>
......@@ -73,7 +73,7 @@ The maximum value which can be held in a #glong.
<!-- ##### MACRO G_MAXULONG ##### -->
<para>
The maximum value which can be held in a #gulong.
</para>
......
......@@ -195,43 +195,79 @@ and function prototype. See the GNU C documentation for details.
<!-- ##### MACRO G_GINT16_FORMAT ##### -->
<para>
This is the platform dependent conversion specifier for scanning and
printing values of type #gint16. 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.
</para>
<para>
<informalexample>
<programlisting>
gint16 in;
gint32 out;
sscanf ("42", "%" G_GINT16_FORMAT, &amp;in)
out = in * 1000;
g_print ("%" G_GINT32_FORMAT, out);
</programlisting>
</informalexample>
</para>
<!-- ##### MACRO G_GUINT16_FORMAT ##### -->
<para>
This is the platform dependent conversion specifier for scanning and
printing values of type #guint16. See also #G_GINT16_FORMAT.
</para>
<!-- ##### MACRO G_GINT32_FORMAT ##### -->
<para>
This is the platform dependent conversion specifier for scanning and
printing values of type #gint32. See also #G_GINT16_FORMAT.
</para>
<!-- ##### MACRO G_GUINT32_FORMAT ##### -->
<para>
This is the platform dependent conversion specifier for scanning and
printing values of type #guint32. See also #G_GINT16_FORMAT.
</para>
<!-- ##### MACRO G_GINT64_FORMAT ##### -->
<para>
This is the platform dependent conversion specifier for scanning and
printing values of type #gint64. See also #G_GINT16_FORMAT.
</para>
<note>
<para>
Some platforms do not support scanning and printing 64 bit integers,
even though the types are supported. On such platforms G_GINT64_FORMAT
is not defined.
</para>
</note>
<!-- ##### MACRO G_GUINT64_FORMAT ##### -->
<para>
This is the platform dependent conversion specifier for scanning and
printing values of type #guint64. See also #G_GINT16_FORMAT.
</para>
<note>
<para>
Some platforms do not support scanning and printing 64 bit integers,
even though the types are supported. On such platforms G_GUINT64_FORMAT
is not defined.
</para>
</note>
......@@ -84,6 +84,7 @@ Values of this type can range from #G_MININT to #G_MAXINT.
<!-- ##### TYPEDEF guint ##### -->
<para>
Corresponds to the standard C <type>unsigned int</type> type.
Values of this type can range from 0 to #G_MAXUINT.
</para>
......@@ -97,6 +98,7 @@ Values of this type can range from #G_MINSHORT to #G_MAXSHORT.
<!-- ##### TYPEDEF gushort ##### -->
<para>
Corresponds to the standard C <type>unsigned short</type> type.
Values of this type can range from 0 to #G_MAXUSHORT.
</para>
......@@ -110,6 +112,7 @@ Values of this type can range from #G_MINLONG to #G_MAXLONG.
<!-- ##### TYPEDEF gulong ##### -->
<para>
Corresponds to the standard C <type>unsigned long</type> type.
Values of this type can range from 0 to #G_MAXULONG.
</para>
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment