From: Krzysztof Kosiński <tweenk.pl@gmail.com>
Date: Wed, 23 Dec 2009 19:51:48 +0000 (+0100)
Subject: Comment cleanup
X-Git-Url: https://git.tokkee.org/?a=commitdiff_plain;h=b18fc2f12a153daa3f0ff461ba29d7d28136112d;p=inkscape.git

Comment cleanup
---

diff --git a/src/desktop.cpp b/src/desktop.cpp
index b1b9a2955..e4e2ed7bc 100644
--- a/src/desktop.cpp
+++ b/src/desktop.cpp
@@ -91,8 +91,7 @@
 #include "widgets/desktop-widget.h"
 #include "box3d-context.h"
 
-// TODO those includes are only for the braindead quick zoom implementation.
-// Remove them after fixing this.
+// TODO those includes are only for node tool quick zoom. Remove them after fixing it.
 #include "ui/tool/node-tool.h"
 #include "ui/tool/control-point-selection.h"
 
@@ -894,9 +893,8 @@ SPDesktop::zoom_quick (bool enable)
         _quick_zoom_stored_area = get_display_area();
         bool zoomed = false;
 
-        // TODO This is brain damage. This needs to migrate into the node tool,
-        // but currently the design of this method is sufficiently broken
-        // to prevent this.
+        // TODO This needs to migrate into the node tool, but currently the design
+        // of this method is sufficiently wrong to prevent this.
         if (!zoomed && INK_IS_NODE_TOOL(event_context)) {
             InkNodeTool *nt = static_cast<InkNodeTool*>(event_context);
             if (!nt->_selected_nodes->empty()) {
diff --git a/src/ui/tool/path-manipulator.cpp b/src/ui/tool/path-manipulator.cpp
index 0ad509a9b..f247e5537 100644
--- a/src/ui/tool/path-manipulator.cpp
+++ b/src/ui/tool/path-manipulator.cpp
@@ -1042,9 +1042,9 @@ void PathManipulator::_setGeometry()
     if (empty()) return;
 
     if (!_lpe_key.empty()) {
-        // LPE brain damage follows - copied from nodepath.cpp
+        // copied from nodepath.cpp
         // NOTE: if we are editing an LPE param, _path is not actually an SPPath, it is
-        // a LivePathEffectObject.
+        // a LivePathEffectObject. (mad laughter)
         Effect *lpe = LIVEPATHEFFECT(_path)->get_lpe();
         if (lpe) {
             PathParam *pathparam = dynamic_cast<PathParam *>(lpe->getParameter(_lpe_key.data()));
@@ -1059,14 +1059,15 @@ void PathManipulator::_setGeometry()
     }
 }
 
-/** LPE brain damage */
+/** Figure out in what attribute to store the nodetype string. */
 Glib::ustring PathManipulator::_nodetypesKey()
 {
     if (_lpe_key.empty()) return "sodipodi:nodetypes";
     return _lpe_key + "-nodetypes";
 }
 
-/** LPE brain damage */
+/** Return the XML node we are editing.
+ * This method is wrong but necessary at the moment. */
 Inkscape::XML::Node *PathManipulator::_getXMLNode()
 {
     if (_lpe_key.empty()) return _path->repr;
diff --git a/src/ui/tool/shape-record.h b/src/ui/tool/shape-record.h
index 96c1551f6..fdb49ac36 100644
--- a/src/ui/tool/shape-record.h
+++ b/src/ui/tool/shape-record.h
@@ -34,7 +34,7 @@ struct ShapeRecord :
     SPItem *item; // SP node for the edited shape
     Geom::Matrix edit_transform; // how to transform controls - used for clipping paths and masks
     ShapeRole role;
-    Glib::ustring lpe_key; // This is LPE brain damage that I do not want to speak of
+    Glib::ustring lpe_key; // name of LPE shape param being edited
 
     inline bool operator==(ShapeRecord const &o) const { return item == o.item; }
     inline bool operator<(ShapeRecord const &o) const { return item < o.item; }