From f3d93d01bec00dcaedb33506dfc7d5e101ac0a17 Mon Sep 17 00:00:00 2001
From: Carl Hetherington <cth@carlh.net>
Date: Mon, 8 May 2006 17:11:12 +0000
Subject: Added some comments.

(bzr r771)
---
 src/snap.h | 14 +++++++++++---
 1 file changed, 11 insertions(+), 3 deletions(-)

(limited to 'src/snap.h')

diff --git a/src/snap.h b/src/snap.h
index 12996f04d..8345da40d 100644
--- a/src/snap.h
+++ b/src/snap.h
@@ -27,6 +27,14 @@
 
 class SPNamedView;
 
+/// Class to coordinate snapping operations
+
+/**
+ *  Each SPNamedView has one of these.  It offers methods to snap points to whatever
+ *  snappers are defined (e.g. grid, guides etc.).  It also allows callers to snap
+ *  points which have undergone some transformation (e.g. translation, scaling etc.)
+ */
+
 class SnapManager
 {
 public:
@@ -91,9 +99,9 @@ public:
                                             NR::Point const &o,
                                             NR::Dim2 d) const;
 
-    Inkscape::GridSnapper grid;
-    Inkscape::GuideSnapper guide;
-    Inkscape::ObjectSnapper object;
+    Inkscape::GridSnapper grid;     ///< grid snapper
+    Inkscape::GuideSnapper guide;   ///< guide snapper
+    Inkscape::ObjectSnapper object; ///< snapper to other objects
 
     typedef std::list<const Inkscape::Snapper*> SnapperList;
     SnapperList getSnappers() const;
-- 
cgit v1.2.3