From 892cf8be296da50190b7aaee6c132fd43acf5f25 Mon Sep 17 00:00:00 2001
From: Dick Hollenbeck <dick@softplc.com>
Date: Mon, 30 Jan 2012 15:21:40 -0600
Subject: [PATCH] document KICAD_T enum better, remove PCB_ZONE_EDGE_T usages

---
 include/base_struct.h               | 42 +++++++++++++++--------------
 pcbnew/class_board_connected_item.h |  5 ++--
 pcbnew/edit.cpp                     |  5 ----
 3 files changed, 25 insertions(+), 27 deletions(-)

diff --git a/include/base_struct.h b/include/base_struct.h
index 3bfed5cf99..75498c9369 100644
--- a/include/base_struct.h
+++ b/include/base_struct.h
@@ -44,33 +44,35 @@ extern std::ostream& operator <<( std::ostream& out, const wxPoint& pt );
 #endif
 
 
-/* Id for class identification, at run time */
+/**
+ * Enum KICAD_T
+ * is the set of class identification values, stored in EDA_ITEM::m_StructType
+ */
 enum KICAD_T {
-    NOT_USED = -1,          // the 3d code uses this value
+    NOT_USED = -1,          ///< the 3d code uses this value
 
-    EOT = 0,                // search types array terminator (End Of Types)
+    EOT = 0,                ///< search types array terminator (End Of Types)
 
     TYPE_NOT_INIT = 0,
     PCB_T,
-    SCREEN_T,               // not really an item, used to identify a screen
+    SCREEN_T,               ///< not really an item, used to identify a screen
 
     // Items in pcb
-    PCB_MODULE_T,           // a footprint
-    PCB_PAD_T,              // a pad in a footprint
-    PCB_LINE_T,             // a segment not on copper layers
-    PCB_TEXT_T,             // a text on a layer
-    PCB_MODULE_TEXT_T,      // a text in a footprint
-    PCB_MODULE_EDGE_T,      // a footprint edge
-    PCB_TRACE_T,            // a track segment (segment on a copper layer)
-    PCB_VIA_T,              // a via (like a track segment on a copper layer)
-    PCB_ZONE_T,             // a segment used to fill a zone area (segment on a
-                            // copper layer)
-    PCB_MARKER_T,           // a marker used to show something
-    PCB_DIMENSION_T,        // a dimension (graphic item)
-    PCB_TARGET_T,           // a target (graphic item)
-    PCB_ZONE_EDGE_T,        // in zone outline: a point to define an outline
-    PCB_ZONE_AREA_T,        // a zone area
-    PCB_ITEM_LIST_T,        // a list of board items
+    PCB_MODULE_T,           ///< class MODULE, a footprint
+    PCB_PAD_T,              ///< class D_PAD, a pad in a footprint
+    PCB_LINE_T,             ///< class DRAWSEGMENT, a segment not on copper layers
+    PCB_TEXT_T,             ///< class TEXTE_PCB, text on a layer
+    PCB_MODULE_TEXT_T,      ///< class TEXTE_MODULE, text in a footprint
+    PCB_MODULE_EDGE_T,      ///< class EDGE_MODULE, a footprint edge
+    PCB_TRACE_T,            ///< class TRACKE, a track segment (segment on a copper layer)
+    PCB_VIA_T,              ///< class VIA, a via (like a track segment on a copper layer)
+    PCB_ZONE_T,             ///< class SEGZONE, a segment used to fill a zone area (segment on a
+                            ///< copper layer)
+    PCB_MARKER_T,           ///< class MARKER_PCB, a marker used to show something
+    PCB_DIMENSION_T,        ///< class DIMENSION, a dimension (graphic item)
+    PCB_TARGET_T,           ///< class PCB_TARGET, a target (graphic item)
+    PCB_ZONE_AREA_T,        ///< class ZONE_CONTAINER, a zone area
+    PCB_ITEM_LIST_T,        ///< class BOARD_ITEM_LIST, a list of board items
 
     // Schematic draw Items.  The order of these items effects the sort order.
     // It is currently ordered to mimic the old Eeschema locate behavior where
diff --git a/pcbnew/class_board_connected_item.h b/pcbnew/class_board_connected_item.h
index 52d8281ee6..431487c732 100644
--- a/pcbnew/class_board_connected_item.h
+++ b/pcbnew/class_board_connected_item.h
@@ -90,6 +90,7 @@ public:
 };
 
 
+#if 0   // template for future
 /**
  * Class BOARD_ITEM_LIST
  * is a container for a list of BOARD_ITEMs.
@@ -203,6 +204,6 @@ public:
         return NULL;
     }
 };
+#endif  // future
 
-
-#endif // BOARD_CONNECTED_ITEM_H
+#endif  // BOARD_CONNECTED_ITEM_H
diff --git a/pcbnew/edit.cpp b/pcbnew/edit.cpp
index da46e5d06e..00e634bab7 100644
--- a/pcbnew/edit.cpp
+++ b/pcbnew/edit.cpp
@@ -1135,11 +1135,6 @@ void PCB_EDIT_FRAME::RemoveStruct( BOARD_ITEM* Item, wxDC* DC )
         Delete_OldZone_Fill( (SEGZONE*) Item );
         break;
 
-    case PCB_ZONE_EDGE_T:
-        Remove_Zone_Corner( DC, (ZONE_CONTAINER*) Item );
-        SetCurItem( NULL );
-        break;
-
     case PCB_ZONE_AREA_T:
     {
         SetCurItem( NULL );