[gtk+] Move documentation to inline comments: GtkStatusIcon

[Javier Jardón <jjardon src gnome org>]

commit 94e977538daa97ccc92dfed0a5ec2b00c3d3d60a
Author: Javier Jardón <jjardon gnome org>
Date:   Wed Apr 13 01:07:48 2011 +0100

    Move documentation to inline comments: GtkStatusIcon

 docs/reference/gtk/tmpl/.gitignore         |    1 +
 docs/reference/gtk/tmpl/gtkstatusicon.sgml |  504 ----------------------------
 gtk/gtkstatusicon.c                        |   30 ++
 3 files changed, 31 insertions(+), 504 deletions(-)
---
diff --git a/docs/reference/gtk/tmpl/.gitignore b/docs/reference/gtk/tmpl/.gitignore
index 8ff6499..66e05b9 100644
--- a/docs/reference/gtk/tmpl/.gitignore
+++ b/docs/reference/gtk/tmpl/.gitignore
@@ -89,6 +89,7 @@ gtkseparatormenuitem.sgml
 gtkseparatortoolitem.sgml
 gtksettings.sgml
 gtkstatusbar.sgml
+gtkstatusicon.sgml
 gtkstyle.sgml
 gtktearoffmenuitem.sgml
 gtktesting.sgml
diff --git a/gtk/gtkstatusicon.c b/gtk/gtkstatusicon.c
index cd7e9f4..170c780 100644
--- a/gtk/gtkstatusicon.c
+++ b/gtk/gtkstatusicon.c
@@ -55,6 +55,36 @@
 #define WM_GTK_TRAY_NOTIFICATION (WM_USER+1)
 #endif
 
+
+/**
+ * SECTION:gtkstatusicon
+ * @Short_description: Display an icon in the system tray
+ * @Title: GtkStatusIcon
+ *
+ * The "system tray" or notification area is normally used for transient icons
+ * that indicate some special state. For example, a system tray icon might
+ * appear to tell the user that they have new mail, or have an incoming instant
+ * message, or something along those lines. The basic idea is that creating an
+ * icon in the notification area is less annoying than popping up a dialog.
+ *
+ * A #GtkStatusIcon object can be used to display an icon in a "system tray".
+ * The icon can have a tooltip, and the user can interact with it by
+ * activating it or popping up a context menu. Critical information should
+ * not solely be displayed in a #GtkStatusIcon, since it may not be
+ * visible (e.g. when the user doesn't have a notification area on his panel).
+ * This can be checked with gtk_status_icon_is_embedded().
+ *
+ * On X11, the implementation follows the freedesktop.org "System Tray"
+ * <ulink url="http://www.freedesktop.org/wiki/Specifications/systemtray-spec";>specification</ulink>.
+ * Implementations of the "tray" side of this specification can
+ * be found e.g. in the GNOME 2 and KDE panel applications.
+ *
+ * Note that a GtkStatusIcon is <emphasis>not</emphasis> a widget, but just
+ * a #GObject. Making it a widget would be impractical, since the system tray
+ * on Win32 doesn't allow to embed arbitrary widgets.
+ */
+
+
 #define BLINK_TIMEOUT 500
 
 enum