Commit 258cebf1 authored by jean-pierre charras's avatar jean-pierre charras
Browse files

Fix some Doxygen warnings. No new code.

parent 37d73b03
Loading
Loading
Loading
Loading
+1 −1
Original line number Diff line number Diff line
@@ -6,7 +6,7 @@
#endif

#ifndef KICAD_BUILD_VERSION
#define KICAD_BUILD_VERSION "(2010-12-22 BZR 2676)"
#define KICAD_BUILD_VERSION "(2010-12-23 BZR 2682)"
#endif

//#define VERSION_STABILITY      "stable"
+10 −12
Original line number Diff line number Diff line
@@ -170,29 +170,27 @@ void DXF_PLOTTER::pen_to( wxPoint pos, char plume )
void DXF_PLOTTER::set_dash( bool dashed )
{
    /* NOP for now */
    wxASSERT( output_file );
}


/**
 * Function Plot a filled segment (track)
 * @param start = starting point
 * @param end = ending point
 * Function thick_segment
 * Plot a filled segment (track)
 * @param aStart = starting point
 * @param aEnd = ending point
 * @param aWidth = segment width (thickness)
 * @param aPlotMode = FILLED, SKETCH ..
 */
void DXF_PLOTTER::thick_segment( wxPoint start, wxPoint end, int width,
                                 GRTraceMode tracemode )
void DXF_PLOTTER::thick_segment( wxPoint aStart, wxPoint aEnd, int aWidth,
                                 GRTraceMode aPlotMode )
{
    wxASSERT( output_file );

    if( tracemode == FILAIRE )  /* just a line is Ok */
    if( aPlotMode == FILAIRE )  /* just a line is Ok */
    {
        move_to( start );
        finish_to( end );
        move_to( aStart );
        finish_to( aEnd );
    }
    else
        segment_as_oval( start, end, width, tracemode );
        segment_as_oval( aStart, aEnd, aWidth, aPlotMode );
}


+18 −16
Original line number Diff line number Diff line
@@ -157,21 +157,21 @@ static void DrawGraphicTextPline(
    wxDC* aDC,
    EDA_Colors aColor,
    int aWidth,
    bool sketch_mode,
    bool aSketchMode,
    int point_count,
    wxPoint* coord,
    void (* aCallback)(int x0, int y0, int xf, int yf ),
    PLOTTER* plotter )
    PLOTTER* aPlotter )
{
    if( plotter )
    if( aPlotter )
    {
        plotter->move_to( coord[0] );
        aPlotter->move_to( coord[0] );
        for( int ik = 1; ik < point_count; ik++ )
        {
            plotter->line_to( coord[ik] );
            aPlotter->line_to( coord[ik] );
        }

        plotter->pen_finish();
        aPlotter->pen_finish();
    }
    else if( aCallback )
    {
@@ -181,7 +181,7 @@ static void DrawGraphicTextPline(
                       coord[ik + 1].x, coord[ik + 1].y );
        }
    }
    else if( sketch_mode )
    else if( aSketchMode )
    {
        for( int ik = 0; ik < (point_count - 1); ik++ )
            GRCSegm( aClipBox, aDC, coord[ik].x, coord[ik].y,
@@ -218,8 +218,11 @@ static int overbar_position( int size_v, int thickness )
 *      Use a value min(aSize.x, aSize.y) / 5 for a bold text
 *  @param aItalic = true to simulate an italic font
 *  @param aBold = true to use a bold font. Useful only with default width value (aWidth = 0)
 *  @param aCallback() = function called (if non null) to draw each segment.
 *                  used to draw 3D texts or for plotting, NULL for normal drawings
 *  @param aPlotter = a pointer to a PLOTTER instance, when this function is used to plot
 *                  the text. NULL to draw this text.
 */
/****************************************************************************************************/
void DrawGraphicText( WinEDA_DrawPanel* aPanel,
                      wxDC* aDC,
                      const wxPoint& aPos,
@@ -233,8 +236,7 @@ void DrawGraphicText( WinEDA_DrawPanel* aPanel,
                      bool aItalic,
                      bool aBold,
                      void (* aCallback)( int x0, int y0, int xf, int yf ),
                      PLOTTER* plotter )
/****************************************************************************************************/
                      PLOTTER* aPlotter )
{
    int       AsciiCode;
    int       x0, y0;
@@ -353,10 +355,10 @@ void DrawGraphicText( WinEDA_DrawPanel* aPanel,
        RotatePoint( &current_char_pos, aPos, aOrient );
        RotatePoint( &end, aPos, aOrient );

        if( plotter )
        if( aPlotter )
        {
            plotter->move_to( current_char_pos );
            plotter->finish_to( end );
            aPlotter->move_to( current_char_pos );
            aPlotter->finish_to( end );
        }
        else if( aCallback )
        {
@@ -410,7 +412,7 @@ void DrawGraphicText( WinEDA_DrawPanel* aPanel,
                coord[1] = overbar_pos;
                /* Plot the overbar segment */
                DrawGraphicTextPline( clipBox, aDC, aColor, aWidth,
                                      sketch_mode, 2, coord, aCallback, plotter );
                                      sketch_mode, 2, coord, aCallback, aPlotter );
            }
            continue; /* Skip ~ processing */
        }
@@ -450,7 +452,7 @@ void DrawGraphicText( WinEDA_DrawPanel* aPanel,
                        aWidth = 0;
                    DrawGraphicTextPline( clipBox, aDC, aColor, aWidth,
                                          sketch_mode, point_count, coord,
                                          aCallback, plotter );
                                          aCallback, aPlotter );
                }
                point_count = 0;
            }
@@ -492,7 +494,7 @@ void DrawGraphicText( WinEDA_DrawPanel* aPanel,
        coord[1] = overbar_pos;
        /* Plot the overbar segment */
        DrawGraphicTextPline( clipBox, aDC, aColor, aWidth,
                              sketch_mode, 2, coord, aCallback, plotter );
                              sketch_mode, 2, coord, aCallback, aPlotter );
    }
}

+5 −4
Original line number Diff line number Diff line
@@ -859,13 +859,14 @@ static void AddPickedItem( SCH_SCREEN* screen, wxPoint position )
}


/** GetNextPinPosition()
/**
 * Function GetNextPinPosition()
 * calculate position of the "next" pin of the aDrawLibItem component
 * @param aComponent = component to test.
 * @param aPosition = the calculated pin position, according to the component
 * @param aPosition = the actual next pin position in schematic, according to the component
 * orientation and position
 * @param aSearchFirst = if true, search for the first pin
 * @return a pointer to the pin
 * @param aPin = search for the next pin after aPin. aPin = NULL to find the first pin in list
 * @return a pointer to the next pin found or NULL
 */
static LIB_PIN* GetNextPinPosition( SCH_COMPONENT* aComponent,
                                    wxPoint&       aPosition,
+1 −1
Original line number Diff line number Diff line
/**
 * @file sch_item.h
 * @file sch_items.h
 *
 */

Loading