Fix a few doxygen warnings
This commit is contained in:
parent
375ec9fec6
commit
2c21c70f46
|
@ -67,6 +67,7 @@ wxString DimensionLabel( const wxString& prefix, double aVal,
|
||||||
* Set the GAL glyph height to a constant scaled value, so that it
|
* Set the GAL glyph height to a constant scaled value, so that it
|
||||||
* always looks the same on screen
|
* always looks the same on screen
|
||||||
*
|
*
|
||||||
|
* @param aGal the GAL to draw on
|
||||||
* @param aHeight the height of the glyph, in pixels
|
* @param aHeight the height of the glyph, in pixels
|
||||||
*/
|
*/
|
||||||
void SetConstantGlyphHeight( KIGFX::GAL& aGal, double aHeight );
|
void SetConstantGlyphHeight( KIGFX::GAL& aGal, double aHeight );
|
||||||
|
|
|
@ -85,7 +85,7 @@ public:
|
||||||
/**
|
/**
|
||||||
* Function OnlyTypes
|
* Function OnlyTypes
|
||||||
* Creates a functor that tests if the selected items are *only* of given types.
|
* Creates a functor that tests if the selected items are *only* of given types.
|
||||||
* @param aType is a vector containing types that are searched.
|
* @param aTypes is a vector containing types that are searched.
|
||||||
* @return Functor testing if selected items are exclusively of the requested types.
|
* @return Functor testing if selected items are exclusively of the requested types.
|
||||||
*/
|
*/
|
||||||
static SELECTION_CONDITION OnlyTypes( const std::vector<KICAD_T>& aTypes );
|
static SELECTION_CONDITION OnlyTypes( const std::vector<KICAD_T>& aTypes );
|
||||||
|
@ -93,7 +93,7 @@ public:
|
||||||
/**
|
/**
|
||||||
* Function OnlyTypes
|
* Function OnlyTypes
|
||||||
* Creates a functor that tests if the selected items are *only* of given types.
|
* Creates a functor that tests if the selected items are *only* of given types.
|
||||||
* @param aType is an array containing types that are searched. It has to be ended with
|
* @param aTypes is an array containing types that are searched. It has to be ended with
|
||||||
* KICAD_T::EOT as end marker.
|
* KICAD_T::EOT as end marker.
|
||||||
* @return Functor testing if selected items are exclusively of the requested types.
|
* @return Functor testing if selected items are exclusively of the requested types.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -270,7 +270,7 @@ public:
|
||||||
* Function Add()
|
* Function Add()
|
||||||
*
|
*
|
||||||
* Adds an item to the current node.
|
* Adds an item to the current node.
|
||||||
* @param aItem item to add
|
* @param aSegment item to add
|
||||||
* @param aAllowRedundant if true, duplicate items are allowed (e.g. a segment or via
|
* @param aAllowRedundant if true, duplicate items are allowed (e.g. a segment or via
|
||||||
* at the same coordinates as an existing one)
|
* at the same coordinates as an existing one)
|
||||||
*/
|
*/
|
||||||
|
@ -288,7 +288,6 @@ public:
|
||||||
* Function Remove()
|
* Function Remove()
|
||||||
*
|
*
|
||||||
* Just as the name says, removes an item from this branch.
|
* Just as the name says, removes an item from this branch.
|
||||||
* @param aItem item to remove
|
|
||||||
*/
|
*/
|
||||||
void Remove( SOLID* aSolid );
|
void Remove( SOLID* aSolid );
|
||||||
void Remove( VIA* aVia );
|
void Remove( VIA* aVia );
|
||||||
|
@ -300,7 +299,7 @@ public:
|
||||||
* Function Remove()
|
* Function Remove()
|
||||||
*
|
*
|
||||||
* Just as the name says, removes a line from this branch.
|
* Just as the name says, removes a line from this branch.
|
||||||
* @param aItem item to remove
|
* @param aLine item to remove
|
||||||
*/
|
*/
|
||||||
void Remove( LINE& aLine );
|
void Remove( LINE& aLine );
|
||||||
|
|
||||||
|
|
|
@ -98,10 +98,10 @@ static void MoveDiagonal( SEG& aDiagonal, const SHAPE_LINE_CHAIN& aVertices, int
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
const SHAPE_LINE_CHAIN ConvexHull( const SHAPE_CONVEX& convex, int aClearance )
|
const SHAPE_LINE_CHAIN ConvexHull( const SHAPE_CONVEX& aConvex, int aClearance )
|
||||||
{
|
{
|
||||||
// this defines the horizontal and vertical lines in the hull octagon
|
// this defines the horizontal and vertical lines in the hull octagon
|
||||||
BOX2I box = convex.BBox( aClearance + HULL_MARGIN );
|
BOX2I box = aConvex.BBox( aClearance + HULL_MARGIN );
|
||||||
box.Normalize();
|
box.Normalize();
|
||||||
|
|
||||||
SEG topline = SEG( VECTOR2I( box.GetX(), box.GetY() + box.GetHeight() ),
|
SEG topline = SEG( VECTOR2I( box.GetX(), box.GetY() + box.GetHeight() ),
|
||||||
|
@ -112,7 +112,7 @@ const SHAPE_LINE_CHAIN ConvexHull( const SHAPE_CONVEX& convex, int aClearance )
|
||||||
box.GetOrigin() );
|
box.GetOrigin() );
|
||||||
SEG leftline = SEG( box.GetOrigin(), VECTOR2I( box.GetX(), box.GetY() + box.GetHeight() ) );
|
SEG leftline = SEG( box.GetOrigin(), VECTOR2I( box.GetX(), box.GetY() + box.GetHeight() ) );
|
||||||
|
|
||||||
const SHAPE_LINE_CHAIN& vertices = convex.Vertices();
|
const SHAPE_LINE_CHAIN& vertices = aConvex.Vertices();
|
||||||
|
|
||||||
// top right diagonal
|
// top right diagonal
|
||||||
VECTOR2I corner = box.GetOrigin() + box.GetSize();
|
VECTOR2I corner = box.GetOrigin() + box.GetSize();
|
||||||
|
|
|
@ -48,11 +48,11 @@ const SHAPE_LINE_CHAIN SegmentHull( const SHAPE_SEGMENT& aSeg, int aClearance,
|
||||||
* Function ConvexHull()
|
* Function ConvexHull()
|
||||||
*
|
*
|
||||||
* Creates an octagonal hull around a convex polygon.
|
* Creates an octagonal hull around a convex polygon.
|
||||||
* @param convex The convex polygon.
|
* @param aConvex The convex polygon.
|
||||||
* @param clearance The minimum distance between polygon and hull.
|
* @param aClearance The minimum distance between polygon and hull.
|
||||||
* @return A closed line chain describing the octagon.
|
* @return A closed line chain describing the octagon.
|
||||||
*/
|
*/
|
||||||
const SHAPE_LINE_CHAIN ConvexHull( const SHAPE_CONVEX& convex, int aClearance );
|
const SHAPE_LINE_CHAIN ConvexHull( const SHAPE_CONVEX& aConvex, int aClearance );
|
||||||
|
|
||||||
SHAPE_RECT ApproximateSegmentAsRect( const SHAPE_SEGMENT& aSeg );
|
SHAPE_RECT ApproximateSegmentAsRect( const SHAPE_SEGMENT& aSeg );
|
||||||
|
|
||||||
|
|
|
@ -969,7 +969,7 @@ int PCB_EDITOR_CONTROL::DrillOrigin( const TOOL_EVENT& aEvent )
|
||||||
* Function highlightNet()
|
* Function highlightNet()
|
||||||
* Looks for a BOARD_CONNECTED_ITEM in a given spot, and if one is found - it enables
|
* Looks for a BOARD_CONNECTED_ITEM in a given spot, and if one is found - it enables
|
||||||
* highlight for its net.
|
* highlight for its net.
|
||||||
* @param aPoint is the point where an item is expected (world coordinates).
|
* @param aPosition is the point where an item is expected (world coordinates).
|
||||||
*/
|
*/
|
||||||
static bool highlightNet( TOOL_MANAGER* aToolMgr, const VECTOR2D& aPosition )
|
static bool highlightNet( TOOL_MANAGER* aToolMgr, const VECTOR2D& aPosition )
|
||||||
{
|
{
|
||||||
|
|
|
@ -49,7 +49,7 @@ public:
|
||||||
|
|
||||||
void Reset( RESET_REASON aReason ) override;
|
void Reset( RESET_REASON aReason ) override;
|
||||||
|
|
||||||
/// @copydoc POSITION_RELATIVE_TOOL::Init()
|
/// @copydoc TOOL_BASE::Init()
|
||||||
bool Init() override;
|
bool Init() override;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
@ -267,7 +267,7 @@ private:
|
||||||
* @param tcx
|
* @param tcx
|
||||||
* @param ep - last point on the edge we are traversing
|
* @param ep - last point on the edge we are traversing
|
||||||
* @param eq - first point on the edge we are traversing
|
* @param eq - first point on the edge we are traversing
|
||||||
* @param flipTriangle - the current triangle sharing the point eq with edge
|
* @param flip_triangle - the current triangle sharing the point eq with edge
|
||||||
* @param t
|
* @param t
|
||||||
* @param p
|
* @param p
|
||||||
*/
|
*/
|
||||||
|
|
Loading…
Reference in New Issue