[glibmm/glibmm-2-60] Glib::init(), Gio::init(): Improve the documentation



commit 74436563f29c30c7bdbcdef3ec270a1c8f04fde0
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date:   Tue Jul 9 16:21:24 2019 +0200

    Glib::init(), Gio::init(): Improve the documentation
    
    See issue #49

 gio/giomm/init.h   |  8 +++++++-
 glib/glibmm/init.h | 12 ++++++------
 2 files changed, 13 insertions(+), 7 deletions(-)
---
diff --git a/gio/giomm/init.h b/gio/giomm/init.h
index 345e8194..1ce3ac5d 100644
--- a/gio/giomm/init.h
+++ b/gio/giomm/init.h
@@ -24,7 +24,13 @@
 namespace Gio
 {
 
-/** Initialize giomm.
+/** Initialize giomm and glibmm.
+ *
+ * Call it before you use other parts of giomm. You may call it more than once.
+ * Calls after the first one have no effect. %Gio::init() calls Glib::init().
+ *
+ * You do not need to call %Gio::init() if you are using Gtk::Application,
+ * because it calls %Gio::init() for you.
  */
 void init();
 
diff --git a/glib/glibmm/init.h b/glib/glibmm/init.h
index 1245cd37..509e7170 100644
--- a/glib/glibmm/init.h
+++ b/glib/glibmm/init.h
@@ -1,9 +1,6 @@
-// -*- c++ -*-
 #ifndef _GLIBMM_INIT_H
 #define _GLIBMM_INIT_H
 
-/* $Id$ */
-
 /* Copyright (C) 2002 The gtkmm Development Team
  *
  * This library is free software; you can redistribute it and/or
@@ -24,9 +21,12 @@ namespace Glib
 {
 
 /** Initialize glibmm.
- * You may call this more than once.
- * You do not need to call this if you are using Glib::MainLoop or Gtk::Main,
- * because they call it 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.
+ *
+ * You do not need to call %Glib::init() if you are using Gtk::Application or
+ * Gio::init(), because they call %Glib::init() for you.
  */
 void init();
 


[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]