Remove MaxUndoItems, make devel option DevelMaxUndoItems

Begin documenting configuration keys in Doxygen
KiCad · May 12, 2016 · 84d3fbf · 84d3fbf
1 parent a488cb0
commit 84d3fbf
Show file tree

Hide file tree

Showing 21 changed files with 170 additions and 1,372 deletions.
diff --git a/Documentation/development/Doxyfile b/Documentation/development/Doxyfile
@@ -646,12 +646,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = coding-style-policy.md \
-                         stable-release-policy.md \
-                         road-map-r5.md \
-                         road-map.md \
-                         compiling.md \
-                         ui-policy.md
+INPUT                  = .
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -669,7 +664,7 @@ INPUT_ENCODING         = UTF-8
 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
 # *.f90 *.f *.for *.vhd *.vhdl
 
-FILE_PATTERNS          =
+FILE_PATTERNS          = *.h *.cpp *.md
 
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
 # should be searched for input files as well. Possible values are YES and NO.

diff --git a/Documentation/development/config-strings.md b/Documentation/development/config-strings.md
@@ -0,0 +1,10 @@
+\ingroup config
+\defgroup config Configuration strings
+
+This page documents keys used in the KiCad configuration files.
+
+\defgroup develconfig Development configuration settings
+
+The keys documented on this page are for development use. There is no GUI option
+to configure them; a developer can set them by manually editing the configuration
+files.
diff --git a/Doxyfile b/Doxyfile
@@ -645,12 +645,7 @@ WARN_LOGFILE           =
 # directories like "/usr/src/myproject". Separate the files or directories
 # with spaces.
 
-INPUT                  = Documentation/development/coding-style-policy.md \
-                         Documentation/development/stable-release-policy.md \
-                         Documentation/development/road-map-r5.md \
-                         Documentation/development/road-map.md \
-                         Documentation/development/compiling.md \
-                         Documentation/development/ui-policy.md \
+INPUT                  = Documentation/development \
                          kicad \
                          pcbnew \
                          cvpcb \
@@ -679,8 +674,7 @@ INPUT_ENCODING         = UTF-8
 # *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
 # *.f90 *.f *.for *.vhd *.vhdl
 
-FILE_PATTERNS          = *.h \
-                         *.cpp
+FILE_PATTERNS          = *.h *.cpp *.md
 
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
 # should be searched for input files as well. Possible values are YES and NO.

diff --git a/common/draw_frame.cpp b/common/draw_frame.cpp
@@ -66,8 +66,21 @@ static const wxString CursorShapeEntryKeyword( wxT( "CursorShape" ) );
 static const wxString ShowGridEntryKeyword( wxT( "ShowGrid" ) );
 static const wxString GridColorEntryKeyword( wxT( "GridColor" ) );
 static const wxString LastGridSizeIdKeyword( wxT( "_LastGridSize" ) );
-static const wxString MaxUndoItemsEntry(wxT( "MaxUndoItems" ) );
 
+/**
+ * Integer to set the maximum number of undo items on the stack. If zero,
+ * undo items are unlimited.
+ *
+ * Present as:
+ *
+ * - SchematicFrameDevelMaxUndoItems (file: eeschema)
+ * - LibeditFrameDevelMaxUndoItems (file: eeschema)
+ * - PcbFrameDevelMaxUndoItems (file: pcbnew)
+ * - ModEditFrameDevelMaxUndoItems (file: pcbnew)
+ *
+ * \ingroup develconfig
+ */
+static const wxString MaxUndoItemsEntry(wxT( "DevelMaxUndoItems" ) );
 
 BEGIN_EVENT_TABLE( EDA_DRAW_FRAME, KIWAY_PLAYER )
     EVT_MOUSEWHEEL( EDA_DRAW_FRAME::OnMouseEvent )

diff --git a/eeschema/dialogs/dialog_eeschema_options.h b/eeschema/dialogs/dialog_eeschema_options.h
@@ -218,19 +218,6 @@ class DIALOG_EESCHEMA_OPTIONS : public DIALOG_EESCHEMA_OPTIONS_BASE
      */
     int GetAutoSaveInterval() const { return m_spinAutoSaveInterval->GetValue(); }
 
-    /**
-     * Function SetMaxUndoItems
-     * Sets the maximum number of undo items
-     * @param aItems the number to set
-     */
-    void SetMaxUndoItems( int aItems ) { m_spinMaxUndoItems->SetValue( aItems ); }
-
-    /**
-     * Function GetMaxUndoItems
-     * Return the current maximum number of undo items
-     */
-    int GetMaxUndoItems() const { return m_spinMaxUndoItems->GetValue(); }
-
     /**
      * Function SetRefIdSeparator
      * Sets the current RefIdSeparator value in the dialog