From: Philip Withnall <pwithnall@svn.gnome.org>
Date: Sun, 10 Feb 2008 04:48:31 +0000 (+0000)
Subject: Improve the documentation for the G_MODULE_EXPORT macro. (#514470)
X-Git-Url: http://git.openbox.org/?a=commitdiff_plain;h=39edc34bb411d9d19e03b44538b4709df481dd4a;p=dana%2Fcg-glib.git

Improve the documentation for the G_MODULE_EXPORT macro. (#514470)

2008-02-10  Philip Withnall  <pwithnall@svn.gnome.org>

	* glib/tmpl/modules.sgml: Improve the documentation for
	the G_MODULE_EXPORT macro. (#514470)


svn path=/trunk/; revision=6488
---

diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog
index 3ab002b8..433e63e3 100644
--- a/docs/reference/ChangeLog
+++ b/docs/reference/ChangeLog
@@ -1,3 +1,8 @@
+2008-02-10  Philip Withnall  <pwithnall@svn.gnome.org>
+
+	* glib/tmpl/modules.sgml: Improve the documentation for
+	the G_MODULE_EXPORT macro. (#514470)
+
 2008-02-09  Matthias Clasen  <mclasen@redhat.com>
 
 	* glib/tmpl/i18n.sgml: Improve the documentation for the
diff --git a/docs/reference/glib/tmpl/modules.sgml b/docs/reference/glib/tmpl/modules.sgml
index 962c579d..c87df973 100644
--- a/docs/reference/glib/tmpl/modules.sgml
+++ b/docs/reference/glib/tmpl/modules.sgml
@@ -183,7 +183,7 @@ not supported on all platforms.
 
 <!-- ##### FUNCTION g_module_symbol ##### -->
 <para>
-Gets a symbol pointer from a module.
+Gets a symbol pointer from a module, such as one exported by #G_MODULE_EXPORT.
 </para>
 <para>
 Note that a valid symbol can be %NULL.
@@ -266,7 +266,9 @@ for some HP-UX versions this is "sl" and for Windows this is "dll".
 
 <!-- ##### MACRO G_MODULE_EXPORT ##### -->
 <para>
-Used to declare functions exported by modules.
+Used to declare functions exported by modules. This is a no-op on Linux and
+Unices, but when compiling for Windows, it marks a symbol to be exported from
+the library or executable being built.
 </para>