Fix a few doxygen warnings

eeschema/sim/spice_simulator.h

@@ -90,6 +90,8 @@ public:
      * @brief Returns a requested vector with complex values. If the vector is real, then
      * the imaginary part is set to 0 in all values.
      * @param aName is the vector named in Spice convention (e.g. V(3), I(R1)).
+     * @param aMaxLen is max count of returned values.
+     * if -1 (default) all available values are returned.
      * @return Requested vector. It might be empty if there is no vector with requested name.
      */
     virtual std::vector<COMPLEX> GetPlot( const std::string& aName, int aMaxLen = -1 ) = 0;
@@ -98,6 +100,8 @@ public:
      * @brief Returns a requested vector with real values. If the vector is complex, then
      * the real part is returned.
      * @param aName is the vector named in Spice convention (e.g. V(3), I(R1)).
+     * @param aMaxLen is max count of returned values.
+     * if -1 (default) all available values are returned.
      * @return Requested vector. It might be empty if there is no vector with requested name.
      */
     virtual std::vector<double> GetRealPlot( const std::string& aName, int aMaxLen = -1 ) = 0;
@@ -106,6 +110,8 @@ public:
      * @brief Returns a requested vector with imaginary values. If the vector is complex, then
      * the imaginary part is returned. If the vector is reql, then only zeroes are returned.
      * @param aName is the vector named in Spice convention (e.g. V(3), I(R1)).
+     * @param aMaxLen is max count of returned values.
+     * if -1 (default) all available values are returned.
      * @return Requested vector. It might be empty if there is no vector with requested name.
      */
     virtual std::vector<double> GetImagPlot( const std::string& aName, int aMaxLen = -1 ) = 0;
@@ -113,6 +119,8 @@ public:
     /**
      * @brief Returns a requested vector with magnitude values.
      * @param aName is the vector named in Spice convention (e.g. V(3), I(R1)).
+     * @param aMaxLen is max count of returned values.
+     * if -1 (default) all available values are returned.
      * @return Requested vector. It might be empty if there is no vector with requested name.
      */
     virtual std::vector<double> GetMagPlot( const std::string& aName, int aMaxLen = -1 ) = 0;
@@ -120,6 +128,8 @@ public:
     /**
      * @brief Returns a requested vector with phase values.
      * @param aName is the vector named in Spice convention (e.g. V(3), I(R1)).
+     * @param aMaxLen is max count of returned values.
+     * if -1 (default) all available values are returned.
      * @return Requested vector. It might be empty if there is no vector with requested name.
      */
     virtual std::vector<double> GetPhasePlot( const std::string& aName, int aMaxLen = -1 ) = 0;

include/geometry/seg.h

@@ -132,6 +132,7 @@ public:
       *
       * Returns the closest Euclidean distance between point aP and the line defined by
       * the ends of segment (this).
+      * @param aP the point to test
       * @param aDetermineSide: when true, the sign of the returned value indicates
       * the side of the line at which we are (negative = left)
       * @return the distance
@@ -142,7 +143,7 @@ public:
       * Function NearestPoint()
       *
       * Computes a point on the segment (this) that is closest to point aP.
-      * @return: nearest point
+      * @return the nearest point
       */
     const VECTOR2I NearestPoint( const VECTOR2I &aP ) const;
 

include/geometry/shape_line_chain.h

@@ -323,6 +323,9 @@ public:
      * Appends a new point at the end of the line chain.
      * @param aX is X coordinate of the new point
      * @param aY is Y coordinate of the new point
+     * @param aAllowDuplication = true to append the new point
+     * even it is the same as the last entered point
+     * false (default) to skip it if it is the same as the last entered point
      */
     void Append( int aX, int aY, bool aAllowDuplication = false )
     {
@@ -335,6 +338,9 @@ public:
      *
      * Appends a new point at the end of the line chain.
      * @param aP the new point
+     * @param aAllowDuplication = true to append the new point
+     * even it is the same as the last entered point
+     * false (default) to skip it if it is the same as the last entered point
      */
     void Append( const VECTOR2I& aP, bool aAllowDuplication = false )
     {

include/geometry/shape_poly_set.h

@@ -376,11 +376,7 @@ class SHAPE_POLY_SET : public SHAPE
          * relative to the contour relative to the polygon in which it is.
          * @param  aGlobalIdx  is the global index of the corner whose structured index wants to
          *                     be found
-         * @param  aPolygonIdx is the index of the polygon in which the expected vertex is.
+         * @param  aRelativeIndices is a pointer to the set of relative indices to store.
-         * @param  aContourIdx is the index of the contour in the aPolygonIdx-th polygon in which
-         *                     the expected vertex is.
-         * @param  aVertexIdx  is the index of the vertex in the aContourIdx-th contour in which
-         *                     the expected vertex is.
          * @return bool - true if the global index is correct and the information in
          *              aRelativeIndices is valid; false otherwise.
          */
@@ -866,7 +862,7 @@ class SHAPE_POLY_SET : public SHAPE
         /**
          * Function RemoveVertex
          * deletes the vertex indexed by aIndex (index of polygon, contour and vertex).
-         * @param aindex is the set of relative indices of the to-be-removed vertex.
+         * @param aRelativeIndices is the set of relative indices of the to-be-removed vertex.
          */
         void RemoveVertex( VERTEX_INDEX aRelativeIndices );
 
@@ -963,7 +959,7 @@ class SHAPE_POLY_SET : public SHAPE
          * @return int -  The minimum distance between aPoint and all the polygons in the set. If
          *                the point is contained in any of the polygons, the distance is zero.
          */
-        int Distance( VECTOR2I point );
+        int Distance( VECTOR2I aPoint );
 
         /**
          * Function DistanceToPolygon

include/view/view.h

@@ -105,35 +105,35 @@ public:
     int Query( const BOX2I& aRect, std::vector<LAYER_ITEM_PAIR>& aResult ) const;
 
     /**
-     * Function SetVisible()
      * Sets the item visibility.
      *
+     * @param aItem: the item to modify.
      * @param aIsVisible: whether the item is visible (on all layers), or not.
      */
     void SetVisible( VIEW_ITEM* aItem, bool aIsVisible = true );
 
     /**
-     * Function Hide()
      * Temporarily hides the item in the view (e.g. for overlaying)
      *
+     * @param aItem: the item to modify.
      * @param aHide: whether the item is hidden (on all layers), or not.
      */
     void Hide( VIEW_ITEM* aItem, bool aHide = true );
 
     /**
-     * Function IsVisible()
      * Returns information if the item is visible (or not).
      *
+     * @param aItem: the item to test.
      * @return when true, the item is visible (i.e. to be displayed, not visible in the
      * *current* viewport)
      */
     bool IsVisible( const VIEW_ITEM* aItem ) const;
 
     /**
-     * Function Update()
      * For dynamic VIEWs, informs the associated VIEW that the graphical representation of
      * this item has changed. For static views calling has no effect.
      *
+     * @param aItem: the item to update.
      * @param aUpdateFlags: how much the object has changed.
      */
     void Update( VIEW_ITEM* aItem );
@@ -345,7 +345,7 @@ public:
     /**
      * Function ToScreen()
      * Converts a world space one dimensionsal size to a one dimensional size in screen space.
-     * @param aCoord: the size to be transformed.
+     * @param aSize: the size to be transformed.
      */
     double ToScreen( double aSize ) const;
 
@@ -480,6 +480,7 @@ public:
     /**
      * Function SetTopLayer()
      * Sets given layer to be displayed on the top or sets back the default order of layers.
+     * @param aEnabled = true to display aLayer on the top.
      * @param aLayer: the layer or -1 in case when no particular layer should
      * be displayed on the top.
      */