[kde-doc-english] [symboleditor] /: Updated documentation for new features

[Steve Allewell]

Git commit 8a7c637e3d65404da6e75f77cf7465bf10760961 by Steve Allewell.
Committed on 27/07/2014 at 19:07.
Pushed by sallewell into branch 'master'.

Updated documentation for new features

Added documentation for action to toggle the generation of guide lines.
Updated documentation for the generation of guide lines and the option
to simplify the number of angles tested for.

GUI: Updated documentation

M  +4    -0    doc/commands.docbook
M  +-    --    doc/configuration-dialog.png
M  +-    --    doc/renderer-toolbar.png
M  +-    --    doc/tool-toolbar.png
M  +-    --    doc_images/ui-tools-toolbar.png
M  +10   -1    src/Editor.cpp
M  +2    -2    src/Editor.h
M  +1    -0    src/MainWindow.cpp

http://commits.kde.org/symboleditor/8a7c637e3d65404da6e75f77cf7465bf10760961

diff --git a/doc/commands.docbook b/doc/commands.docbook
index f91e39b..33e768a 100644
--- a/doc/commands.docbook
+++ b/doc/commands.docbook
@@ -250,6 +250,10 @@
                         <term><menuchoice><guimenuitem>Enable Snap</guimenuitem></menuchoice></term>
                         <listitem><simpara><action>Enable snapping of points to the grid</action></simpara></listitem>
                     </varlistentry>
+                    <varlistentry>
+                        <term><menuchoice><guimenuitem>Guide Lines</guimenuitem></menuchoice></term>
+                        <listitem><simpara><action>Enable the generation of guide lines</action></simpara></listitem>
+                    </varlistentry>
                 </variablelist>
             </para>
         </sect2>
diff --git a/doc/configuration-dialog.png b/doc/configuration-dialog.png
index 5cca317..7c297fc 100644
Binary files a/doc/configuration-dialog.png and b/doc/configuration-dialog.png differ
diff --git a/doc/renderer-toolbar.png b/doc/renderer-toolbar.png
index 7cc90a1..d302845 100644
Binary files a/doc/renderer-toolbar.png and b/doc/renderer-toolbar.png differ
diff --git a/doc/tool-toolbar.png b/doc/tool-toolbar.png
index c4cc3de..599e9eb 100644
Binary files a/doc/tool-toolbar.png and b/doc/tool-toolbar.png differ
diff --git a/doc_images/ui-tools-toolbar.png b/doc_images/ui-tools-toolbar.png
index dcb1663..599e9eb 100644
Binary files a/doc_images/ui-tools-toolbar.png and b/doc_images/ui-tools-toolbar.png differ
diff --git a/src/Editor.cpp b/src/Editor.cpp
index d18866b..9b4f9d4 100644
--- a/src/Editor.cpp
+++ b/src/Editor.cpp
@@ -29,8 +29,11 @@
  * around the symbol when it will be rendered in a pattern.
  *
  * When placing points, guide lines will be shown when the cursor is at a position that aligns with other
- * points either horizontally, vertically or at a 45 degree angle. The circle guides are created if the cursor
+ * points either horizontally, vertically or at a range of predefined angles. The circle guides are created if the cursor
  * is at a position that aligns with another point on a circle where the center is at the center of the grid.
+ * When a symbol shape is made up of a large number of points, the number of guide lines generated can be significant.
+ * If these become a problem then the generation of the guide lines can be turned off completely or an option is
+ * available in the configuration dialog to simplify the range of angles tested.
  *
  * @section editor_tools Editor Tools
  *
@@ -80,6 +83,11 @@
  * The selection of points can either be snapped to the grid or can be freely placed depending on if
  * the snap option is toggled on or off.
  *
+ * @subsection guide_lines Enable Guide Lines
+ * The generation of guide lines can be toggled on or off. As the number of points in a symbol increases
+ * the number of guide lines that can be created can become significant at which point they become less
+ * useful.
+ *
  * @section path_rendering Path Rendering
  *
  * @subsection fill_mode Fill Mode
@@ -1411,6 +1419,7 @@ void Editor::constructPainterPath()
  * A list of circles is created where the radius to the point is similar to the test point. Intersection
  * points are calculated for the projected lines and if these are close to the cursor position they
  * are added to the snap points along with the circles and lines.
+ * If the generation of guide lines is turned off, the existing guides are cleared on no more are created.
  *
  * @param to a const reference to a QPointF representing the cursor position
  */
diff --git a/src/Editor.h b/src/Editor.h
index b67cdbb..2ec8964 100644
--- a/src/Editor.h
+++ b/src/Editor.h
@@ -66,8 +66,8 @@ class KCharSelect;
  * Tools are available to rotate or flip the symbol which adjusts the points positions and
  * reconstructs the QPainterPath.
  *
- * Guide lines and circles will be displayed if the current position of the mouse on the
- * editor aligns with an existing point either horizontally, vertically or at a specified
+ * Guide lines and circles can be displayed if the current position of the mouse on the
+ * editor aligns with an existing point either horizontally, vertically or at a pre-defined
  * angle, or if the point lies on the same circle as the original where its origin is at
  * the center of the grid.
  */
diff --git a/src/MainWindow.cpp b/src/MainWindow.cpp
index 02a96b0..28dc1fe 100644
--- a/src/MainWindow.cpp
+++ b/src/MainWindow.cpp
@@ -138,6 +138,7 @@
  * - @ref flip_vertical
  * - @ref scale_preferred
  * - @ref snap_grid
+ * - @ref guide_lines
  */