docs: Move documentation to inline comments: general

1 files changed, 37 insertions, 0 deletions

diff --git a/gdk/gdkmain.h b/gdk/gdkmain.h
index f2ceaaa4bf..75ffb4e62a 100644
--- a/gdk/gdkmain.h
+++ b/gdk/gdkmain.h
@@ -50,6 +50,27 @@ gboolean              gdk_init_check                      (gint           *argc,
 void                  gdk_add_option_entries_libgtk_only  (GOptionGroup   *group);
 void                  gdk_pre_parse_libgtk_only           (void);
 
+/**
+ * gdk_set_locale:
+ *
+ * Initializes the support for internationalization by calling the <function>setlocale()</function>
+ * system call. This function is called by gtk_set_locale() and so GTK+
+ * applications should use that instead.
+ *
+ * The locale to use is determined by the <envar>LANG</envar> environment variable,
+ * so to run an application in a certain locale you can do something like this:
+ * <informalexample>
+ * <programlisting>
+ *   export LANG="fr"
+ *   ... run application ...
+ * </programlisting>
+ * </informalexample>
+ *
+ * If the locale is not supported by X then it is reset to the standard "C"
+ * locale.
+ *
+ * Returns: the resulting locale.
+ */
 gchar*                gdk_set_locale                      (void);
 void                  gdk_enable_multidevice              (void);
 
@@ -68,6 +89,15 @@ void                           gdk_error_trap_pop_ignored (void);
 
 
 G_CONST_RETURN gchar *gdk_get_display_arg_name (void);
+
+/**
+ * gdk_get_display:
+ *
+ * Gets the name of the display, which usually comes from the <envar>DISPLAY</envar>
+ * environment variable or the <option>--display</option> command line option.
+ *
+ * Returns: the name of the display.
+ */
 gchar*	              gdk_get_display          (void);
 
 #ifndef GDK_MULTIDEVICE_SAFE
@@ -102,6 +132,13 @@ void gdk_beep (void);
 
 #endif /* GDK_MULTIHEAD_SAFE */
 
+/**
+ * gdk_flush:
+ *
+ * Flushes the X output buffer and waits until all requests have been processed
+ * by the server. This is rarely needed by applications. It's main use is for
+ * trapping X errors with gdk_error_trap_push() and gdk_error_trap_pop().
+ */
 void gdk_flush (void);
 
 G_END_DECLS