Add some discouraging comments to the G_INLINE_FUNC macros. (#310836,

2005-07-20  Matthias Clasen  <mclasen@redhat.com>

	* glib/tmpl/macros_misc.sgml: Add some discouraging
	comments to the G_INLINE_FUNC macros.  (#310836,
	Callum McKenzie)
This commit is contained in:
Matthias Clasen 2005-07-20 15:41:19 +00:00 committed by Matthias Clasen
parent f0a0fe7a44
commit e81747cdc0
2 changed files with 17 additions and 3 deletions

View File

@ -1,3 +1,9 @@
2005-07-20 Matthias Clasen <mclasen@redhat.com>
* glib/tmpl/macros_misc.sgml: Add some discouraging
comments to the G_INLINE_FUNC macros. (#310836,
Callum McKenzie)
2005-07-19 Matthias Clasen <mclasen@redhat.com> 2005-07-19 Matthias Clasen <mclasen@redhat.com>
* glib/tmpl/byte_order.sgml: Add docs for #307047, * glib/tmpl/byte_order.sgml: Add docs for #307047,

View File

@ -20,10 +20,18 @@ by application programmers.
<!-- ##### MACRO G_INLINE_FUNC ##### --> <!-- ##### MACRO G_INLINE_FUNC ##### -->
<para> <para>
Used to declare inline functions. If inline functions are not supported on This macro is used to export function prototypes so they can be linked
the particular platform, the macro evaluates to the empty string. with an external version when no inlining is performed. The file which
implements the functions should define %G_IMPLEMENTS_INLINES
before including the headers which contain %G_INLINE_FUNC declarations.
Since inlining is very compiler-dependent using these macros correctly
is very difficult. Their use is strongly discouraged.
</para>
<para>
This macro is often mistaken for a replacement for the inline keyword;
inline is already declared in a portable manner in the glib headers
and can be used normally.
</para> </para>
<!-- ##### MACRO G_STMT_START ##### --> <!-- ##### MACRO G_STMT_START ##### -->