summaryrefslogtreecommitdiff
path: root/glib
diff options
context:
space:
mode:
authorKjell Ahlstedt <kjellahlstedt@gmail.com>2019-07-09 16:24:55 +0200
committerKjell Ahlstedt <kjellahlstedt@gmail.com>2019-07-09 16:24:55 +0200
commitb82a639c24b0419f1cf8ad6a112d20dfed3d00df (patch)
tree23b9c17ba173033cc6c4c2095b261631350bb56f /glib
parentababc413ffbbcc22ccc0af6675285183d5ef9e69 (diff)
downloadglibmm-b82a639c24b0419f1cf8ad6a112d20dfed3d00df.tar.gz
Glib::init(), Gio::init(): Improve the documentation
See issue #49
Diffstat (limited to 'glib')
-rw-r--r--glib/glibmm/init.h10
1 files changed, 6 insertions, 4 deletions
diff --git a/glib/glibmm/init.h b/glib/glibmm/init.h
index f93d9d59..f41040af 100644
--- a/glib/glibmm/init.h
+++ b/glib/glibmm/init.h
@@ -22,10 +22,12 @@ namespace Glib
/** Initialize glibmm.
*
- * You may call this more than once. Calls after the first one have no effect.
- * Sets the global locale as specified by set_init_to_users_preferred_locale().
- * You do not need to call %Glib::init() if you are using Gtk::Application,
- * because it calls %Glib::init() for you.
+ * Call it before you use other parts of glibmm. You may call it more than once.
+ * Calls after the first one have no effect. %Glib::init() sets the global locale
+ * as specified by set_init_to_users_preferred_locale().
+ *
+ * You do not need to call %Glib::init() if you are using Gtk::Application or
+ * Gio::init(), because they call %Glib::init() for you.
*
* @see set_init_to_users_preferred_locale()
*/