Fix a few doxygen warnings

common/common_plotHPGL_functions.cpp

@@ -666,7 +666,7 @@ void HPGL_PLOTTER::FlashPadCustom( const wxPoint& aPadPos, const wxSize& aSize,
 
 
 void HPGL_PLOTTER::FlashPadTrapez( const wxPoint& aPadPos, const wxPoint* aCorners,
-                                   double aPadOrient, EDA_DRAW_MODE_T aTrace_Mode, void* aData )
+                                   double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void* aData )
 {
     std::vector< wxPoint > cornerList;
     cornerList.reserve( 4 );
@@ -679,5 +679,5 @@ void HPGL_PLOTTER::FlashPadTrapez( const wxPoint& aPadPos, const wxPoint* aCorne
         cornerList.push_back( coord );
     }
 
-    PlotPoly( cornerList, aTrace_Mode == FILLED ? FILLED_SHAPE : NO_FILL );
+    PlotPoly( cornerList, aTraceMode == FILLED ? FILLED_SHAPE : NO_FILL );
 }

eeschema/netlist_exporters/netlist_exporter.h

@@ -173,6 +173,7 @@ public:
     /**
      * Constructor
      * @param aMasterList we take ownership of this here.
+     * @param aLibs is the library list of the project.
      */
     NETLIST_EXPORTER( NETLIST_OBJECT_LIST* aMasterList, PART_LIBS* aLibs ) :
         m_masterList( aMasterList ),

gerbview/rs274x.cpp

@@ -149,9 +149,13 @@ static int ReadXCommand( char*& text )
 }
 
 /**
- * convert a string read from a gerber file to an unicode string
- * usual chars are just copied. \hhhh values are converted to
- * the unicoade char value
+ * Convert a string read from a gerber file to an unicode string
+ * Usual chars (ASCII7 values) are the only values allowed in Gerber files,
+ * and are just copied.
+ * However Gerber format allows using non ASCII7 values by coding them in a
+ * sequence of 4 hexadecimal chars (16 bits hexadecimal value)
+ * Hexadecimal coded values ("\hhhh") are converted to
+ * the unicode char value
  */
 static const wxString fromGerberString( const wxString& aGbrString )
 {

include/convert_basic_shapes_to_polygon.h

@@ -54,10 +54,11 @@ void TransformCircleToPolygon( SHAPE_POLY_SET&  aCornerBuffer,
  * Helper function GetRoundRectCornerCenters
  * Has meaning only for rounded rect
  * Returns the centers of the rounded corners.
+ * @param aCenters is the buffer to store the 4 coordinates.
+ * @param aRadius = the radius of the of the rounded corners.
  * @param aPosition = position of the round rect
  * @param aSize = size of the of the round rect.
  * @param aRotation = rotation of the of the round rect
- * @param aCenters a buffer to store the 4 coordinates.
  */
 void GetRoundRectCornerCenters( wxPoint aCenters[4], int aRadius,
             const wxPoint& aPosition, const wxSize& aSize, double aRotation );

include/incremental_text_ctrl.h

@@ -76,7 +76,7 @@ public:
      *
      * @param aMin the minium value allowed
      * @param aMax the maximum value allows
-     * @param aNewfunc the step function used to calculate the next step
+     * @param aNewFunc the step function used to calculate the next step
      */
     void SetStep( double aMin, double aMax, STEP_FUNCTION aNewFunc );
 

include/observable.h

@@ -1,4 +1,3 @@
-
 /*
 * This program source code file is part of KICAD, a free EDA CAD application.
 *
@@ -169,16 +168,16 @@ namespace UTIL {
          * cancels the subscription of a subscriber. Can be called during notification calls.
          * @param aObserver observer to remove from the subscription list
          */
-        void Unsubscribe( ObserverInterface* obs )
+        void Unsubscribe( ObserverInterface* aObserver )
         {
-            OBSERVABLE_BASE::remove_observer( static_cast<void*>(obs) );
+            OBSERVABLE_BASE::remove_observer( static_cast<void*>(aObserver) );
         }
 
         /**
          * Function Notify
          * Notifies event to all subscribed observers.
          * @param Ptr pointer to method of the Observer-interface
-         * @param Args list of arguments to each notification call, will be perfectly forwarded.
+         * @param aArgs list of arguments to each notification call, will be perfectly forwarded.
          */
         template< typename... Args1, typename... Args2 >
         void Notify( void(ObserverInterface::*Ptr)(Args1...), Args2&&... aArgs )
@@ -213,7 +212,7 @@ namespace UTIL {
         * Notifies event to all subscribed observers but one to be ignore.
         * @param Ptr pointer to method of the Observer-interface
         * @param aIgnore observer to ignore during this notification
-        * @param Args list of arguments to each notification call, will be perfectly forwarded.
+        * @param aArgs list of arguments to each notification call, will be perfectly forwarded.
         */
         template< typename... Args1, typename... Args2 >
         void NotifyIgnore( void(ObserverInterface::*Ptr)(Args1...), ObserverInterface* aIgnore,

include/plot_common.h

@@ -322,7 +322,7 @@ public:
      * virtual function FlashPadRoundRect
      * @param aPadPos Position of the shape (center of the rectangle
      * @param aSize = size of rounded rect
-     * @param cornerRadius Radius of the rounded corners
+     * @param aCornerRadius = radius of the rounded corners
      * @param aOrient is the rotation of the shape
      * @param aTraceMode FILLED or SKETCH
      * @param aData an auxiliary info (mainly for gerber format attributes)
@@ -349,7 +349,7 @@ public:
      * @param aCorners = the list of 4 corners positions,
      * 		relative to the shape position, pad orientation 0
      * @param aPadOrient = the rotation of the shape
-     * @param aTrace_Mode = FILLED or SKETCH
+     * @param aTraceMode = FILLED or SKETCH
      * @param aData an auxiliary info (mainly for gerber format attributes)
      */
     virtual void FlashPadTrapez( const wxPoint& aPadPos, const wxPoint *aCorners,
@@ -621,7 +621,7 @@ public:
                                  SHAPE_POLY_SET* aPolygons,
                                  EDA_DRAW_MODE_T aTraceMode, void* aData ) override;
     virtual void FlashPadTrapez( const wxPoint& aPadPos, const wxPoint *aCorners,
-                                 double aPadOrient, EDA_DRAW_MODE_T aTrace_Mode,
+                                 double aPadOrient, EDA_DRAW_MODE_T aTraceMode,
                                  void* aData ) override;
 
 protected:
@@ -679,7 +679,7 @@ public:
                                  SHAPE_POLY_SET* aPolygons,
                                  EDA_DRAW_MODE_T aTraceMode, void* aData ) override;
     virtual void FlashPadTrapez( const wxPoint& aPadPos, const wxPoint *aCorners,
-                                 double aPadOrient, EDA_DRAW_MODE_T aTrace_Mode, void* aData ) override;
+                                 double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void* aData ) override;
 
     /** The SetColor implementation is split with the subclasses:
      * The PSLIKE computes the rgb values, the subclass emits the
@@ -1087,7 +1087,7 @@ public:
      * TODO: always use flashed shapes (aperture macros)
      */
     virtual void FlashPadTrapez( const wxPoint& aPadPos, const wxPoint *aCorners,
-                                 double aPadOrient, EDA_DRAW_MODE_T aTrace_Mode, void* aData ) override;
+                                 double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void* aData ) override;
 
     /**
      * Change the plot polarity and begin a new layer
@@ -1276,7 +1276,7 @@ public:
                                  SHAPE_POLY_SET* aPolygons,
                                  EDA_DRAW_MODE_T aTraceMode, void* aData ) override;
     virtual void FlashPadTrapez( const wxPoint& aPadPos, const wxPoint *aCorners,
-                                 double aPadOrient, EDA_DRAW_MODE_T aTrace_Mode, void* aData ) override;
+                                 double aPadOrient, EDA_DRAW_MODE_T aTraceMode, void* aData ) override;
 
     virtual void Text( const wxPoint&              aPos,
                        const COLOR4D               aColor,

include/reporter.h

@@ -75,6 +75,8 @@ public:
      * is a pure virtual function to override in the derived object.
      *
      * @param aText is the string to report.
+     * @param aSeverity is an indicator ( RPT_UNDEFINED, RPT_INFO, RPT_WARNING,
+     * RPT_ERROR, RPT_ACTION ) used to filter and format messages
      */
 
     virtual REPORTER& Report( const wxString& aText, SEVERITY aSeverity = RPT_UNDEFINED ) = 0;

include/widgets/indicator_icon.h

@@ -73,6 +73,8 @@ public:
     /**
      * @param aParent the owning window
      * @param aIconProvider the icon provider to get icons from
+     * @param aInitialIcon is the initial state of the icon (the meaning
+     * depends on what is the purpose of the icon)
      * @param aID the ID to use for the widgets - events will have
      * this ID.
      */

include/widgets/mathplot.h

@@ -698,17 +698,21 @@ public:
     bool HasBBox() override { return FALSE; }
 
     /** Set X axis alignment.
-     *  @param align alignment (choose between mpALIGN_BORDER_BOTTOM, mpALIGN_BOTTOM, mpALIGN_CENTER, mpALIGN_TOP, mpALIGN_BORDER_TOP */
+     *  @param align alignment (choose between mpALIGN_BORDER_BOTTOM, mpALIGN_BOTTOM, mpALIGN_CENTER,
+     * mpALIGN_TOP, mpALIGN_BORDER_TOP
+     */
     void SetAlign( int align ) { m_flags = align; };
 
     void SetNameAlign( int align ) { m_nameFlags = align; }
 
     /** Set X axis ticks or grid
-     *  @param ticks TRUE to plot axis ticks, FALSE to plot grid. */
+     *  @param enable = true to plot axis ticks, false to plot grid.
+     */
     void SetTicks( bool enable ) { m_ticks = enable; };
 
     /** Get X axis ticks or grid
-     *  @return TRUE if plot is drawing axis ticks, FALSE if the grid is active. */
+     *  @return TRUE if plot is drawing axis ticks, FALSE if the grid is active.
+     */
     bool GetTicks() { return m_ticks; };
 
 
@@ -1271,10 +1275,12 @@ public:
      *  \return The number of layers in the mpWindow. */
     unsigned int CountAllLayers() { return m_layers.size(); };
 
+#if 0
     /** Draws the mpWindow on a page for printing
-     *  \param print the mpPrintout where to print the graph */
-    // void PrintGraph(mpPrintout *print);
-
+     *  \param print the mpPrintout where to print the graph
+     */
+    void PrintGraph(mpPrintout *print);
+#endif
 
     /** Returns the left-border layer coordinate that the user wants the mpWindow to show (it may be not exactly the actual shown coordinate in the case of locked aspect ratio).
      * @sa Fit
@@ -1336,19 +1342,26 @@ public:
     /** Set the left margin. @param left Left Margin */
     void SetMarginLeft( int left ) { m_marginLeft = left; };
 
-    /** Get the top margin. @param top Top Margin */
+    /** @return the top margin. */
     int GetMarginTop() { return m_marginTop; };
-    /** Get the right margin. @param right Right Margin */
+    /** @return the right margin. */
     int GetMarginRight() { return m_marginRight; };
-    /** Get the bottom margin. @param bottom Bottom Margin */
+    /** @return the bottom margin. */
     int GetMarginBottom() { return m_marginBottom; };
-    /** Get the left margin. @param left Left Margin */
+    /** @return the left margin. */
     int GetMarginLeft() { return m_marginLeft; };
 
-    /** Sets whether to show coordinate tooltip when mouse passes over the plot. \param value true for enable, false for disable */
+#if 0
+    /** Sets whether to show coordinate tooltip when mouse passes over the plot.
+     * \param value true for enable, false for disable
+     */
     // void EnableCoordTooltip(bool value = true);
-    /** Gets coordinate tooltip status. \return true for enable, false for disable */
+
+    /** Gets coordinate tooltip status.
+     * \return true for enable, false for disable
+     */
     // bool GetCoordTooltip() { return m_coordTooltip; };
+#endif
 
     /** Check if a given point is inside the area of a mpInfoLayer and eventually returns its pointer.
      *  @param point The position to be checked

include/wxPcbStruct.h

@@ -618,8 +618,8 @@ public:
      * Function SetElementVisibility
      * changes the visibility of an element category
      * @param aElement is from the enum by the same name
-     * @param GAL_LAYER_ID = The new visibility state of the element category
-     * @see enum PCB_LAYER_ID
+     * @see enum GAL_LAYER_ID
+     * @param aNewState = The new visibility state of the element category
      */
     void SetElementVisibility( GAL_LAYER_ID aElement, bool aNewState );