[gtk+/wip/gbsneto/placessidebar-locations: 5/8] placesview: add initial documentation

[Georges Basile Stavracas Neto <gbsneto src gnome org>]

commit 54d0bb7a8c29de5f5e6bccb5191e7eff3d4b8ea8
Author: Georges Basile Stavracas Neto <georges stavracas gmail com>
Date:   Tue Jun 16 21:15:20 2015 -0300

    placesview: add initial documentation

 gtk/gtkplacesview.c |   20 ++++++++++++++++++++
 1 files changed, 20 insertions(+), 0 deletions(-)
---
diff --git a/gtk/gtkplacesview.c b/gtk/gtkplacesview.c
index 4c7d7b2..e54e9c8 100644
--- a/gtk/gtkplacesview.c
+++ b/gtk/gtkplacesview.c
@@ -26,6 +26,26 @@
 #include "gtkplacesviewrow.h"
 #include "gtktypebuiltins.h"
 
+/**
+ * SECTION:gtkplacesview
+ * @Short_description: Widget that displays permanent drives and manages mounted networks
+ * @Title: GtkPlacesView
+ * @See_also: #GtkFileChooser
+ *
+ * #GtkPlacesView is a stock widget that displays a list permanent drives such
+ * as harddisk partitions and networks.  #GtkPlacesView does not monitor
+ * removable devices.
+ *
+ * The places view displays drives and networks, and will automatically mount
+ * them when the user selects them. Network addresses are stored even if they
+ * fail to connect. When the connection is successfull, the connected network
+ * is shown at the network list.
+ *
+ * To make use of the places view, an application at least needs to connect
+ * to the #GtkPlacesView::open-location signal.  This is emitted when the user
+ * selects a location to open in the view.
+ */
+
 struct _GtkPlacesViewPrivate
 {
   GVolumeMonitor                *volume_monitor;