Fixing more broken and split doc comments.

(bzr r10697)

1 files changed, 31 insertions, 1 deletions

diff --git a/src/desktop.h b/src/desktop.h
index 25e4387dc..8921f45b8 100644
--- a/src/desktop.h
+++ b/src/desktop.h
@@ -82,7 +82,31 @@ namespace Inkscape {
 }
 
 /**
- * Editable view.
+ * SPDesktop is a subclass of View, implementing an editable document
+ * canvas.  It is extensively used by many UI controls that need certain
+ * visual representations of their own.
+ *
+ * SPDesktop provides a certain set of SPCanvasItems, serving as GUI
+ * layers of different control objects. The one containing the whole
+ * document is the drawing layer. In addition to it, there are grid,
+ * guide, sketch and control layers. The sketch layer is used for
+ * temporary drawing objects, before the real objects in document are
+ * created. The control layer contains editing knots, rubberband and
+ * similar non-document UI objects.
+ *
+ * Each SPDesktop is associated with a SPNamedView node of the document
+ * tree.  Currently, all desktops are created from a single main named
+ * view, but in the future there may be support for different ones.
+ * SPNamedView serves as an in-document container for desktop-related
+ * data, like grid and guideline placement, snapping options and so on.
+ *
+ * Associated with each SPDesktop are the two most important editing
+ * related objects - SPSelection and SPEventContext.
+ *
+ * Sodipodi keeps track of the active desktop and invokes notification
+ * signals whenever it changes. UI elements can use these to update their
+ * display to the selection of the currently active editing window.
+ * (Lauris Kaplinski)
  *
  * @see \ref desktop-handles.h for desktop macros.
  */
@@ -185,7 +209,13 @@ public:
     Inkscape::Whiteboard::SessionManager* _whiteboard_session_manager;
 #endif
 
+    /**
+     * Return new desktop object.
+     * \pre namedview != NULL.
+     * \pre canvas != NULL.
+     */
     SPDesktop();
+
     void init (SPNamedView* nv, SPCanvas* canvas, Inkscape::UI::View::EditWidgetInterface *widget);
     virtual ~SPDesktop();
     void destroy();