Commit 7cb34aec authored by Wayne Stambaugh's avatar Wayne Stambaugh
Browse files

Schematic component object encapsulation and Doxygen comment warning fixes.

parent cbd4ee88

Doxyfile

+0 −1
Original line number Original line Diff line number Diff line
@@ -83,7 +83,6 @@ INPUT = kicad \ 
                         3d-viewer \

                         3d-viewer \

                         common \

                         common \

                         gerbview \

                         gerbview \

                         share \

                         include \

                         include \

                         polygon \

                         polygon \

                         potrace

                         potrace

common/base_screen.cpp

+3 −3
Original line number Original line Diff line number Diff line
@@ -121,7 +121,7 @@ wxPoint BASE_SCREEN::CursorRealPosition( const wxPoint& ScreenPos ) 
/**

/**

 * Function SetScalingFactor

 * Function SetScalingFactor

 * calculates the .m_Zoom member to have a given scaling factor

 * calculates the .m_Zoom member to have a given scaling factor

 * @param the the current scale used to draw items on screen

 * @param aScale - the the current scale used to draw items on screen

 * draw coordinates are user coordinates * GetScalingFactor()

 * draw coordinates are user coordinates * GetScalingFactor()

 */

 */

void BASE_SCREEN::SetScalingFactor(double aScale )

void BASE_SCREEN::SetScalingFactor(double aScale )

common/bezier_curves.cpp

+0 −12
Original line number Original line Diff line number Diff line
@@ -36,24 +36,12 @@ static void recursive_bezier( int x1, 
/***********************************************************************************/

/***********************************************************************************/









/**

 * Function Bezier2Poly

 * convert a Bezier curve to a polyline

 * @return a std::vector<wxPoint> containing the points of the polyline

 * @param C1, c2, c3, c4 = wxPoints of the Bezier curve

 */

std::vector<wxPoint> Bezier2Poly( wxPoint c1, wxPoint c2, wxPoint c3, wxPoint c4 )

std::vector<wxPoint> Bezier2Poly( wxPoint c1, wxPoint c2, wxPoint c3, wxPoint c4 )

{

{

    return Bezier2Poly( c1.x, c1.y, c2.x, c2.y, c3.x, c3.y, c4.x, c4.y );

    return Bezier2Poly( c1.x, c1.y, c2.x, c2.y, c3.x, c3.y, c4.x, c4.y );

}

}









/**

 * Function Bezier2Poly

 * convert a Bezier curve to a polyline

 * @return a std::vector<wxPoint> containing the points of the polyline

 * @param C1, c2, c3 = wxPoints of the Bezier curve

 */

std::vector<wxPoint> Bezier2Poly( wxPoint c1, wxPoint c2, wxPoint c3 )

std::vector<wxPoint> Bezier2Poly( wxPoint c1, wxPoint c2, wxPoint c3 )

{

{

    return Bezier2Poly( c1.x, c1.y, c2.x, c2.y, c3.x, c3.y );

    return Bezier2Poly( c1.x, c1.y, c2.x, c2.y, c3.x, c3.y );

common/common_plotGERBER_functions.cpp

+3 −3
Original line number Original line Diff line number Diff line
@@ -20,6 +20,7 @@ 
 * Set the plot offset for the current plotting

 * Set the plot offset for the current plotting

 * @param aOffset = plot offset

 * @param aOffset = plot offset

 * @param aScale = coordinate scale (scale coefficient for coordinates)

 * @param aScale = coordinate scale (scale coefficient for coordinates)

 * @param aMirror - Mirror plot if true.

 */

 */

void GERBER_PLOTTER::set_viewport( wxPoint aOffset, double aScale, bool aMirror )

void GERBER_PLOTTER::set_viewport( wxPoint aOffset, double aScale, bool aMirror )

{

{
@@ -298,10 +299,9 @@ void GERBER_PLOTTER::circle( wxPoint aCentre, int aDiameter, FILL_T fill, 
 * @param aCornersCount = number of corners

 * @param aCornersCount = number of corners

 * @param aCoord = buffer of corners coordinates

 * @param aCoord = buffer of corners coordinates

 * @param aFill = plot option (NO_FILL, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR)

 * @param aFill = plot option (NO_FILL, FILLED_SHAPE, FILLED_WITH_BG_BODYCOLOR)

 * @param aCoord = buffer of corners coordinates

 * @param aWidth = Width of the line to plot.

 */

 */

void GERBER_PLOTTER::poly( int aCornersCount, int* aCoord, FILL_T aFill,

void GERBER_PLOTTER::poly( int aCornersCount, int* aCoord, FILL_T aFill, int aWidth )

                           int aWidth )

{

{

    wxASSERT( output_file );

    wxASSERT( output_file );

    wxPoint pos, startpos;

    wxPoint pos, startpos;

common/common_plotHPGL_functions.cpp

+3 −4
Original line number Original line Diff line number Diff line
@@ -170,11 +170,10 @@ void HPGL_PLOTTER::set_dash( bool dashed ) 
 * Function Plot a filled segment (track)

 * Function Plot a filled segment (track)

 * @param start = starting point

 * @param start = starting point

 * @param end = ending point

 * @param end = ending point

 * @param aWidth = segment width (thickness)

 * @param width = segment width (thickness)

 * @param aPlotMode = FILLED, SKETCH ..

 * @param tracemode = FILLED, SKETCH ..

 */

 */

void HPGL_PLOTTER::thick_segment( wxPoint start, wxPoint end, int width,

void HPGL_PLOTTER::thick_segment( wxPoint start, wxPoint end, int width, GRTraceMode tracemode )

                                  GRTraceMode tracemode )

{

{

    wxASSERT( output_file );

    wxASSERT( output_file );

    wxPoint center;

    wxPoint center;