Gerbview: fix most of Doxygen warnings.

common/edaappl.cpp

@@ -872,7 +872,7 @@ wxString WinEDA_App::FindFileInSearchPaths( const wxString&      filename,
 }
 
 
-/**
+/* GetHelpFile
  * Get the help file path.
  *
  * Return the Kicad help file with path.  The base paths defined in
@@ -880,9 +880,9 @@ wxString WinEDA_App::FindFileInSearchPaths( const wxString&      filename,
  * be relative depending on the paths added to m_searchPaths.  See the
  * documentation for wxPathList for more information. If the help file
  * for the current locale is not found, an attempt to find the English
- * version of the help file is made.  wxEmptyString is returned if the
- * help file is not found.
- *  Help file is searched in directories in this order:
+ * version of the help file is made.
+ * wxEmptyString is returned if help file not found.
+ * Help file is searched in directories in this order:
  *  help/<canonical name> like help/en_GB
  *  help/<short name> like help/en
  *  help/en
@@ -1070,13 +1070,12 @@ wxString WinEDA_App::ReturnFilenameWithRelativePathInLibPath( const wxString& aF
 }
 
 
-/** FindLibraryPath
+/* FindLibraryPath
  * Kicad saves user defined library files that are not in the standard
  * library search path list with the full file path.  Calling the library
  * search path list with a user library file will fail.  This helper method
  * solves that problem.
- * @param fileName
- * @return a wxEmptyString if library file is not found.
+ * return a wxEmptyString if library file is not found.
  */
 wxString WinEDA_App::FindLibraryPath( const wxString& aFileName )
 {
@@ -1087,10 +1086,9 @@ wxString WinEDA_App::FindLibraryPath( const wxString& aFileName )
 }
 
 
-/**
- * Function RemoveLibraryPath
+/* Function RemoveLibraryPath
  * Removes the given path(s) from the library path list
- * @param aPaths = path or path list to remove. paths must be separated by ";"
+ * aPaths = path or path list to remove. paths must be separated by ";"
  */
 void WinEDA_App::RemoveLibraryPath( const wxString& aPaths )
 {

gerbview/class_aperture_macro.h

@@ -189,6 +189,7 @@ struct APERTURE_MACRO
      * But some parameters are defined outside the aperture primitive
      * and are local to the aperture macro
      * @return the value of a defered parameter defined inside the aperture macro
+     * @param aDcode = the D_CODE that uses this apertur macro and define defered parameters
      * @param aParamId = the param id (defined by $3 or $5 ..) to evaluate
      */
     double GetLocalParam( const D_CODE* aDcode, unsigned aParamId ) const;

gerbview/class_gerber_draw_item.cpp

@@ -271,7 +271,7 @@ EDA_Rect GERBER_DRAW_ITEM::GetBoundingBox() const
 /**
  * Function MoveAB
  * move this object.
- * @param const wxPoint& aMoveVector - the move vector for this object, in AB plotter axis.
+ * @param aMoveVector - the move vector for this object, in AB plotter axis.
  */
 void GERBER_DRAW_ITEM::MoveAB( const wxPoint& aMoveVector )
 {
@@ -288,7 +288,7 @@ void GERBER_DRAW_ITEM::MoveAB( const wxPoint& aMoveVector )
 /**
  * Function MoveXY
  * move this object.
- * @param const wxPoint& aMoveVector - the move vector for this object, in XY gerber axis.
+ * @param aMoveVector - the move vector for this object, in XY gerber axis.
  */
 void GERBER_DRAW_ITEM::MoveXY( const wxPoint& aMoveVector )
 {
@@ -323,7 +323,7 @@ bool GERBER_DRAW_ITEM::HasNegativeItems()
     // we must see if this aperture macro uses a negative shape.
     if( isClear )
         return true;
-    
+
     // see for a macro def
     D_CODE* dcodeDescr = GetDcodeDescr();
     if( dcodeDescr == NULL )
@@ -334,7 +334,7 @@ bool GERBER_DRAW_ITEM::HasNegativeItems()
         if( macro )     // macro == NULL should not occurs
             return macro->HasNegativeItems( this );
     }
-    
+
     return false;
 }
 
@@ -552,7 +552,7 @@ void GERBER_DRAW_ITEM::ConvertSegmentToPolygon( )
 }
 
 
-/**
+/*
  * Function DrawGbrPoly
  * a helper function used id ::Draw to draw the polygon stored in m_PolyCorners
  * Draw filled polygons
@@ -661,17 +661,17 @@ bool GERBER_DRAW_ITEM::HitTest( const wxPoint& aRefPos )
  * Function HitTest (overlayed)
  * tests if the given EDA_Rect intersect this object.
  * For now, an ending point must be inside this rect.
- * @param refArea : the given EDA_Rect in AB plotter axis
+ * @param aRefArea : the given EDA_Rect in AB plotter axis
  * @return bool - true if a hit, else false
  */
-bool GERBER_DRAW_ITEM::HitTest( EDA_Rect& refArea )
+bool GERBER_DRAW_ITEM::HitTest( EDA_Rect& aRefArea )
 {
     wxPoint pos = GetABPosition( m_Start );
 
-    if( refArea.Inside( pos ) )
+    if( aRefArea.Inside( pos ) )
         return true;
     pos = GetABPosition( m_End );
-    if( refArea.Inside( pos ) )
+    if( aRefArea.Inside( pos ) )
         return true;
     return false;
 }

gerbview/class_gerber_draw_item.h

@@ -119,7 +119,7 @@ public:
     {
         return m_LayerNegative;
     }
-    
+
     /**
      * Function HasNegativeItems
      * @return true if this item or at least one shape (when using aperture macros
@@ -147,14 +147,14 @@ public:
     /**
      * Function MoveAB
      * move this object.
-     * @param const wxPoint& aMoveVector - the move vector for this object.
+     * @param aMoveVector - the move vector for this object.
      */
     void MoveAB( const wxPoint& aMoveVector );
 
      /**
      * Function MoveXY
      * move this object.
-     * @param const wxPoint& aMoveVector - the move vector for this object, in XY gerber axis.
+     * @param aMoveVector - the move vector for this object, in XY gerber axis.
      */
     void MoveXY( const wxPoint& aMoveVector );
 
@@ -238,7 +238,7 @@ public:
     /**
      * Function HitTest
      * tests if the given wxPoint is within the bounds of this object.
-     * @param aRefPos A wxPoint to test
+     * @param aRefPos a wxPoint to test
      * @return bool - true if a hit, else false
      */
     bool     HitTest( const wxPoint& aRefPos );
@@ -247,7 +247,7 @@ public:
      * Function HitTest (overlayed)
      * tests if the given wxRect intersect this object.
      * For now, an ending point must be inside this rect.
-     * @param aRefPos A wxPoint to test
+     * @param aRefArea a wxPoint to test
      * @return bool - true if a hit, else false
      */
     bool     HitTest( EDA_Rect& aRefArea );

gerbview/class_gerbview_layer_widget.cpp

@@ -38,7 +38,7 @@
 #include "class_gerbview_layer_widget.h"
 
 
-/**
+/*
  * Class GERBER_LAYER_WIDGET
  * is here to implement the abtract functions of LAYER_WIDGET so they
  * may be tied into the WinEDA_GerberFrame's data and so we can add a popup

gerbview/class_gerbview_layer_widget.h

@@ -63,6 +63,8 @@ public:
 
     /**
      * Constructor
+     * @param aParent : the parent frame
+     * @param aFocusOwner : the window that has the keyboard focus.
      * @param aPointSize is the font point size to use within the widget.  This
      *  effectively sets the overal size of the widget via the row height and bitmap
      *  button sizes.

gerbview/dcode.cpp

@@ -136,7 +136,7 @@ int D_CODE::GetShapeDim( GERBER_DRAW_ITEM* aParent )
 }
 
 
-/**
+/*
  * Function Read_D_Code_File
  * Can be useful only with old RS274D Gerber file format.
  * Is not needed with RS274X files format.
@@ -326,7 +326,7 @@ void WinEDA_GerberFrame::CopyDCodesSizeToItems()
 }
 
 
-/**
+/*
  * Function DrawFlashedShape
  * Draw the dcode shape for flashed items.
  * When an item is flashed, the DCode shape is the shape of the item
@@ -442,7 +442,7 @@ void D_CODE::DrawFlashedShape(  GERBER_DRAW_ITEM* aParent,
 }
 
 
-/**
+/*
  * Function DrawFlashedPolygon
  * a helper function used id ::Draw to draw the polygon stored ion m_PolyCorners
  * Draw some Apertures shapes when they are defined as filled polygons.

gerbview/dcode.h

@@ -164,8 +164,8 @@ public:
      * @param aDC = device context
      * @param aColor = the normal color to use
      * @param aAltColor = the color used to draw with "reverse" exposure mode (used in aperture macros only)
-     * @param aFilled = true to draw in filled mode, false to draw in skecth mode
-     * @param aPosition = the actual shape position
+     * @param aShapePos = the actual shape position
+     * @param aFilledShape = true to draw in filled mode, false to draw in skecth mode
      */
     void                 DrawFlashedShape(  GERBER_DRAW_ITEM* aParent,
                                             EDA_Rect* aClipBox, wxDC* aDC, int aColor, int aAltColor,

gerbview/dialogs/dialog_gerber_config.cpp

@@ -124,7 +124,7 @@ WinEDA_ConfigFrame::WinEDA_ConfigFrame( WinEDA_GerberFrame* parent,
 }
 
 
-void WinEDA_ConfigFrame::OnOkClick( wxCommandEvent& WXUNUSED (event) )
+void WinEDA_ConfigFrame::OnOkClick( wxCommandEvent &event )
 {
     g_DrillFilenameExt = TextDrillExt->GetValue();
     g_PhotoFilenameExt = TextPhotoExt->GetValue();
@@ -134,7 +134,7 @@ void WinEDA_ConfigFrame::OnOkClick( wxCommandEvent& WXUNUSED (event) )
 }
 
 
-void WinEDA_ConfigFrame::OnCancelClick( wxCommandEvent& WXUNUSED (event) )
+void WinEDA_ConfigFrame::OnCancelClick( wxCommandEvent &event )
 {
     EndModal( -1 );
 }

gerbview/dialogs/gerbview_dialog_display_options_frame.cpp

@@ -54,7 +54,7 @@ DIALOG_DISPLAY_OPTIONS::DIALOG_DISPLAY_OPTIONS( WinEDA_GerberFrame *parent) :
 }
 
 
-void DIALOG_DISPLAY_OPTIONS::OnCancelButtonClick( wxCommandEvent& WXUNUSED(event) )
+void DIALOG_DISPLAY_OPTIONS::OnCancelButtonClick( wxCommandEvent& event )
 {
     EndModal( 0 );
 }

gerbview/draw_gerber_screen.cpp

@@ -126,9 +126,10 @@ void WinEDA_GerberFrame::RedrawActiveWindow( wxDC* DC, bool EraseBg )
 }
 
 
-/********************************************************************/
+/*
+ * Redraw All gerbview layers, using a buffered mode or not
+ */
 void BOARD::Draw( WinEDA_DrawPanel* aPanel, wxDC* aDC, int aDrawMode, const wxPoint& aOffset )
-/********************************************************************/
 {
     // Because Images can be negative (i.e with background filled in color) items are drawn
     // graphic layer per graphic layer, after the background is filled

gerbview/gerberframe.cpp

@@ -527,7 +527,7 @@ void WinEDA_GerberFrame::Liste_D_Codes()
 }
 
 
-/**
+/*
  * Function UpdateTitleAndInfo
  * displays the short filename (if exists) of the selected layer
  *  on the caption of the main gerbview window

gerbview/rs274d.cpp

@@ -86,7 +86,6 @@ static wxPoint LastPosition;
  * @param aPos The center point of the flash
  * @param aSize The diameter of the round flash
  * @param aLayerNegative = true if the current layer is negative
- * @param aImageNegative = true if the current image is negative
  */
 static void fillFlashedGBRITEM(  GERBER_DRAW_ITEM* aGbrItem,
                                  APERTURE_T        aAperture,
@@ -177,17 +176,19 @@ static void fillLineGBRITEM(  GERBER_DRAW_ITEM* aGbrItem,
  * <li> absolute angle 180 to 270 (quadrant 3) or
  * <li> absolute angle 270 to 0 (quadrant 4)
  * </ul><p>
- * @param GERBER_DRAW_ITEM is the GBRITEM to fill in.
+ * @param aGbrItem is the GBRITEM to fill in.
  * @param Dcode_index is the DCODE value, like D14
  * @param aLayer is the layer index to set into the GBRITEM
  * @param aStart is the starting point
  * @param aEnd is the ending point
- * @param rel_center is the center coordinate relative to start point,
+ * @param aRelCenter is the center coordinate relative to start point,
  *   given in ABSOLUTE VALUE and the sign of values x et y de rel_center
  *   must be calculated from the previously given constraint: arc only in the
  * same quadrant.
- * @param aDiameter The diameter of the round flash
+ * @param aClockwise true if arc must be created clockwise
  * @param aPenSize The size of the flash. Note rectangular shapes are legal.
+ * @param aMultiquadrant = true to create arcs upto 360 deg,
+ *                      false when arc is inside one quadrant
  * @param aLayerNegative = true if the current layer is negative
  */
 static void fillArcGBRITEM(  GERBER_DRAW_ITEM* aGbrItem, int Dcode_index, int aLayer,
@@ -212,7 +213,7 @@ static void fillArcGBRITEM(  GERBER_DRAW_ITEM* aGbrItem, int Dcode_index, int aL
         // So we must recalculate the actual sign of aRelCenter.x and aRelCenter.y
         center = aRelCenter;
 
-        // calculate arc end coordinate relative to the staring point,
+        // calculate arc end coordinate relative to the starting point,
         // because center is relative to the center point
         delta  = aEnd - aStart;
 
@@ -305,22 +306,22 @@ static void fillArcGBRITEM(  GERBER_DRAW_ITEM* aGbrItem, int Dcode_index, int aL
  * <li> absolute angle 270 to 0 (quadrant 4)
  * </ul><p>
  * @param aPcb is the board.
- * @param aLayer is the layer index to set into the GBRITEM
+ * @param aGbrItem is the GBRITEM to fill in.
  * @param aStart is the starting point
  * @param aEnd is the ending point
  * @param rel_center is the center coordinate relative to start point,
  *   given in ABSOLUTE VALUE and the sign of values x et y de rel_center
  *   must be calculated from the previously given constraint: arc only in the
  * same quadrant.
- * @param aDiameter The diameter of the round flash
- * @param aWidth is the pen width.
+ * @param aClockwise true if arc must be created clockwise
+ * @param aMultiquadrant = true to create arcs upto 360 deg,
+ *                      false when arc is inside one quadrant
  * @param aLayerNegative = true if the current layer is negative
- * @param aImageNegative = true if the current image is negative
  */
 static void fillArcPOLY(  BOARD* aPcb, GERBER_DRAW_ITEM* aGbrItem,
                           const wxPoint& aStart, const wxPoint& aEnd,
                           const wxPoint& rel_center,
-                          bool clockwise, bool multiquadrant,
+                          bool aClockwise, bool aMultiquadrant,
                           bool aLayerNegative  )
 {
     /* in order to calculate arc parameters, we use fillArcGBRITEM
@@ -332,7 +333,7 @@ static void fillArcPOLY(  BOARD* aPcb, GERBER_DRAW_ITEM* aGbrItem,
 
     fillArcGBRITEM(  &dummyGbrItem, 0, 0,
                      aStart, aEnd, rel_center, wxSize(0, 0),
-                     clockwise, multiquadrant, aLayerNegative );
+                     aClockwise, aMultiquadrant, aLayerNegative );
 
     wxPoint   center;
     center = dummyGbrItem.m_ArcCentre;
@@ -370,7 +371,7 @@ static void fillArcPOLY(  BOARD* aPcb, GERBER_DRAW_ITEM* aGbrItem,
     {
         int rot;
         wxPoint end_arc = start;
-        if( clockwise )
+        if( aClockwise )
             rot = ii * increment_angle; // rot is in 0.1 deg
         else
             rot = (count - ii) * increment_angle; // rot is in 0.1 deg
@@ -378,7 +379,7 @@ static void fillArcPOLY(  BOARD* aPcb, GERBER_DRAW_ITEM* aGbrItem,
         if( ii < count )
                 RotatePoint( &end_arc, -rot );
         else    // last point
-            end_arc = clockwise ? end : start;
+            end_arc = aClockwise ? end : start;
 
         aGbrItem->m_PolyCorners.push_back( end_arc + center );
 

gerbview/rs274x.cpp

@@ -769,7 +769,7 @@ bool GetEndOfBlock( char buff[GERBER_BUFZ], char*& text, FILE* gerber_file )
  * test for an end of line
  * if an end of line is found:
  *   read a new line
- * @param aBuff[GERBER_BUFZ] = buffer to fill with a new line
+ * @param aBuff = buffer (size = GERBER_BUFZ) to fill with a new line
  * @param aText = pointer to the last useful char in aBuff
  *          on return: points the beginning of the next line.
  * @param aFile = the opened GERBER file to read

gerbview/wxGerberFrame.h

@@ -387,7 +387,7 @@ public: WinEDA_GerberFrame( wxWindow* father, const wxString& title,
      * example: 0.012, 0.012,  L   , D10<br>
      *
      * Categorize all found dcodes into a table of D_CODE instantiations.
-     * @param D_CodeFullFileName The name of the file to read from.
+     * @param D_Code_FullFileName The name of the file to read from.
      * @return int - <br>
      *                 -1 = file not found<br>
      *                 -2 = parsing problem<br>