haskal
/
kicad
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

fix function comments, this time ones in *.cpp files until they 

can be deleted later if they exist in the headers, or moved to 
headers if they should exist in the headers.
This commit is contained in:
Dick Hollenbeck 2010-11-12 10:59:16 -06:00
parent 636b2d301e
commit 6c9244e8c3
70 changed files with 179 additions and 134 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
3d-viewer/3d_draw.cpp
View File

@ -1254,7 +1254,7 @@ static void Draw3D_CircleSegment( double startx, double starty, double endx,
/** /**
* Function Pcb3D_GLCanvas::Draw3D_Polygon * Function Draw3D_Polygon
* draw one solid polygon * draw one solid polygon
* @param aCornersList = a std::vector<wxPoint> liste of corners, in physical coordinates * @param aCornersList = a std::vector<wxPoint> liste of corners, in physical coordinates
* @param aZpos = the z position in 3D units * @param aZpos = the z position in 3D units

3
common/basicframe.cpp
View File

@ -83,7 +83,8 @@ void WinEDA_BasicFrame::ReCreateMenuBar()
} }
/** Virtual function SetLanguage /**
* Function SetLanguage (virtual)
* called on a language menu selection * called on a language menu selection
* when using a derived function, do not forget to call this one * when using a derived function, do not forget to call this one
*/ */

2
common/build_version.cpp
View File

@ -14,7 +14,7 @@
/** /**
* Function GetBuildVersion() * Function GetBuildVersion
* Return the build date and version * Return the build date and version
*/ */
wxString GetBuildVersion() wxString GetBuildVersion()

2
common/class_marker_base.cpp
View File

@ -174,7 +174,7 @@ void MARKER_BASE::DrawMarker( WinEDA_DrawPanel* aPanel, wxDC* aDC, int aDrawMode
/** /**
* Function DisplayMarkerInfo() * Function DisplayMarkerInfo
* Displays the full info of this marker, within an HTML window * Displays the full info of this marker, within an HTML window
*/ */
void MARKER_BASE::DisplayMarkerInfo( WinEDA_DrawFrame* aFrame ) void MARKER_BASE::DisplayMarkerInfo( WinEDA_DrawFrame* aFrame )

2
common/class_undoredo_container.cpp
View File

@ -358,7 +358,7 @@ void PICKED_ITEMS_LIST::CopyList( const PICKED_ITEMS_LIST& aSource )
} }
/** /**
* Function ReversePickersListOrder() * Function ReversePickersListOrder
* reverses the order of pickers stored in this list * reverses the order of pickers stored in this list
* Useful when pop a list from Undo to Redo (and vice-versa) * Useful when pop a list from Undo to Redo (and vice-versa)
* because sometimes undo (or redo) a command needs to keep the * because sometimes undo (or redo) a command needs to keep the

5
common/drawframe.cpp
View File

@ -184,7 +184,8 @@ void WinEDA_DrawFrame::ToolOnRightClick( wxCommandEvent& event )
{ {
} }
/** Virtual function PrintPage /**
* Function PrintPage (virtual)
* used to print a page * used to print a page
* this basic function must be derived to be used for printing * this basic function must be derived to be used for printing
* because WinEDA_DrawFrame does not know how to print a page * because WinEDA_DrawFrame does not know how to print a page
@ -593,7 +594,7 @@ double RoundTo0( double x, double precision )
} }
/** /**
* Function UpdateStatusBar() * Function UpdateStatusBar
* Displays in the bottom of the main window a stust: * Displays in the bottom of the main window a stust:
* - Absolute Cursor coordinates * - Absolute Cursor coordinates
* - Relative Cursor coordinates (relative to the last coordinate stored * - Relative Cursor coordinates (relative to the last coordinate stored

4
common/drawpanel.cpp
View File

@ -338,7 +338,7 @@ wxPoint WinEDA_DrawPanel::CursorScreenPosition()
/** /**
* Function GetScreenCenterRealPosition() * Function GetScreenCenterRealPosition
* @return position (in internal units) of the current area center showed * @return position (in internal units) of the current area center showed
* on screen * on screen
*/ */
@ -513,7 +513,7 @@ void WinEDA_DrawPanel::OnSize( wxSizeEvent& event )
/** /**
* Function SetBoundaryBox() * Function SetBoundaryBox
* Set the clip box to the current displayed rectangle dimensions. * Set the clip box to the current displayed rectangle dimensions.
* *
* When using wxDC for scaling, the clip box coordinates are in drawing (logical) * When using wxDC for scaling, the clip box coordinates are in drawing (logical)

2
common/drawtxt.cpp
View File

@ -100,7 +100,7 @@ int NegableTextLength( const wxString& aText )
} }
/* Function GetHersheyShapeDescription() /* Function GetHersheyShapeDescription
* return a pointer to the shape corresponding to unicode value AsciiCode * return a pointer to the shape corresponding to unicode value AsciiCode
* Note we use the same font for Bold and Normal texts * Note we use the same font for Bold and Normal texts
* because kicad handles a variable pen size to do that * because kicad handles a variable pen size to do that

4
common/projet_config.cpp
View File

@ -226,7 +226,7 @@ void WinEDA_App::WriteProjectConfig( const wxString& fileName,
/** /**
* Function SaveCurrentSetupValues() * Function SaveCurrentSetupValues
* Save the current setup values in m_EDA_Config * Save the current setup values in m_EDA_Config
* saved parameters are parameters that have the .m_Setup member set to true * saved parameters are parameters that have the .m_Setup member set to true
* @param aList = array of PARAM_CFG_BASE pointers * @param aList = array of PARAM_CFG_BASE pointers
@ -393,7 +393,7 @@ bool WinEDA_App::ReadProjectConfig( const wxString& local_config_filename,
/** /**
* Function ReadCurrentSetupValues() * Function ReadCurrentSetupValues
* Raed the current setup values previously saved, from m_EDA_Config * Raed the current setup values previously saved, from m_EDA_Config
* saved parameters are parameters that have the .m_Setup member set to true * saved parameters are parameters that have the .m_Setup member set to true
* @param aList = array of PARAM_CFG_BASE pointers * @param aList = array of PARAM_CFG_BASE pointers

2
eeschema/annotate.cpp
View File

@ -349,7 +349,7 @@ void AnnotateComponents( WinEDA_SchematicFrame* parent,
/** /**
* Function AddComponentsInSheetToList() * Function AddComponentsInSheetToList
* Add a OBJ_CMP_TO_LIST object in aComponentsList for each component found * Add a OBJ_CMP_TO_LIST object in aComponentsList for each component found
* in sheet * in sheet
* @param aComponentsList = a std::vector list to fill * @param aComponentsList = a std::vector list to fill

6
eeschema/lib_pin.cpp
View File

@ -1570,7 +1570,7 @@ wxString LIB_PIN::ReturnPinStringNum( long aPinNum )
/** /**
* Function LIB_PIN::SetPinNumFromString() * Function SetPinNumFromString
* fill the buffer with pin num as a wxString * fill the buffer with pin num as a wxString
* Pin num is coded as a long * Pin num is coded as a long
* Used to print/draw the pin num * Used to print/draw the pin num
@ -1696,7 +1696,7 @@ void LIB_PIN::DoPlot( PLOTTER* plotter, const wxPoint& offset, bool fill,
/** /**
* Function LIB_PIN::DisplayInfo * Function DisplayInfo
* Displays info (pin num and name, orientation ... * Displays info (pin num and name, orientation ...
* on the Info window * on the Info window
*/ */
@ -1737,7 +1737,7 @@ void LIB_PIN::DisplayInfo( WinEDA_DrawFrame* frame )
/** /**
* Function LIB_PIN::GetBoundingBox * Function GetBoundingBox
* @return the boundary box for this, in schematic coordinates * @return the boundary box for this, in schematic coordinates
*/ */
EDA_Rect LIB_PIN::GetBoundingBox() EDA_Rect LIB_PIN::GetBoundingBox()

2
eeschema/libedit.cpp
View File

@ -53,7 +53,7 @@ void WinEDA_LibeditFrame::SelectActiveLibrary()
/** /**
* Function LoadOneLibraryPart() * Function LoadOneLibraryPart
* load a library component from the current selected library * load a library component from the current selected library
* Prompt user for component name * Prompt user for component name
* If there is no current selected library, * If there is no current selected library,

3
eeschema/libedit_plot_component.cpp
View File

@ -124,7 +124,8 @@ void WinEDA_LibeditFrame::CreatePNGorJPEGFile( const wxString& aFileName, bool a
image.Destroy(); image.Destroy();
} }
/** Virtual function PrintPage /**
* Function PrintPage (virtual)
* used to print a page. * used to print a page.
* @param aDC = wxDC given by the calling print function * @param aDC = wxDC given by the calling print function
* @param aPrint_Sheet_Ref = true to print page references * @param aPrint_Sheet_Ref = true to print page references

4
eeschema/libeditframe.h
View File

@ -110,7 +110,7 @@ public:
void SaveSettings(); void SaveSettings();
/** /**
* Function CloseWindow() * Function CloseWindow
* triggers the wxCloseEvent, which is handled by the function given * triggers the wxCloseEvent, which is handled by the function given
* to EVT_CLOSE() macro: * to EVT_CLOSE() macro:
* <p> * <p>
@ -123,7 +123,7 @@ public:
} }
/** /**
* Function OnModify() * Function OnModify
* Must be called after a schematic change * Must be called after a schematic change
* in order to set the "modify" flag of the current screen * in order to set the "modify" flag of the current screen
*/ */

3
eeschema/netlist.h
View File

@ -140,7 +140,8 @@ extern bool g_OptNetListUseNames; /* TRUE to use names rather than
/* Prototypes: */ /* Prototypes: */
void FreeNetObjectsList( std::vector <NETLIST_OBJECT*>& aNetObjectslist ); void FreeNetObjectsList( std::vector <NETLIST_OBJECT*>& aNetObjectslist );
/** Function ReturnUserNetlistTypeName /**
* Function ReturnUserNetlistTypeName
* to retrieve user netlist type names * to retrieve user netlist type names
* @param first = true: return first name of the list, false = return next * @param first = true: return first name of the list, false = return next
* @return a wxString : name of the type netlist or empty string * @return a wxString : name of the type netlist or empty string

3
eeschema/protos.h
View File

@ -63,7 +63,8 @@ bool LibItemInBox( int x1, int y1, int x2, int y2, SCH_COMPONENT* Draw
void DeleteStruct( WinEDA_DrawPanel* panel, wxDC* DC, SCH_ITEM* DrawStruct ); void DeleteStruct( WinEDA_DrawPanel* panel, wxDC* DC, SCH_ITEM* DrawStruct );
// operations_on_item_lists.cpp // operations_on_item_lists.cpp
/** function DuplicateStruct /**
* Function DuplicateStruct
* Routine to create a new copy of given struct. * Routine to create a new copy of given struct.
* @param aDrawStruct = the SCH_ITEM to duplicate * @param aDrawStruct = the SCH_ITEM to duplicate
* @param aClone (defualt = true) * @param aClone (defualt = true)

2
eeschema/sch_component.cpp
View File

@ -857,7 +857,7 @@ void SCH_COMPONENT::SetOrientation( int aOrientation )
/** /**
* Function GetOrientation() * Function GetOrientation
* Used to display component orientation (in dialog editor or info) * Used to display component orientation (in dialog editor or info)
* @return the orientation and mirror * @return the orientation and mirror
* Note: Because there are different ways to have a given orientation/mirror, * Note: Because there are different ways to have a given orientation/mirror,

2
eeschema/sch_component.h
View File

@ -168,7 +168,7 @@ public:
void SetOrientation( int aOrientation ); void SetOrientation( int aOrientation );
/** /**
* Function GetOrientation() * Function GetOrientation
* Used to display component orientation (in dialog editor or info) * Used to display component orientation (in dialog editor or info)
* @return the orientation and mirror * @return the orientation and mirror
* Note: Because there are different ways to have a given orientation/mirror, * Note: Because there are different ways to have a given orientation/mirror,

2
eeschema/sch_field.cpp
View File

@ -226,7 +226,7 @@ void SCH_FIELD::SwapData( SCH_FIELD* copyitem )
/** /**
* Function GetBoundaryBox() * Function GetBoundaryBox
* @return an EDA_Rect contains the real (user coordinates) boundary box for * @return an EDA_Rect contains the real (user coordinates) boundary box for
* a text field, * a text field,
* according to the component position, rotation, mirror ... * according to the component position, rotation, mirror ...

2
eeschema/sch_sheet_path.h
View File

@ -272,7 +272,7 @@ public:
} }
/** /**
* Function GetCount() * Function GetCount
* @return the number of sheets in list: * @return the number of sheets in list:
* usually the number of sheets found in the whole hierarchy * usually the number of sheets found in the whole hierarchy
*/ */

3
eeschema/sch_sheet_pin.cpp
View File

@ -412,7 +412,8 @@ void SCH_SHEET_PIN::Rotate( wxPoint rotationPoint )
} }
/** Virtual Function SCH_SHEET_PIN::CreateGraphicShape /**
* Function CreateGraphicShape (virtual)
* calculates the graphic shape (a polygon) associated to the text * calculates the graphic shape (a polygon) associated to the text
* @param aCorner_list = a buffer to fill with polygon corners coordinates * @param aCorner_list = a buffer to fill with polygon corners coordinates
* @param aPos = Position of the shape * @param aPos = Position of the shape

2
eeschema/sch_text.cpp
View File

@ -856,7 +856,7 @@ bool SCH_LABEL::Load( LINE_READER& aLine, wxString& aErrorMsg )
/** /**
* Function SCH_LABEL::Draw * Function Draw
* a label is drawn like a text. So just call SCH_TEXT::Draw * a label is drawn like a text. So just call SCH_TEXT::Draw
*/ */
void SCH_LABEL::Draw( WinEDA_DrawPanel* panel, wxDC* DC, const wxPoint& offset, void SCH_LABEL::Draw( WinEDA_DrawPanel* panel, wxDC* DC, const wxPoint& offset,

2
eeschema/schematic_undo_redo.cpp
View File

@ -345,7 +345,7 @@ void WinEDA_SchematicFrame::SaveCopyInUndoList( PICKED_ITEMS_LIST& aItemsList,
/** /**
* Function PutDataInPreviousState() * Function PutDataInPreviousState
* Used in undo or redo command. * Used in undo or redo command.
* Put data pointed by List in the previous state, i.e. the state memorized * Put data pointed by List in the previous state, i.e. the state memorized
* by List * by List

2
eeschema/schframe.cpp
View File

@ -465,7 +465,7 @@ wxString WinEDA_SchematicFrame::GetUniqueFilenameForCurrentSheet()
} }
/** /**
* Function OnModify() * Function OnModify
* Must be called after a schematic change * Must be called after a schematic change
* in order to set the "modify" flag of the current screen * in order to set the "modify" flag of the current screen
* and update the date in frame reference * and update the date in frame reference

2
gerbview/toolbars_gerber.cpp
View File

@ -213,7 +213,7 @@ void WinEDA_GerberFrame::ReCreateOptToolbar( void )
/** /**
* Function SetToolbars() * Function SetToolbars
* Set the tools state for the toolbars, according to display options * Set the tools state for the toolbars, according to display options
*/ */
void WinEDA_GerberFrame::SetToolbars() void WinEDA_GerberFrame::SetToolbars()

4
include/appl_wxstruct.h
View File

@ -134,7 +134,7 @@ public: WinEDA_App();
PARAM_CFG_ARRAY& params ); PARAM_CFG_ARRAY& params );
/** /**
* Function SaveCurrentSetupValues() * Function SaveCurrentSetupValues
* Save the current setup values in m_EDA_Config * Save the current setup values in m_EDA_Config
* saved parameters are parameters that have the .m_Setup member set to * saved parameters are parameters that have the .m_Setup member set to
* true * true
@ -144,7 +144,7 @@ public: WinEDA_App();
void SaveCurrentSetupValues( PARAM_CFG_ARRAY& List ); void SaveCurrentSetupValues( PARAM_CFG_ARRAY& List );
/** /**
* Function ReadCurrentSetupValues() * Function ReadCurrentSetupValues
* Raed the current setup values previously saved, from m_EDA_Config * Raed the current setup values previously saved, from m_EDA_Config
* saved parameters are parameters that have the .m_Setup member set to * saved parameters are parameters that have the .m_Setup member set to
* true * true

3
include/build_version.h
View File

@ -3,7 +3,8 @@
#ifndef KICAD_BUILD_VERSION_H #ifndef KICAD_BUILD_VERSION_H
#define KICAD_BUILD_VERSION_H #define KICAD_BUILD_VERSION_H
/** Function GetBuildVersion() /**
* Function GetBuildVersion
* Return the build date and version * Return the build date and version
*/ */
wxString GetBuildVersion(); wxString GetBuildVersion();

2
include/class_marker_base.h
View File

@ -167,7 +167,7 @@ public:
/** /**
* Function DisplayMarkerInfo() * Function DisplayMarkerInfo
* Displays the full info of this marker, in a HTML window * Displays the full info of this marker, in a HTML window
*/ */
void DisplayMarkerInfo(WinEDA_DrawFrame * aFrame); void DisplayMarkerInfo(WinEDA_DrawFrame * aFrame);

4
include/class_undoredo_container.h
View File

@ -133,7 +133,7 @@ public:
void ClearListAndDeleteItems(); void ClearListAndDeleteItems();
/** /**
* Function GetCount() * Function GetCount
* @return the count of pickers stored in this list * @return the count of pickers stored in this list
*/ */
unsigned GetCount() const unsigned GetCount() const
@ -142,7 +142,7 @@ public:
} }
/** /**
* Function ReversePickersListOrder() * Function ReversePickersListOrder
* reverses the order of pickers stored in this list * reverses the order of pickers stored in this list
* Useful when pop a list from Undo to Redo (and vice-versa) * Useful when pop a list from Undo to Redo (and vice-versa)
* because sometimes undo (or redo) a command needs to keep the * because sometimes undo (or redo) a command needs to keep the

9
include/common.h
View File

@ -196,7 +196,8 @@ extern BASE_SCREEN* ActiveScreen;
/* COMMON.CPP */ /* COMMON.CPP */
/** function SetLocaleTo_C_standard /**
* Function SetLocaleTo_C_standard
* because kicad is internationalized, switch internalization to "C" standard * because kicad is internationalized, switch internalization to "C" standard
* i.e. uses the . (dot) as separator in print/read float numbers * i.e. uses the . (dot) as separator in print/read float numbers
* (some countries (France, Germany ..) use , (comma) as separator) * (some countries (France, Germany ..) use , (comma) as separator)
@ -209,7 +210,8 @@ extern BASE_SCREEN* ActiveScreen;
*/ */
void SetLocaleTo_C_standard( void ); void SetLocaleTo_C_standard( void );
/** function SetLocaleTo_Default /**
* Function SetLocaleTo_Default
* because kicad is internationalized, switch internalization to default * because kicad is internationalized, switch internalization to default
* to use the default separator in print/read float numbers * to use the default separator in print/read float numbers
* (. (dot) but some countries (France, Germany ..) use , (comma) as * (. (dot) but some countries (France, Germany ..) use , (comma) as
@ -331,7 +333,8 @@ wxString GetAbbreviatedUnitsLabel( UserUnitType aUnit = g_UserUnit );
int ReturnValueFromString( UserUnitType aUnit, const wxString& TextValue, int ReturnValueFromString( UserUnitType aUnit, const wxString& TextValue,
int Internal_Unit ); int Internal_Unit );
/** Function ReturnStringFromValue /**
* Function ReturnStringFromValue
* Return the string from Value, according to units (inch, mm ...) for display, * Return the string from Value, according to units (inch, mm ...) for display,
* and the initial unit for value * and the initial unit for value
* @param aUnit = display units (INCHES, MILLIMETRE ..) * @param aUnit = display units (INCHES, MILLIMETRE ..)

15
include/drawtxt.h
View File

@ -12,7 +12,8 @@
class WinEDA_DrawPanel; class WinEDA_DrawPanel;
class PLOTTER; class PLOTTER;
/** Function Clamp_Text_PenSize /**
* Function Clamp_Text_PenSize
*As a rule, pen width should not be >1/4em, otherwise the character *As a rule, pen width should not be >1/4em, otherwise the character
* will be cluttered up in its own fatness * will be cluttered up in its own fatness
* The pen width max is aSize/4 for bold texts, and aSize/6 for normal texts * The pen width max is aSize/4 for bold texts, and aSize/6 for normal texts
@ -26,23 +27,27 @@ class PLOTTER;
int Clamp_Text_PenSize( int aPenSize, int aSize, bool aBold = true ); int Clamp_Text_PenSize( int aPenSize, int aSize, bool aBold = true );
int Clamp_Text_PenSize( int aPenSize, wxSize aSize, bool aBold = true ); int Clamp_Text_PenSize( int aPenSize, wxSize aSize, bool aBold = true );
/** Function GetPensizeForBold /**
* Function GetPensizeForBold
* @return the "best" value for a pen size to draw/plot a bold text * @return the "best" value for a pen size to draw/plot a bold text
* @param aTextSize = the char size (height or width) * @param aTextSize = the char size (height or width)
*/ */
int GetPenSizeForBold( int aTextSize ); int GetPenSizeForBold( int aTextSize );
/** Function ReturnGraphicTextWidth /**
* Function ReturnGraphicTextWidth
* @return the X size of the graphic text * @return the X size of the graphic text
* the full X size is ReturnGraphicTextWidth + the thickness of graphic lines * the full X size is ReturnGraphicTextWidth + the thickness of graphic lines
*/ */
int ReturnGraphicTextWidth( const wxString& aText, int size_h, bool italic, bool bold ); int ReturnGraphicTextWidth( const wxString& aText, int size_h, bool italic, bool bold );
/** Function NegableTextLength /**
* Function NegableTextLength
* Return the text length of a negable string, excluding the ~ markers */ * Return the text length of a negable string, excluding the ~ markers */
int NegableTextLength( const wxString& aText ); int NegableTextLength( const wxString& aText );
/** Function DrawGraphicText /**
* Function DrawGraphicText
* Draw a graphic text (like module texts) * Draw a graphic text (like module texts)
* @param aPanel = the current DrawPanel. NULL if draw within a 3D GL Canvas * @param aPanel = the current DrawPanel. NULL if draw within a 3D GL Canvas
* @param aDC = the current Device Context. NULL if draw within a 3D GL Canvas * @param aDC = the current Device Context. NULL if draw within a 3D GL Canvas

3
include/eda_doc.h
View File

@ -17,7 +17,8 @@
int KeyWordOk( const wxString& KeyList, int KeyWordOk( const wxString& KeyList,
const wxString& Database ); const wxString& Database );
/** Function GetAssociatedDocument /**
* Function GetAssociatedDocument
* open a document (file) with the suitable browser * open a document (file) with the suitable browser
* @param aFrame = main frame * @param aFrame = main frame
* @param aDocName = filename of file to open (Full filename or short filename) * @param aDocName = filename of file to open (Full filename or short filename)

3
include/gestfich.h
View File

@ -16,7 +16,8 @@
class WinEDAListBox; class WinEDAListBox;
/** Function OpenPDF /**
* Function OpenPDF
* run the PDF viewer and display a PDF file * run the PDF viewer and display a PDF file
* @param file = PDF file to open * @param file = PDF file to open
* @return true is success, false if no PDF viewer found * @return true is success, false if no PDF viewer found

9
include/gr_basic.h
View File

@ -56,12 +56,14 @@ void GRResetPenAndBrush( wxDC* DC );
void GRSetColorPen( wxDC* DC, int Color, int width = 1, wxPenStyle stype = wxPENSTYLE_SOLID ); void GRSetColorPen( wxDC* DC, int Color, int width = 1, wxPenStyle stype = wxPENSTYLE_SOLID );
void GRSetBrush( wxDC* DC, int Color, int fill = 0 ); void GRSetBrush( wxDC* DC, int Color, int fill = 0 );
/** function GRForceBlackPen /**
* Function GRForceBlackPen
* @param flagforce True to force a black pen whenever the asked color * @param flagforce True to force a black pen whenever the asked color
*/ */
void GRForceBlackPen( bool flagforce ); void GRForceBlackPen( bool flagforce );
/** function GetGRForceBlackPenState /**
* Function GetGRForceBlackPenState
* @return ForceBlackPen (True if a black pen was forced) * @return ForceBlackPen (True if a black pen was forced)
*/ */
bool GetGRForceBlackPenState( void ); bool GetGRForceBlackPenState( void );
@ -202,7 +204,8 @@ void GRRectPs( EDA_Rect* aClipBox, wxDC* aDC,const EDA_Rect& aRect,
void GRSFilledRect( EDA_Rect* ClipBox, wxDC* DC, int x1, int y1, void GRSFilledRect( EDA_Rect* ClipBox, wxDC* DC, int x1, int y1,
int x2, int y2, int width, int Color, int BgColor ); int x2, int y2, int width, int Color, int BgColor );
/** Function GRLineArray /**
* Function GRLineArray
* draws an array of lines (not a polygon). * draws an array of lines (not a polygon).
* @param aClipBox = the clip box * @param aClipBox = the clip box
* @param aDC = the device context into which drawing should occur. * @param aDC = the device context into which drawing should occur.

25
include/hotkeys_basic.h
View File

@ -60,7 +60,8 @@ extern wxString g_ModuleEditSectionTag;
void AddHotkeyConfigMenu( wxMenu* menu ); void AddHotkeyConfigMenu( wxMenu* menu );
void HandleHotkeyConfigMenuSelection( WinEDA_DrawFrame* frame, int id ); void HandleHotkeyConfigMenuSelection( WinEDA_DrawFrame* frame, int id );
/** function ReturnKeyNameFromKeyCode /**
* Function ReturnKeyNameFromKeyCode
* return the key name from the key code * return the key name from the key code
* Only some wxWidgets key values are handled for function key ( see * Only some wxWidgets key values are handled for function key ( see
* s_Hotkey_Name_List[] ) * s_Hotkey_Name_List[] )
@ -70,7 +71,8 @@ void HandleHotkeyConfigMenuSelection( WinEDA_DrawFrame* frame, int id
*/ */
wxString ReturnKeyNameFromKeyCode( int aKeycode, bool * aIsFound = NULL ); wxString ReturnKeyNameFromKeyCode( int aKeycode, bool * aIsFound = NULL );
/** function ReturnKeyNameFromCommandId /**
* Function ReturnKeyNameFromCommandId
* return the key name from the Command id value ( m_Idcommand member value) * return the key name from the Command id value ( m_Idcommand member value)
* @param aList = pointer to a Ki_HotkeyInfo list of commands * @param aList = pointer to a Ki_HotkeyInfo list of commands
* @param aCommandId = Command Id value * @param aCommandId = Command Id value
@ -78,7 +80,8 @@ wxString ReturnKeyNameFromKeyCode( int aKeycode, bool * aIsFound = NULL )
*/ */
wxString ReturnKeyNameFromCommandId( Ki_HotkeyInfo** aList, int aCommandId ); wxString ReturnKeyNameFromCommandId( Ki_HotkeyInfo** aList, int aCommandId );
/** function ReturnKeyCodeFromKeyName /**
* Function ReturnKeyCodeFromKeyName
* return the key code from its key name * return the key code from its key name
* Only some wxWidgets key values are handled for function key * Only some wxWidgets key values are handled for function key
* @param keyname = wxString key name to find in s_Hotkey_Name_List[], * @param keyname = wxString key name to find in s_Hotkey_Name_List[],
@ -87,7 +90,8 @@ wxString ReturnKeyNameFromCommandId( Ki_HotkeyInfo** aList, int aCommandI
*/ */
int ReturnKeyCodeFromKeyName( const wxString& keyname ); int ReturnKeyCodeFromKeyName( const wxString& keyname );
/** function AddHotkeyName /**
* Function AddHotkeyName
* Add the key name from the Command id value ( m_Idcommand member value) * Add the key name from the Command id value ( m_Idcommand member value)
* @param aText = a wxString. returns aText + key name * @param aText = a wxString. returns aText + key name
* @param aList = pointer to a Ki_HotkeyInfo list of commands * @param aList = pointer to a Ki_HotkeyInfo list of commands
@ -100,7 +104,8 @@ wxString AddHotkeyName( const wxString& aText, Ki_HotkeyInfo** aList,
int aCommandId, int aCommandId,
bool aIsShortCut = true); bool aIsShortCut = true);
/** function AddHotkeyName /**
* Function AddHotkeyName
* Add the key name from the Command id value ( m_Idcommand member value) * Add the key name from the Command id value ( m_Idcommand member value)
* @param aText = a wxString. returns aText + key name * @param aText = a wxString. returns aText + key name
* @param aList = pointer to a Ki_HotkeyInfoSectionDescriptor DescrList of commands * @param aList = pointer to a Ki_HotkeyInfoSectionDescriptor DescrList of commands
@ -114,7 +119,8 @@ wxString AddHotkeyName( const wxString& aText,
int aCommandId, int aCommandId,
bool aIsShortCut = true); bool aIsShortCut = true);
/** function DisplayHotkeyList /**
* Function DisplayHotkeyList
* Displays the current hotkey list * Displays the current hotkey list
* @param aFrame = current active frame * @param aFrame = current active frame
* @param aList = pointer to a Ki_HotkeyInfoSectionDescriptor list * @param aList = pointer to a Ki_HotkeyInfoSectionDescriptor list
@ -124,7 +130,8 @@ wxString AddHotkeyName( const wxString& aText,
void DisplayHotkeyList( WinEDA_DrawFrame* aFrame, void DisplayHotkeyList( WinEDA_DrawFrame* aFrame,
struct Ki_HotkeyInfoSectionDescriptor* aList ); struct Ki_HotkeyInfoSectionDescriptor* aList );
/** function GetDescriptorFromHotkey /**
* Function GetDescriptorFromHotkey
* Return a Ki_HotkeyInfo * pointer fron a key code for OnHotKey() function * Return a Ki_HotkeyInfo * pointer fron a key code for OnHotKey() function
* @param aKey = key code (ascii value, or wxWidgets value for function keys * @param aKey = key code (ascii value, or wxWidgets value for function keys
* @param aList = pointer to a Ki_HotkeyInfo list of commands * @param aList = pointer to a Ki_HotkeyInfo list of commands
@ -156,8 +163,8 @@ enum common_hotkey_id_commnand {
HK_ZOOM_REDRAW, HK_ZOOM_REDRAW,
HK_ZOOM_CENTER, HK_ZOOM_CENTER,
HK_ZOOM_AUTO, HK_ZOOM_AUTO,
HK_UNDO, HK_UNDO,
HK_REDO, HK_REDO,
HK_COMMON_END HK_COMMON_END
}; };

2
include/plot_common.h
View File

@ -46,7 +46,7 @@ public:
/** /**
* Function GetPlotterType() * Function GetPlotterType
* @return the format of the plot file * @return the format of the plot file
*/ */
PlotFormat GetPlotterType() PlotFormat GetPlotterType()

3
include/trigo.h
View File

@ -53,7 +53,8 @@ bool HitTestPoints(wxPoint pointA, wxPoint pointB, double threshold);
int CrossProduct(wxPoint vectorA, wxPoint vectorB); int CrossProduct(wxPoint vectorA, wxPoint vectorB);
/** Function TestSegmentHit /**
* Function TestSegmentHit
* test for hit on line segment * test for hit on line segment
* i.e. cursor within a given distance from segment * i.e. cursor within a given distance from segment
* @param aRefPoint = cursor (point to test) coords * @param aRefPoint = cursor (point to test) coords

2
include/wxBasePcbFrame.h
View File

@ -216,7 +216,7 @@ public:
MODULE* GetModuleByName(); MODULE* GetModuleByName();
/** /**
* Function OnModify() * Function OnModify
* Virtual * Virtual
* Must be called after a change * Must be called after a change
* in order to set the "modify" flag of the current screen * in order to set the "modify" flag of the current screen

4
include/wxEeschemaStruct.h
View File

@ -180,7 +180,7 @@ public:
/** /**
* Function OnModify() * Function OnModify
* Must be called after a schematic change * Must be called after a schematic change
* in order to set the "modify" flag of the current screen * in order to set the "modify" flag of the current screen
* and update the date in frame reference * and update the date in frame reference
@ -548,7 +548,7 @@ public:
private: private:
/** /**
* Function PutDataInPreviousState() * Function PutDataInPreviousState
* Used in undo or redo command. * Used in undo or redo command.
* Put data pointed by List in the previous state, i.e. the state * Put data pointed by List in the previous state, i.e. the state
* memorized by List * memorized by List

8
include/wxPcbStruct.h
View File

@ -437,7 +437,7 @@ public:
wxPoint( 0, 0 ) ); wxPoint( 0, 0 ) );
/** /**
* Function PutDataInPreviousState() * Function PutDataInPreviousState
* Used in undo or redo command. * Used in undo or redo command.
* Put data pointed by List in the previous state, i.e. the state memorized * Put data pointed by List in the previous state, i.e. the state memorized
* by List * by List
@ -582,7 +582,7 @@ public:
// BOARD handling // BOARD handling
/** /**
* Function Clear_Pcb() * Function Clear_Pcb
* delete all and reinitialize the current board * delete all and reinitialize the current board
* @param aQuery = true to prompt user for confirmation, false to * @param aQuery = true to prompt user for confirmation, false to
* initialize silently * initialize silently
@ -887,7 +887,7 @@ public:
bool End_Zone( wxDC* DC ); bool End_Zone( wxDC* DC );
/** /**
* Function Fill_Zone() * Function Fill_Zone
* Calculate the zone filling for the outline zone_container * Calculate the zone filling for the outline zone_container
* The zone outline is a frontier, and can be complex (with holes) * The zone outline is a frontier, and can be complex (with holes)
* The filling starts from starting points like pads, tracks. * The filling starts from starting points like pads, tracks.
@ -899,7 +899,7 @@ public:
int Fill_Zone( ZONE_CONTAINER* zone_container, bool verbose = TRUE ); int Fill_Zone( ZONE_CONTAINER* zone_container, bool verbose = TRUE );
/** /**
* Function Fill_All_Zones() * Function Fill_All_Zones
* Fill all zones on the board * Fill all zones on the board
* The old fillings are removed * The old fillings are removed
* @param verbose = true to show error messages * @param verbose = true to show error messages

2
pcbnew/basepcbframe.cpp
View File

@ -433,7 +433,7 @@ void WinEDA_BasePcbFrame::SaveSettings()
/** /**
* Function OnModify() * Function OnModify
* Must be called after a schematic change * Must be called after a schematic change
* in order to set the "modify" flag of the current screen * in order to set the "modify" flag of the current screen
* and update the date in frame reference * and update the date in frame reference

10
pcbnew/board_items_to_polygon_shape_transform.cpp
View File

@ -80,7 +80,7 @@ void TransformArcToPolygon( std::vector <CPolyPt>& aCornerBuffer,
/** /**
* Function TEXTE_PCB::TransformShapeWithClearanceToPolygon * Function TransformShapeWithClearanceToPolygon
* Convert the track shape to a closed polygon * Convert the track shape to a closed polygon
* Used in filling zones calculations * Used in filling zones calculations
* Circles and arcs are approximated by segments * Circles and arcs are approximated by segments
@ -127,7 +127,7 @@ void TEXTE_PCB::TransformShapeWithClearanceToPolygon(
/** /**
* Function DRAWSEGMENT::TransformShapeWithClearanceToPolygon * Function TransformShapeWithClearanceToPolygon
* Convert the track shape to a closed polygon * Convert the track shape to a closed polygon
* Used in filling zones calculations * Used in filling zones calculations
* Circles and arcs are approximated by segments * Circles and arcs are approximated by segments
@ -169,7 +169,7 @@ void DRAWSEGMENT::TransformShapeWithClearanceToPolygon(
} }
/** /**
* Function EDGE_MODULE::TransformShapeWithClearanceToPolygon * Function TransformShapeWithClearanceToPolygon
* Convert the track shape to a closed polygon * Convert the track shape to a closed polygon
* Used in filling zones calculations * Used in filling zones calculations
* Circles and arcs are approximated by segments * Circles and arcs are approximated by segments
@ -215,7 +215,7 @@ void EDGE_MODULE::TransformShapeWithClearanceToPolygon(
/** /**
* Function TRACK::TransformShapeWithClearanceToPolygon * Function TransformShapeWithClearanceToPolygon
* Convert the track shape to a closed polygon * Convert the track shape to a closed polygon
* Used in filling zones calculations * Used in filling zones calculations
* Circles (vias) and arcs (ends of tracks) are approximated by segments * Circles (vias) and arcs (ends of tracks) are approximated by segments
@ -351,7 +351,7 @@ void TransformRoundedEndsSegmentToPolygon( std::vector <CPolyPt>& aCornerBuffer,
/** /**
* Function D_PAD::TransformShapeWithClearanceToPolygon * Function TransformShapeWithClearanceToPolygon
* Convert the pad shape to a closed polygon * Convert the pad shape to a closed polygon
* Used in filling zones calculations * Used in filling zones calculations
* Circles and arcs are approximated by segments * Circles and arcs are approximated by segments

2
pcbnew/board_undo_redo.cpp
View File

@ -474,7 +474,7 @@ void WinEDA_PcbFrame::SaveCopyInUndoList( PICKED_ITEMS_LIST& aItemsList,
/** /**
* Function PutDataInPreviousState() * Function PutDataInPreviousState
* Used in undo or redo command. * Used in undo or redo command.
* Put data pointed by List in the previous state, i.e. the state memorised by List * Put data pointed by List in the previous state, i.e. the state memorised by List
* @param aList = a PICKED_ITEMS_LIST pointer to the list of items to undo/redo * @param aList = a PICKED_ITEMS_LIST pointer to the list of items to undo/redo

2
pcbnew/class_board.cpp
View File

@ -742,7 +742,7 @@ unsigned BOARD::GetNodesCount()
/** /**
* Function ComputeBoundaryBox() * Function ComputeBoundaryBox
* Calculate the bounding box of the board * Calculate the bounding box of the board
* This box contains pcb edges, pads , vias and tracks * This box contains pcb edges, pads , vias and tracks
* Update m_PcbBox member * Update m_PcbBox member

4
pcbnew/class_module.h
View File

@ -110,13 +110,13 @@ public:
/** /**
* Function Set_Rectangle_Encadrement() * Function Set_Rectangle_Encadrement
* calculates the bounding box for orient 0 at origin = module anchor) * calculates the bounding box for orient 0 at origin = module anchor)
*/ */
void Set_Rectangle_Encadrement(); void Set_Rectangle_Encadrement();
/** /**
* Function SetRectangleExinscrit() * Function SetRectangleExinscrit
* Calculates the real bounding box according to the board position, * Calculates the real bounding box according to the board position,
* and real orientation and also calculates the area value (used in * and real orientation and also calculates the area value (used in
* automatic placement) * automatic placement)

3
pcbnew/class_pad.cpp
View File

@ -209,7 +209,8 @@ void D_PAD::Copy( D_PAD* source )
} }
/** Virtual function GetClearance /**
* Function GetClearance (virtual)
* returns the clearance in internal units. If \a aItem is not NULL then the * returns the clearance in internal units. If \a aItem is not NULL then the
* returned clearance is the greater of this object's clearance and * returned clearance is the greater of this object's clearance and
* aItem's clearance. If \a aItem is NULL, then this object clearance is returned. * aItem's clearance. If \a aItem is NULL, then this object clearance is returned.

3
pcbnew/class_track.cpp
View File

@ -106,7 +106,8 @@ TRACK* TRACK::Copy() const
return NULL; // should never happen return NULL; // should never happen
} }
/** Virtual function GetClearance /**
* Function GetClearance (virtual)
* returns the clearance in internal units. If \a aItem is not NULL then the * returns the clearance in internal units. If \a aItem is not NULL then the
* returned clearance is the greater of this object's clearance and * returned clearance is the greater of this object's clearance and
* aItem's clearance. If \a aItem is NULL, then this objects * aItem's clearance. If \a aItem is NULL, then this objects

6
pcbnew/class_zone.h
View File

@ -246,7 +246,7 @@ public:
bool HitTest( EDA_Rect& refArea ); bool HitTest( EDA_Rect& refArea );
/** /**
* Function Fill_Zone() * Function Fill_Zone
* Calculate the zone filling * Calculate the zone filling
* The zone outline is a frontier, and can be complex (with holes) * The zone outline is a frontier, and can be complex (with holes)
* The filling starts from starting points like pads, tracks. * The filling starts from starting points like pads, tracks.
@ -259,7 +259,7 @@ public:
int Fill_Zone( WinEDA_PcbFrame* frame, wxDC* DC, bool verbose = TRUE ); int Fill_Zone( WinEDA_PcbFrame* frame, wxDC* DC, bool verbose = TRUE );
/** /**
* Function Fill_Zone_Areas_With_Segments() * Function Fill_Zone_Areas_With_Segments
* Fill sub areas in a zone with segments with m_ZoneMinThickness width * Fill sub areas in a zone with segments with m_ZoneMinThickness width
* A scan is made line per line, on the whole filled areas, with a step of m_ZoneMinThickness. * A scan is made line per line, on the whole filled areas, with a step of m_ZoneMinThickness.
* all intersecting points with the horizontal infinite line and polygons to fill are calculated * all intersecting points with the horizontal infinite line and polygons to fill are calculated
@ -360,7 +360,7 @@ public:
return m_Poly->GetHatchStyle(); return m_Poly->GetHatchStyle();
} }
/** /**
* Function IsSame() * Function IsSame
* test is 2 zones are equivalent: * test is 2 zones are equivalent:
* 2 zones are equivalent if they have same parameters and same outlines * 2 zones are equivalent if they have same parameters and same outlines
* info relative to filling is not take in account * info relative to filling is not take in account

2
pcbnew/connect.cpp
View File

@ -28,7 +28,7 @@ static int Merge_Two_SubNets( TRACK* pt_start_conn, TRACK* pt_end_conn, int old_
/**************************************************************************************************/ /**************************************************************************************************/
/** /**
* Function Merge_Two_SubNets() * Function Merge_Two_SubNets
* Used by Propagate_SubNet() * Used by Propagate_SubNet()
* Change a subnet value to a new value, for tracks ans pads which are connected to corresponding track * Change a subnet value to a new value, for tracks ans pads which are connected to corresponding track
* for pads and tracks, this is the .m_Subnet member that is tested and modified * for pads and tracks, this is the .m_Subnet member that is tested and modified

6
pcbnew/debug_kbool_key_file_fct.h
View File

@ -17,13 +17,15 @@
#define KEYFILE_FILENAME "pcbnew_dbgfile.key" #define KEYFILE_FILENAME "pcbnew_dbgfile.key"
/** function CreateKeyFile /**
* Function CreateKeyFile
* open KEYFILE_FILENAME file * open KEYFILE_FILENAME file
* and create header * and create header
*/ */
void CreateKeyFile(); void CreateKeyFile();
/** function CloseKeyFile /**
* Function CloseKeyFile
* close KEYFILE_FILENAME file * close KEYFILE_FILENAME file
*/ */
void CloseKeyFile(); void CloseKeyFile();

2
pcbnew/dialog_copper_zones.cpp
View File

@ -178,7 +178,7 @@ bool dialog_copper_zone::AcceptOptions( bool aPromptForErrors, bool aUseExportab
/********************************************************************************************/ /********************************************************************************************/
/** /**
* Function dialog_copper_zone::AcceptOptions( * Function AcceptOptions(
* @return false if incorrect options, true if Ok. * @return false if incorrect options, true if Ok.
* @param aPromptForErrors = true to prompt user on incorrectparams * @param aPromptForErrors = true to prompt user on incorrectparams
* @param aUseExportableSetupOnly = true to use exportable parametres only (used to export this setup to other zones) * @param aUseExportableSetupOnly = true to use exportable parametres only (used to export this setup to other zones)

2
pcbnew/dialog_design_rules.cpp
View File

@ -491,7 +491,7 @@ static void class2gridRow( wxGrid* grid, int row, NETCLASS* nc, int units )
/** /**
* Function InitRulesList() * Function InitRulesList
* Fill the grid showing current rules with values * Fill the grid showing current rules with values
*/ */
void DIALOG_DESIGN_RULES::InitRulesList() void DIALOG_DESIGN_RULES::InitRulesList()

3
pcbnew/drag.h
View File

@ -45,7 +45,8 @@ void Collect_TrackSegmentsToDrag( WinEDA_DrawPanel* panel, wxDC* DC,
wxPoint& point, int MasqueLayer, int net_code ); wxPoint& point, int MasqueLayer, int net_code );
/** function EraseDragList /**
* Function EraseDragList
* clear the .m_Flags of all track segments managed by in g_DragSegmentList * clear the .m_Flags of all track segments managed by in g_DragSegmentList
* and clear the list. * and clear the list.
* In order to avoid useless memory allocation, the memory is not freed * In order to avoid useless memory allocation, the memory is not freed

2
pcbnew/files.cpp
View File

@ -119,7 +119,7 @@ void WinEDA_PcbFrame::Files_io( wxCommandEvent& event )
/** /**
* Function WinEDA_PcbFrame::LoadOnePcbFile * Function LoadOnePcbFile
* Load a Kicad board (.brd) file. * Load a Kicad board (.brd) file.
* *
* @param aFileName - File name including path. If empty, a file dialog will * @param aFileName - File name including path. If empty, a file dialog will

4
pcbnew/initpcb.cpp
View File

@ -141,7 +141,7 @@ void WinEDA_PcbGlobalDeleteFrame::AcceptPcbDelete( wxCommandEvent& event )
/** /**
* Function WinEDA_PcbFrame::Clear_Pcb() * Function Clear_Pcb
* delete all and reinitialize the current board * delete all and reinitialize the current board
* @param aQuery = true to prompt user for confirmation, false to initialize silently * @param aQuery = true to prompt user for confirmation, false to initialize silently
*/ */
@ -200,7 +200,7 @@ bool WinEDA_PcbFrame::Clear_Pcb( bool aQuery )
/** /**
* Function WinEDA_ModuleEditFrame::Clear_Pcb() * Function Clear_Pcb
* delete all and reinitialize the current board * delete all and reinitialize the current board
* @param aQuery = true to prompt user for confirmation, false to initialize silently * @param aQuery = true to prompt user for confirmation, false to initialize silently
*/ */

2
pcbnew/module_editor_frame.h
View File

@ -85,7 +85,7 @@ public:
// BOARD handling // BOARD handling
/** /**
* Function Clear_Pcb() * Function Clear_Pcb
* delete all and reinitialize the current board * delete all and reinitialize the current board
* @param aQuery = true to prompt user for confirmation, false to * @param aQuery = true to prompt user for confirmation, false to
* initialize silently * initialize silently

5
pcbnew/moduleframe.cpp
View File

@ -273,7 +273,7 @@ void WinEDA_ModuleEditFrame::CloseModuleEditor( wxCommandEvent& Event )
} }
/** /**
* Function WinEDA_ModuleEditFrame::SetToolbars() * Function SetToolbars
* Enable or disable some tools and menus, according to * Enable or disable some tools and menus, according to
* the current state of the footprint editor: * the current state of the footprint editor:
* >> a footprint is loaded or not * >> a footprint is loaded or not
@ -554,7 +554,8 @@ void WinEDA_ModuleEditFrame::GeneralControle( wxDC* DC, wxPoint Mouse )
} }
/** Virtual Function OnModify() /**
* Function OnModify() (virtual)
* Must be called after a change * Must be called after a change
* in order to set the "modify" flag of the current screen * in order to set the "modify" flag of the current screen
* and prepare, if needed the refresh of the 3D frame showing the footprint * and prepare, if needed the refresh of the 3D frame showing the footprint

3
pcbnew/pcbframe.cpp
View File

@ -707,7 +707,8 @@ void WinEDA_PcbFrame::SetLastNetListRead( const wxString& aLastNetListRead )
} }
} }
/** Virtual Function OnModify() /**
* Function OnModify() (virtual)
* Must be called after a change * Must be called after a change
* in order to set the "modify" flag of the current screen * in order to set the "modify" flag of the current screen
* and prepare, if needed the refresh of the 3D frame showing the footprint * and prepare, if needed the refresh of the 3D frame showing the footprint

7
pcbnew/print_board_functions.cpp
View File

@ -21,7 +21,7 @@ static void Print_Module( WinEDA_DrawPanel* aPanel, wxDC* aDC, MODULE* aModule,
PRINT_PARAMETERS::DrillShapeOptT aDrillShapeOpt ); PRINT_PARAMETERS::DrillShapeOptT aDrillShapeOpt );
/** /**
* Function WinEDA_ModuleEditFrame::PrintPage * Function PrintPage
* Used to print the board (on printer, or when creating SVF files). * Used to print the board (on printer, or when creating SVF files).
* Print the board, but only layers allowed by aPrintMaskLayer * Print the board, but only layers allowed by aPrintMaskLayer
* @param aDC = the print device context * @param aDC = the print device context
@ -101,8 +101,9 @@ void WinEDA_ModuleEditFrame::PrintPage( wxDC* aDC,
} }
/** WinEDA_PcbFrame::Function PrintPage /**
* Used to print the board (on printer, or when creating SVF files). * Function PrintPage
* is used to print the board (on printer, or when creating SVF files).
* Print the board, but only layers allowed by aPrintMaskLayer * Print the board, but only layers allowed by aPrintMaskLayer
* @param aDC = the print device context * @param aDC = the print device context
* @param aPrint_Sheet_Ref = true to print frame references * @param aPrint_Sheet_Ref = true to print frame references

3
pcbnew/protos.h
View File

@ -11,7 +11,8 @@
class COMMAND; class COMMAND;
/** Function SwapData /**
* Function SwapData
* Used in undo / redo command: * Used in undo / redo command:
* swap data between Item and a copy * swap data between Item and a copy
* swapped data is data modified by edition, so NOT ALL values are swapped * swapped data is data modified by edition, so NOT ALL values are swapped

8
pcbnew/ratsnest.cpp
View File

@ -192,7 +192,7 @@ static int sort_by_length( const void* o1, const void* o2 )
/** /**
* Function used by Build_Board_Ratsnest() * Function used by Build_Board_Ratsnest
* This function creates a ratsnest between two blocks ( which fit the same * This function creates a ratsnest between two blocks ( which fit the same
* net ) * net )
* A block is a group of pads already linked (by a previous ratsnest * A block is a group of pads already linked (by a previous ratsnest
@ -297,7 +297,7 @@ static int gen_rats_block_to_block(
/** /**
* Function used by Build_Board_Ratsnest() * Function used by Build_Board_Ratsnest
* this is the first pass of the lee algorithm * this is the first pass of the lee algorithm
* This function creates the link (ratsnest) between 2 pads ( fitting the same * This function creates the link (ratsnest) between 2 pads ( fitting the same
* net ) * net )
@ -548,7 +548,7 @@ void WinEDA_BasePcbFrame::DrawGeneralRatsnest( wxDC* DC, int net_code )
/** /**
* Function used by Tst_Ratsnest() * Function used by Tst_Ratsnest
* Function like gen_rats_block_to_block(..) * Function like gen_rats_block_to_block(..)
* Function testing the ratsnest between 2 blocks ( same net ) * Function testing the ratsnest between 2 blocks ( same net )
* The search is made between pads in block 1 and the others blocks * The search is made between pads in block 1 and the others blocks
@ -613,7 +613,7 @@ static int tst_rats_block_to_block( NETINFO_ITEM* net,
/** /**
* Function used by Tst_Ratsnest_general() * Function used by Tst_Ratsnest_general
* The general ratsnest list must exists * The general ratsnest list must exists
* Activates the ratsnest between 2 pads ( supposes du meme net ) * Activates the ratsnest between 2 pads ( supposes du meme net )
* The function links 1 pad not already connected an other pad and activate * The function links 1 pad not already connected an other pad and activate

2
pcbnew/specctra.h
View File

@ -2580,7 +2580,7 @@ typedef boost::ptr_vector<PADSTACK> PADSTACKS;
/** /**
* Function operator<() * Function operator<
* is used by the PADSTACKSET boost::ptr_set below * is used by the PADSTACKSET boost::ptr_set below
*/ */
inline bool operator<( const PADSTACK& lhs, const PADSTACK& rhs ) inline bool operator<( const PADSTACK& lhs, const PADSTACK& rhs )

2
pcbnew/track.cpp
View File

@ -267,7 +267,7 @@ TRACK* Marque_Une_Piste( BOARD* aPcb,
/** /**
* Function used by Marque_Une_Piste() * Function used by Marque_Une_Piste
* - Set the BUSY flag of connected segments, the first search point is * - Set the BUSY flag of connected segments, the first search point is
* ref_pos on layers allowed in masque_layer * ref_pos on layers allowed in masque_layer
* - Put segments fount in aList * - Put segments fount in aList

4
pcbnew/zone_filling_algorithm.cpp
View File

@ -92,7 +92,7 @@ int ZONE_CONTAINER::Fill_Zone_Areas_With_Segments( )
/***********************************************************************************/ /***********************************************************************************/
/** /**
* Function Fill_Zone_Areas_With_Segments() * Function Fill_Zone_Areas_With_Segments
* Fill sub areas in a zone with segments with m_ZoneMinThickness width * Fill sub areas in a zone with segments with m_ZoneMinThickness width
* A scan is made line per line, on the whole filled areas, with a step of m_ZoneMinThickness. * A scan is made line per line, on the whole filled areas, with a step of m_ZoneMinThickness.
* all intersecting points with the horizontal infinite line and polygons to fill are calculated * all intersecting points with the horizontal infinite line and polygons to fill are calculated
@ -220,7 +220,7 @@ int Propagation( WinEDA_PcbFrame* frame )
/********************************************/ /********************************************/
/** /**
* Function Propagation() * Function Propagation
* Used now only in autoplace calculations * Used now only in autoplace calculations
* Uses the routing matrix to fill the cells within the zone * Uses the routing matrix to fill the cells within the zone
* Search and mark cells within the zone, and agree with DRC options. * Search and mark cells within the zone, and agree with DRC options.

4
pcbnew/zones_by_polygon_fill_functions.cpp
View File

@ -93,7 +93,7 @@ int WinEDA_PcbFrame::Fill_Zone( ZONE_CONTAINER* zone_container, bool verbose )
/***************************************************************************************/ /***************************************************************************************/
/** /**
* Function Fill_Zone() * Function Fill_Zone
* Calculate the zone filling for the outline zone_container * Calculate the zone filling for the outline zone_container
* The zone outline is a frontier, and can be complex (with holes) * The zone outline is a frontier, and can be complex (with holes)
* The filling starts from starting points like pads, tracks. * The filling starts from starting points like pads, tracks.
@ -149,7 +149,7 @@ int WinEDA_PcbFrame::Fill_All_Zones( bool verbose )
/************************************************************/ /************************************************************/
/** /**
* Function Fill_All_Zones() * Function Fill_All_Zones
* Fill all zones on the board * Fill all zones on the board
* The old fillings are removed * The old fillings are removed
* @param verbose = true to show error messages * @param verbose = true to show error messages

6
pcbnew/zones_functions_for_undo_redo.cpp
View File

@ -53,7 +53,7 @@
#include "zones_functions_for_undo_redo.h" #include "zones_functions_for_undo_redo.h"
/** /**
* Function ZONE_CONTAINER::IsSame() * Function IsSame
* test is 2 zones are equivalent: * test is 2 zones are equivalent:
* 2 zones are equivalent if they have same parameters and same outlines * 2 zones are equivalent if they have same parameters and same outlines
* info relative to filling is not take in account * info relative to filling is not take in account
@ -94,7 +94,7 @@ bool ZONE_CONTAINER::IsSame( const ZONE_CONTAINER& aZoneToCompare )
/** /**
* Function SaveCopyOfZones() * Function SaveCopyOfZones
* creates a copy of zones having a given netcode on a given layer, * creates a copy of zones having a given netcode on a given layer,
* and fill a pick list with pickers to handle these copies * and fill a pick list with pickers to handle these copies
* the UndoRedo status is set to UR_CHANGED for all items in list * the UndoRedo status is set to UR_CHANGED for all items in list
@ -132,7 +132,7 @@ int SaveCopyOfZones( PICKED_ITEMS_LIST& aPickList, BOARD* aPcb, int aNetCode, in
/** /**
* Function UpdateCopyOfZonesList() * Function UpdateCopyOfZonesList
* check a pick list to remove zones identical to their copies * check a pick list to remove zones identical to their copies
* and set the type of operation in picker (UR_DELETED, UR_CHANGED) * and set the type of operation in picker (UR_DELETED, UR_CHANGED)
* if an item is deleted, the initial values are retrievered, * if an item is deleted, the initial values are retrievered,

6
pcbnew/zones_functions_for_undo_redo.h
View File

@ -45,7 +45,8 @@
#define ZONES_FUNCTIONS_TO_UNDO_REDO_H #define ZONES_FUNCTIONS_TO_UNDO_REDO_H
/** function SaveCopyOfZones() /**
* Function SaveCopyOfZones
* creates a copy of zones having a given netcode on a given layer, * creates a copy of zones having a given netcode on a given layer,
* and fill a pick list with pickers to handle these copies * and fill a pick list with pickers to handle these copies
* @param aPickList = the pick list * @param aPickList = the pick list
@ -57,7 +58,8 @@
int SaveCopyOfZones(PICKED_ITEMS_LIST & aPickList, BOARD* aPcb, int aNetCode, int aLayer ); int SaveCopyOfZones(PICKED_ITEMS_LIST & aPickList, BOARD* aPcb, int aNetCode, int aLayer );
/** function UpdateCopyOfZonesList() /**
* Function UpdateCopyOfZonesList
* check a pick list to remove zones identical to their copies * check a pick list to remove zones identical to their copies
* and set the type of operation in picker (UR_DELETED, UR_CHANGED) * and set the type of operation in picker (UR_DELETED, UR_CHANGED)
* @param aPickList = the main pick list * @param aPickList = the main pick list

3
polygon/PolyLine.h
View File

@ -31,7 +31,8 @@ enum
/** Function ArmBoolEng /**
* Function ArmBoolEng
* Initialise parameters used in kbool * Initialise parameters used in kbool
* @param aBooleng = pointer to the Bool_Engine to initialise * @param aBooleng = pointer to the Bool_Engine to initialise
* @param aConvertHoles = mode for holes when a boolean operation is made * @param aConvertHoles = mode for holes when a boolean operation is made

35
polygon/math_for_graphics.h
View File

@ -7,21 +7,22 @@
typedef struct PointTag typedef struct PointTag
{ {
double X,Y; double X,Y;
} PointT; } PointT;
typedef struct EllipseTag typedef struct EllipseTag
{ {
PointT Center; /* ellipse center */ PointT Center; /* ellipse center */
double xrad, yrad; // radii on x and y double xrad, yrad; // radii on x and y
double theta1, theta2; // start and end angle for arc double theta1, theta2; // start and end angle for arc
} EllipseKH; } EllipseKH;
// math stuff for graphics // math stuff for graphics
bool Quadratic( double a, double b, double c, double *x1, double *x2 ); bool Quadratic( double a, double b, double c, double *x1, double *x2 );
/** function TestLineHit /**
* Function TestLineHit
* test for hit on line segment i.e. a point within a given distance from segment * test for hit on line segment i.e. a point within a given distance from segment
* @param xi,yi and xf,yf = the end-points of the line segment * @param xi,yi and xf,yf = the end-points of the line segment
* @param dist = maximum distance for hit * @param dist = maximum distance for hit
@ -31,14 +32,15 @@ bool Quadratic( double a, double b, double c, double *x1, double *x2 );
bool TestLineHit( int xi, int yi, int xf, int yf, int x, int y, double dist ); bool TestLineHit( int xi, int yi, int xf, int yf, int x, int y, double dist );
int FindLineSegmentIntersection( double a, double b, int xi, int yi, int xf, int yf, int style, int FindLineSegmentIntersection( double a, double b, int xi, int yi, int xf, int yf, int style,
double * x1, double * y1, double * x2, double * y2, double * dist=NULL ); double * x1, double * y1, double * x2, double * y2, double * dist=NULL );
int FindSegmentIntersections( int xi, int yi, int xf, int yf, int style, int FindSegmentIntersections( int xi, int yi, int xf, int yf, int style,
int xi2, int yi2, int xf2, int yf2, int style2, int xi2, int yi2, int xf2, int yf2, int style2,
double x[]=NULL, double y[]=NULL ); double x[]=NULL, double y[]=NULL );
bool FindLineEllipseIntersections( double a, double b, double c, double d, double *x1, double *x2 ); bool FindLineEllipseIntersections( double a, double b, double c, double d, double *x1, double *x2 );
bool FindVerticalLineEllipseIntersections( double a, double b, double x, double *y1, double *y2 ); bool FindVerticalLineEllipseIntersections( double a, double b, double x, double *y1, double *y2 );
/** function TestForIntersectionOfStraightLineSegments /**
* Function TestForIntersectionOfStraightLineSegments
* Test for intersection of line segments * Test for intersection of line segments
* If lines are parallel, returns false * If lines are parallel, returns false
* If true, returns also intersection coords in x, y * If true, returns also intersection coords in x, y
@ -51,14 +53,15 @@ bool FindVerticalLineEllipseIntersections( double a, double b, double x, double
* @return true if intersect. * @return true if intersect.
*/ */
bool TestForIntersectionOfStraightLineSegments( int x1i, int y1i, int x1f, int y1f, bool TestForIntersectionOfStraightLineSegments( int x1i, int y1i, int x1f, int y1f,
int x2i, int y2i, int x2f, int y2f, int x2i, int y2i, int x2f, int y2f,
int * x=NULL, int * y=NULL, double * dist=NULL ); int * x=NULL, int * y=NULL, double * dist=NULL );
int GetClearanceBetweenSegments( int x1i, int y1i, int x1f, int y1f, int style1, int w1, int GetClearanceBetweenSegments( int x1i, int y1i, int x1f, int y1f, int style1, int w1,
int x2i, int y2i, int x2f, int y2f, int style2, int w2, int x2i, int y2i, int x2f, int y2f, int style2, int w2,
int max_cl, int * x, int * y ); int max_cl, int * x, int * y );
/** Function GetPointToLineSegmentDistance /**
* Function GetPointToLineSegmentDistance
* Get distance between line segment and point * Get distance between line segment and point
* @param x,y = point * @param x,y = point
* @param xi,yi and xf,yf = the end-points of the line segment * @param xi,yi and xf,yf = the end-points of the line segment
@ -70,6 +73,6 @@ double GetPointToLineDistance( double a, double b, int x, int y, double * xp=NUL
bool InRange( double x, double xi, double xf ); bool InRange( double x, double xi, double xf );
double Distance( int x1, int y1, int x2, int y2 ); double Distance( int x1, int y1, int x2, int y2 );
int GetArcIntersections( EllipseKH * el1, EllipseKH * el2, int GetArcIntersections( EllipseKH * el1, EllipseKH * el2,
double * x1=NULL, double * y1=NULL, double * x1=NULL, double * y1=NULL,
double * x2=NULL, double * y2=NULL ); double * x2=NULL, double * y2=NULL );

6
polygon/polygon_test_point_inside.h
View File

@ -10,7 +10,8 @@ public:
int x, y; int x, y;
}; };
#endif #endif
/** Function TestPointInsidePolygon /**
* Function TestPointInsidePolygon
* test if a point is inside or outside a polygon. * test if a point is inside or outside a polygon.
* @param aPolysList: the list of polygons * @param aPolysList: the list of polygons
* @param aIdxstart: the starting point of a given polygon in m_FilledPolysList. * @param aIdxstart: the starting point of a given polygon in m_FilledPolysList.
@ -23,7 +24,8 @@ bool TestPointInsidePolygon( std::vector <CPolyPt> aPolysList,
int aIdxend, int aIdxend,
int aRefx, int aRefx,
int aRefy); int aRefy);
/** Function TestPointInsidePolygon (overlaid) /**
* Function TestPointInsidePolygon (overlaid)
* same as previous, but mainly use wxPoint * same as previous, but mainly use wxPoint
* @param aPolysList: the list of polygons * @param aPolysList: the list of polygons
* @param aCount: corners count in aPolysList. * @param aCount: corners count in aPolysList.