Translate French code names and comments and other minor code cleaning.

include/wxBasePcbFrame.h

@@ -20,7 +20,6 @@
 
 
 /*  Forward declarations of classes. */
-class WinEDA_CvpcbFrame;
 class FOOTPRINT_EDIT_FRAME;
 class BOARD;
 class MODULE;
@@ -461,7 +460,7 @@ public:
                               bool aPlotVia, GRTraceMode aPlotMode,
                               bool aSkipNPTH_Pads = false );
 
-    void Plot_Serigraphie( PLOTTER* plotter, int masque_layer, GRTraceMode trace_mode );
+    void PlotSilkScreen( PLOTTER* plotter, int masque_layer, GRTraceMode trace_mode );
 
     /**
      * Function PlotDrillMark

include/wxPcbStruct.h

@@ -1145,9 +1145,9 @@ public:
     void Delete_Drawings_All_Layer( int aLayer );
 
     // Dimension handling:
-    void Install_Edit_Dimension( DIMENSION* Dimension, wxDC* DC );
-    DIMENSION* Begin_Dimension( DIMENSION* Dimension, wxDC* DC );
-    void Delete_Dimension( DIMENSION* Dimension, wxDC* DC );
+    void ShowDimensionPropertyDialog( DIMENSION* aDimension, wxDC* aDC );
+    DIMENSION* EditDimension( DIMENSION* aDimension, wxDC* aDC );
+    void DeleteDimension( DIMENSION* aDimension, wxDC* aDC );
 
     // netlist  handling:
     void InstallNetlistFrame( wxDC* DC );

pcbnew/class_dimension.h

-/******************************/
-/* DIMENSION class definition */
-/******************************/
+/**
+ * @file class_dimension.h
+ * @brief DIMENSION class definition.
+ */
 
 #ifndef DIMENSION_H
 #define DIMENSION_H
 
-#include "base_struct.h"
-#include "richio.h"
+#include "class_board_item.h"
+
+
+class EDA_RECT;
+class READER;
+class EDA_DRAW_PANEL;
 
 
 class DIMENSION : public BOARD_ITEM
@@ -19,13 +24,13 @@ public:
     int        m_Value; /* value of  PCB dimensions. */
 
     TEXTE_PCB* m_Text;
-    int        Barre_ox, Barre_oy, Barre_fx, Barre_fy;
-    int        TraitG_ox, TraitG_oy, TraitG_fx, TraitG_fy;
-    int        TraitD_ox, TraitD_oy, TraitD_fx, TraitD_fy;
-    int        FlecheD1_ox, FlecheD1_oy, FlecheD1_fx, FlecheD1_fy;
-    int        FlecheD2_ox, FlecheD2_oy, FlecheD2_fx, FlecheD2_fy;
-    int        FlecheG1_ox, FlecheG1_oy, FlecheG1_fx, FlecheG1_fy;
-    int        FlecheG2_ox, FlecheG2_oy, FlecheG2_fx, FlecheG2_fy;
+    int        m_crossBarOx, m_crossBarOy, m_crossBarFx, m_crossBarFy;
+    int        m_featureLineGOx, m_featureLineGOy, m_featureLineGFx, m_featureLineGFy;
+    int        m_featureLineDOx, m_featureLineDOy, m_featureLineDFx, m_featureLineDFy;
+    int        m_arrowD1Ox, m_arrowD1Oy, m_arrowD1Fx, m_arrowD1Fy;
+    int        m_arrowD2Ox, m_arrowD2Oy, m_arrowD2Fx, m_arrowD2Fy;
+    int        m_arrowG1Ox, m_arrowG1Oy, m_arrowG1Fx, m_arrowG1Fy;
+    int        m_arrowG2Ox, m_arrowG2Oy, m_arrowG2Fx, m_arrowG2Fy;
 
 public:
     DIMENSION( BOARD_ITEM* aParent );

pcbnew/class_zone.h

@@ -10,11 +10,11 @@
 #include <vector>
 #include "gr_basic.h"
 #include "PolyLine.h"
-#include "richio.h"
 #include "class_zone_setting.h"
 
 
 class EDA_RECT;
+class LINE_READER;
 class EDA_DRAW_FRAME;
 class EDA_DRAW_PANEL;
 class PCB_EDIT_FRAME;
@@ -32,6 +32,7 @@ public:
 
 public:
     SEGMENT() {}
+
     SEGMENT( const wxPoint& aStart, const wxPoint& aEnd)
     {
         m_Start = aStart;
@@ -40,48 +41,66 @@ public:
  };
 
 
-/************************/
-/* class ZONE_CONTAINER */
-/************************/
-
-/* handle a list of polygons delimiting a copper zone
- * a zone is described by a main polygon, a time stamp, a layer and a net name.
- * others polygons inside this main polygon are holes.
+/**
+ * Class ZONE_CONTAINER
+ * handles a list of polygons defining a copper zone.
+ * A zone is described by a main polygon, a time stamp, a layer, and a net name.
+ * Other polygons inside the main polygon are holes in the zone.
  */
-
 class ZONE_CONTAINER : public BOARD_CONNECTED_ITEM
 {
 public:
     wxString              m_Netname;                        // Net Name
     CPolyLine*            m_Poly;                           // outlines
-    int                   m_CornerSelection;                // For corner moving, corner index to drag, or -1 if no selection
+
+    // For corner moving, corner index to drag, or -1 if no selection.
+    int                   m_CornerSelection;
     int                   m_ZoneClearance;                  // clearance value
     int                   m_ZoneMinThickness;               // Min thickness value in filled areas
-    int                   m_FillMode;                       // How to fill areas: 0 = use filled polygons, != 0 fill with segments
-    int                   m_ArcToSegmentsCount;             // number of segments to convert a circle to a polygon
-                                                            // (uses ARC_APPROX_SEGMENTS_COUNT_LOW_DEF or ARC_APPROX_SEGMENTS_COUNT_HIGHT_DEF)
-    int                   m_PadOption;                      //
-    int                   m_ThermalReliefGapValue;          // thickness of the gap in thermal reliefs
-    int                   m_ThermalReliefCopperBridgeValue; // thickness of the copper bridge in thermal reliefs
+
+    // How to fill areas: 0 = use filled polygons, != 0 fill with segments.
+    int                   m_FillMode;
+
+    // number of segments to convert a circle to a polygon (uses
+    //ARC_APPROX_SEGMENTS_COUNT_LOW_DEF or ARC_APPROX_SEGMENTS_COUNT_HIGHT_DEF)
+    int                   m_ArcToSegmentsCount;
+
+    int                   m_PadOption;
+
+    // thickness of the gap in thermal reliefs.
+    int                   m_ThermalReliefGapValue;
+
+    // thickness of the copper bridge in thermal reliefs
+    int                   m_ThermalReliefCopperBridgeValue;
     int                   utility, utility2;                // flags used in polygon calculations
-    bool                  m_IsFilled;                       // true when a zone was filled, false after deleting the filled areas
-    std::vector <CPolyPt> m_FilledPolysList;  /* set of filled polygons used to draw a zone as a filled area.
-                                               * from outlines (m_Poly) but unlike m_Poly these filled polygons have no hole (they are all in one piece)
-                                               * In very simple cases m_FilledPolysList is same as m_Poly
-                                               * In less simple cases (when m_Poly has holes) m_FilledPolysList is a polygon equivalent to m_Poly, without holes
-                                               * but with extra outline segment connecting "holes" with external main outline
-                                               * In complex cases an outline described by m_Poly can have many filled areas
-                                               */
-    std::vector <SEGMENT> m_FillSegmList;      /* set of segments used to fill area, when fill zone by segment is used.
+
+    // true when a zone was filled, false after deleting the filled areas
+    bool                  m_IsFilled;
+
+    /* set of filled polygons used to draw a zone as a filled area.
+     * from outlines (m_Poly) but unlike m_Poly these filled polygons have no hole
+     * (they are* all in one piece)  In very simple cases m_FilledPolysList is same
+     * as m_Poly.  In less simple cases (when m_Poly has holes) m_FilledPolysList is
+     * a polygon equivalent to m_Poly, without holes but with extra outline segment
+     * connecting "holes" with external main outline.  In complex cases an outline
+     * described by m_Poly can have many filled areas
+     */
+    std::vector <CPolyPt> m_FilledPolysList;
+
+    /* set of segments used to fill area, when fill zone by segment is used.
      *  ( m_FillMode == 1 )
      *  in this case segments have m_ZoneMinThickness width
      */
+    std::vector <SEGMENT> m_FillSegmList;
+
 private:
     CPolyLine*            smoothedPoly;         // Corner-smoothed version of m_Poly
     int                   cornerSmoothingType;
     unsigned int          cornerRadius;
+
 public:
     ZONE_CONTAINER( BOARD* parent );
+
     ~ZONE_CONTAINER();
 
     bool Save( FILE* aFile ) const;
@@ -94,12 +113,12 @@ public:
      */
     int ReadDescr( LINE_READER* aReader );
 
-    /** virtual function GetPosition
+    /**
+     * Function GetPosition
      * @return a wxPoint, position of the first point of the outline
      */
     wxPoint& GetPosition();
 
-
     /**
      * Function copy
      * copy useful data from the source.
@@ -137,9 +156,9 @@ public:
 
     /**
      * Function DrawWhileCreateOutline
-     * Draws the zone outline when ir is created.
-     * The moving edges are in XOR graphic mode, old segment in draw_mode graphic mode (usually GR_OR)
-     * The closing edge has its own shape
+     * Draws the zone outline when it is created.
+     * The moving edges are in XOR graphic mode, old segment in draw_mode graphic mode
+     * (usually GR_OR).  The closing edge has its own shape.
      * @param panel = current Draw Panel
      * @param DC = current Device Context
      * @param draw_mode = draw mode: OR, XOR ..
@@ -164,9 +183,11 @@ public:
     /**
      * Function CalculateSubAreaBoundaryBox
      * Calculates the bounding box of a a filled area ( list of CPolyPt )
-     * use m_FilledPolysList as list of CPolyPt (that are the corners of one or more polygons or filled areas )
+     * use m_FilledPolysList as list of CPolyPt (that are the corners of one or more
+     * polygons or filled areas )
      * @return an EDA_RECT as bounding box
-     * @param aIndexStart = index of the first corner of a polygon (filled area) in m_FilledPolysList
+     * @param aIndexStart = index of the first corner of a polygon (filled area)
+     *                      in m_FilledPolysList
      * @param aIndexEnd = index of the last corner of a polygon in m_FilledPolysList
      */
     EDA_RECT CalculateSubAreaBoundaryBox( int aIndexStart, int aIndexEnd );
@@ -275,7 +296,7 @@ public:
     bool HitTestForEdge( const wxPoint& refPos );
 
     /**
-     * Function HitTest (overlayed)
+     * Function HitTest (overloaded)
      * tests if the given EDA_RECT contains the bounds of this object.
      * @param refArea : the given EDA_RECT
      * @return bool - true if a hit, else false
@@ -427,6 +448,7 @@ public:
     };
 
     void SetCornerSmoothingType( int aType ) { cornerSmoothingType = aType; };
+
     int  GetCornerSmoothingType() const { return cornerSmoothingType; };
 
     void SetCornerRadius( unsigned int aRadius )

pcbnew/edit.cpp

-/**************************************/
-/* edit.cpp: edit PCB implementation. */
-/**************************************/
+/**
+ * @file edit.cpp
+ * @brief Edit PCB implementation.
+ */
 
 #include "fctsys.h"
 #include "appl_wxstruct.h"
@@ -897,12 +898,12 @@ void PCB_EDIT_FRAME::Process_Special_Functions( wxCommandEvent& event )
 
     case ID_POPUP_PCB_DELETE_DIMENSION:
         DrawPanel->MoveCursorToCrossHair();
-        Delete_Dimension( (DIMENSION*) GetCurItem(), &dc );
+        DeleteDimension( (DIMENSION*) GetCurItem(), &dc );
         SetCurItem( NULL );
         break;
 
     case ID_POPUP_PCB_EDIT_DIMENSION:
-        Install_Edit_Dimension( (DIMENSION*) GetCurItem(), &dc );
+        ShowDimensionPropertyDialog( (DIMENSION*) GetCurItem(), &dc );
         DrawPanel->MoveCursorToCrossHair();
         break;
 
@@ -1092,7 +1093,7 @@ void PCB_EDIT_FRAME::RemoveStruct( BOARD_ITEM* Item, wxDC* DC )
         break;
 
     case TYPE_DIMENSION:
-        Delete_Dimension( (DIMENSION*) Item, DC );
+        DeleteDimension( (DIMENSION*) Item, DC );
         break;
 
     case PCB_TARGET_T:

pcbnew/onleftclick.cpp

-/**************************************************************/
-/* onleftclick.cpp:                                           */
-/* function called when the left button is clicked (released) */
-/* function called when the left button is double clicked     */
-/**************************************************************/
+/**
+ * @file pcbnew/onleftclick.cpp
+ * @brief Functions called when the left button is clicked or double clicked.
+ */
 
 #include "fctsys.h"
 #include "class_drawpanel.h"
@@ -13,7 +12,7 @@
 #include "pcbnew_id.h"
 
 
-/* Handle the left buttom mouse click, when a tool is active
+/* Handle the left button mouse click, when a tool is active
  */
 void PCB_EDIT_FRAME::OnLeftClick( wxDC* aDC, const wxPoint& aPosition )
 {
@@ -286,7 +285,7 @@ void PCB_EDIT_FRAME::OnLeftClick( wxDC* aDC, const wxPoint& aPosition )
             }
         }
         else if( DrawStruct && (DrawStruct->Type() == TYPE_ZONE_CONTAINER) && DrawStruct->IsNew() )
-        {   // Add a new corner to the current outline beeing created:
+        {   // Add a new corner to the current outline being created:
             DrawPanel->m_AutoPAN_Request = true;
             Begin_Zone( aDC );
             DrawStruct = GetBoard()->m_CurrentZoneContour;
@@ -349,13 +348,13 @@ void PCB_EDIT_FRAME::OnLeftClick( wxDC* aDC, const wxPoint& aPosition )
 
         if( (DrawStruct == NULL) || (DrawStruct->m_Flags == 0) )
         {
-            DrawStruct = Begin_Dimension( NULL, aDC );
+            DrawStruct = EditDimension( NULL, aDC );
             SetCurItem( DrawStruct );
             DrawPanel->m_AutoPAN_Request = true;
         }
         else if( DrawStruct && (DrawStruct->Type() == TYPE_DIMENSION) && DrawStruct->IsNew() )
         {
-            DrawStruct = Begin_Dimension( (DIMENSION*) DrawStruct, aDC );
+            DrawStruct = EditDimension( (DIMENSION*) DrawStruct, aDC );
             SetCurItem( DrawStruct );
             DrawPanel->m_AutoPAN_Request = true;
         }
@@ -535,7 +534,7 @@ void PCB_EDIT_FRAME::OnEditItemRequest( wxDC* aDC, BOARD_ITEM* aItem )
         break;
 
     case TYPE_DIMENSION:
-        Install_Edit_Dimension( (DIMENSION*) aItem, aDC );
+        ShowDimensionPropertyDialog( (DIMENSION*) aItem, aDC );
         break;
 
     case TYPE_TEXTE_MODULE:
@@ -554,4 +553,3 @@ void PCB_EDIT_FRAME::OnEditItemRequest( wxDC* aDC, BOARD_ITEM* aItem )
         break;
     }
 }
-

pcbnew/plot_rtn.cpp

-/*************************/
-/* Common plot routines. */
-/*************************/
+/**
+ * @file plot_rtn.cpp
+ * @brief Common plot routines.
+ */
 
 #include "fctsys.h"
 #include "common.h"
@@ -22,9 +23,7 @@ static void PlotTextModule( PLOTTER* plotter, TEXTE_MODULE* pt_texte,
 
 /* Creates the plot for silkscreen layers
  */
-void PCB_BASE_FRAME::Plot_Serigraphie( PLOTTER*    plotter,
-                                       int         aLayerMask,
-                                       GRTraceMode trace_mode )
+void PCB_BASE_FRAME::PlotSilkScreen( PLOTTER* plotter, int aLayerMask, GRTraceMode trace_mode )
 {
     bool          trace_val, trace_ref;
     TEXTE_MODULE* pt_texte;
@@ -56,7 +55,7 @@ void PCB_BASE_FRAME::Plot_Serigraphie( PLOTTER*    plotter,
             break;
 
         default:
-            DisplayError( this, wxT( "Plot_Serigraphie() error: unexpected Type()" ) );
+            DisplayError( this, wxT( "PlotSilkScreen() error: unexpected Type()" ) );
             break;
         }
     }
@@ -270,46 +269,46 @@ void PlotDimension( PLOTTER* plotter, DIMENSION* Dimension, int aLayerMask,
 
     PlotTextePcb( plotter, Dimension->m_Text, aLayerMask, trace_mode );
 
-    DrawTmp->m_Start.x = Dimension->Barre_ox;
-    DrawTmp->m_Start.y = Dimension->Barre_oy;
-    DrawTmp->m_End.x = Dimension->Barre_fx;
-    DrawTmp->m_End.y = Dimension->Barre_fy;
+    DrawTmp->m_Start.x = Dimension->m_crossBarOx;
+    DrawTmp->m_Start.y = Dimension->m_crossBarOy;
+    DrawTmp->m_End.x = Dimension->m_crossBarFx;
+    DrawTmp->m_End.y = Dimension->m_crossBarFy;
     PlotDrawSegment( plotter, DrawTmp, aLayerMask, trace_mode );
 
-    DrawTmp->m_Start.x = Dimension->TraitG_ox;
-    DrawTmp->m_Start.y = Dimension->TraitG_oy;
-    DrawTmp->m_End.x = Dimension->TraitG_fx;
-    DrawTmp->m_End.y = Dimension->TraitG_fy;
+    DrawTmp->m_Start.x = Dimension->m_featureLineGOx;
+    DrawTmp->m_Start.y = Dimension->m_featureLineGOy;
+    DrawTmp->m_End.x = Dimension->m_featureLineGFx;
+    DrawTmp->m_End.y = Dimension->m_featureLineGFy;
     PlotDrawSegment( plotter, DrawTmp, aLayerMask, trace_mode );
 
-    DrawTmp->m_Start.x = Dimension->TraitD_ox;
-    DrawTmp->m_Start.y = Dimension->TraitD_oy;
-    DrawTmp->m_End.x = Dimension->TraitD_fx;
-    DrawTmp->m_End.y = Dimension->TraitD_fy;
+    DrawTmp->m_Start.x = Dimension->m_featureLineDOx;
+    DrawTmp->m_Start.y = Dimension->m_featureLineDOy;
+    DrawTmp->m_End.x = Dimension->m_featureLineDFx;
+    DrawTmp->m_End.y = Dimension->m_featureLineDFy;
     PlotDrawSegment( plotter, DrawTmp, aLayerMask, trace_mode );
 
-    DrawTmp->m_Start.x = Dimension->FlecheD1_ox;
-    DrawTmp->m_Start.y = Dimension->FlecheD1_oy;
-    DrawTmp->m_End.x = Dimension->FlecheD1_fx;
-    DrawTmp->m_End.y = Dimension->FlecheD1_fy;
+    DrawTmp->m_Start.x = Dimension->m_arrowD1Ox;
+    DrawTmp->m_Start.y = Dimension->m_arrowD1Oy;
+    DrawTmp->m_End.x = Dimension->m_arrowD1Fx;
+    DrawTmp->m_End.y = Dimension->m_arrowD1Fy;
     PlotDrawSegment( plotter, DrawTmp, aLayerMask, trace_mode );
 
-    DrawTmp->m_Start.x = Dimension->FlecheD2_ox;
-    DrawTmp->m_Start.y = Dimension->FlecheD2_oy;
-    DrawTmp->m_End.x = Dimension->FlecheD2_fx;
-    DrawTmp->m_End.y = Dimension->FlecheD2_fy;
+    DrawTmp->m_Start.x = Dimension->m_arrowD2Ox;
+    DrawTmp->m_Start.y = Dimension->m_arrowD2Oy;
+    DrawTmp->m_End.x = Dimension->m_arrowD2Fx;
+    DrawTmp->m_End.y = Dimension->m_arrowD2Fy;
     PlotDrawSegment( plotter, DrawTmp, aLayerMask, trace_mode );
 
-    DrawTmp->m_Start.x = Dimension->FlecheG1_ox;
-    DrawTmp->m_Start.y = Dimension->FlecheG1_oy;
-    DrawTmp->m_End.x = Dimension->FlecheG1_fx;
-    DrawTmp->m_End.y = Dimension->FlecheG1_fy;
+    DrawTmp->m_Start.x = Dimension->m_arrowG1Ox;
+    DrawTmp->m_Start.y = Dimension->m_arrowG1Oy;
+    DrawTmp->m_End.x = Dimension->m_arrowG1Fx;
+    DrawTmp->m_End.y = Dimension->m_arrowG1Fy;
     PlotDrawSegment( plotter, DrawTmp, aLayerMask, trace_mode );
 
-    DrawTmp->m_Start.x = Dimension->FlecheG2_ox;
-    DrawTmp->m_Start.y = Dimension->FlecheG2_oy;
-    DrawTmp->m_End.x = Dimension->FlecheG2_fx;
-    DrawTmp->m_End.y = Dimension->FlecheG2_fy;
+    DrawTmp->m_Start.x = Dimension->m_arrowG2Ox;
+    DrawTmp->m_Start.y = Dimension->m_arrowG2Oy;
+    DrawTmp->m_End.x = Dimension->m_arrowG2Fx;
+    DrawTmp->m_End.y = Dimension->m_arrowG2Fy;
     PlotDrawSegment( plotter, DrawTmp, aLayerMask, trace_mode );
 
     delete DrawTmp;
@@ -367,8 +366,7 @@ void PlotPcbTarget( PLOTTER* plotter, PCB_TARGET* Mire, int aLayerMask, GRTraceM
 
 
 /* Plot footprints graphic items (outlines) */
-void Plot_Edges_Modules( PLOTTER* plotter, BOARD* pcb, int aLayerMask,
-                         GRTraceMode trace_mode )
+void Plot_Edges_Modules( PLOTTER* plotter, BOARD* pcb, int aLayerMask, GRTraceMode trace_mode )
 {
     for( MODULE* module = pcb->m_Modules; module; module = module->Next() )
     {
@@ -389,8 +387,7 @@ void Plot_Edges_Modules( PLOTTER* plotter, BOARD* pcb, int aLayerMask,
 
 
 /* Plot a graphic item (outline) relative to a footprint */
-void Plot_1_EdgeModule( PLOTTER* plotter, EDGE_MODULE* PtEdge,
-                        GRTraceMode trace_mode )
+void Plot_1_EdgeModule( PLOTTER* plotter, EDGE_MODULE* PtEdge, GRTraceMode trace_mode )
 {
     int     type_trace;         /* Type of item to plot. */
     int     thickness;          /* Segment thickness. */
@@ -467,8 +464,7 @@ void Plot_1_EdgeModule( PLOTTER* plotter, EDGE_MODULE* PtEdge,
 
 
 /* Plot a PCB Text, i;e. a text found on a copper or technical layer */
-void PlotTextePcb( PLOTTER* plotter, TEXTE_PCB* pt_texte, int aLayerMask,
-                   GRTraceMode trace_mode )
+void PlotTextePcb( PLOTTER* plotter, TEXTE_PCB* pt_texte, int aLayerMask, GRTraceMode trace_mode )
 {
     int     orient, thickness;
     wxPoint pos;
@@ -711,7 +707,7 @@ void PCB_BASE_FRAME::Plot_Layer( PLOTTER* plotter, int Layer, GRTraceMode trace_
         break;
 
     default:
-        Plot_Serigraphie( plotter, layer_mask, trace_mode );
+        PlotSilkScreen( plotter, layer_mask, trace_mode );
 
         // Gerber: Subtract soldermask from silkscreen if enabled
         if( plotter->GetPlotterType() == PLOT_FORMAT_GERBER