From 6c9244e8c38257993885ccda145f02b23ff072c2 Mon Sep 17 00:00:00 2001 From: Dick Hollenbeck Date: Fri, 12 Nov 2010 10:59:16 -0600 Subject: [PATCH] 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. --- 3d-viewer/3d_draw.cpp | 2 +- common/basicframe.cpp | 3 +- common/build_version.cpp | 2 +- common/class_marker_base.cpp | 2 +- common/class_undoredo_container.cpp | 2 +- common/drawframe.cpp | 5 +-- common/drawpanel.cpp | 4 +-- common/drawtxt.cpp | 2 +- common/projet_config.cpp | 4 +-- eeschema/annotate.cpp | 2 +- eeschema/lib_pin.cpp | 6 ++-- eeschema/libedit.cpp | 2 +- eeschema/libedit_plot_component.cpp | 3 +- eeschema/libeditframe.h | 4 +-- eeschema/netlist.h | 3 +- eeschema/protos.h | 3 +- eeschema/sch_component.cpp | 2 +- eeschema/sch_component.h | 2 +- eeschema/sch_field.cpp | 2 +- eeschema/sch_sheet_path.h | 2 +- eeschema/sch_sheet_pin.cpp | 3 +- eeschema/sch_text.cpp | 2 +- eeschema/schematic_undo_redo.cpp | 2 +- eeschema/schframe.cpp | 2 +- gerbview/toolbars_gerber.cpp | 2 +- include/appl_wxstruct.h | 4 +-- include/build_version.h | 3 +- include/class_marker_base.h | 2 +- include/class_undoredo_container.h | 4 +-- include/common.h | 9 +++-- include/drawtxt.h | 15 +++++--- include/eda_doc.h | 3 +- include/gestfich.h | 3 +- include/gr_basic.h | 9 +++-- include/hotkeys_basic.h | 25 ++++++++----- include/plot_common.h | 2 +- include/trigo.h | 3 +- include/wxBasePcbFrame.h | 2 +- include/wxEeschemaStruct.h | 4 +-- include/wxPcbStruct.h | 8 ++--- pcbnew/basepcbframe.cpp | 2 +- ...board_items_to_polygon_shape_transform.cpp | 10 +++--- pcbnew/board_undo_redo.cpp | 2 +- pcbnew/class_board.cpp | 2 +- pcbnew/class_module.h | 4 +-- pcbnew/class_pad.cpp | 3 +- pcbnew/class_track.cpp | 3 +- pcbnew/class_zone.h | 6 ++-- pcbnew/connect.cpp | 2 +- pcbnew/debug_kbool_key_file_fct.h | 6 ++-- pcbnew/dialog_copper_zones.cpp | 2 +- pcbnew/dialog_design_rules.cpp | 2 +- pcbnew/drag.h | 3 +- pcbnew/files.cpp | 2 +- pcbnew/initpcb.cpp | 4 +-- pcbnew/module_editor_frame.h | 2 +- pcbnew/moduleframe.cpp | 5 +-- pcbnew/pcbframe.cpp | 3 +- pcbnew/print_board_functions.cpp | 7 ++-- pcbnew/protos.h | 3 +- pcbnew/ratsnest.cpp | 8 ++--- pcbnew/specctra.h | 2 +- pcbnew/track.cpp | 2 +- pcbnew/zone_filling_algorithm.cpp | 4 +-- pcbnew/zones_by_polygon_fill_functions.cpp | 4 +-- pcbnew/zones_functions_for_undo_redo.cpp | 6 ++-- pcbnew/zones_functions_for_undo_redo.h | 6 ++-- polygon/PolyLine.h | 3 +- polygon/math_for_graphics.h | 35 ++++++++++--------- polygon/polygon_test_point_inside.h | 6 ++-- 70 files changed, 179 insertions(+), 134 deletions(-) diff --git a/3d-viewer/3d_draw.cpp b/3d-viewer/3d_draw.cpp index 4a13b64520..41505e93ae 100644 --- a/3d-viewer/3d_draw.cpp +++ b/3d-viewer/3d_draw.cpp @@ -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 * @param aCornersList = a std::vector liste of corners, in physical coordinates * @param aZpos = the z position in 3D units diff --git a/common/basicframe.cpp b/common/basicframe.cpp index 417abbcea6..8d28133836 100644 --- a/common/basicframe.cpp +++ b/common/basicframe.cpp @@ -83,7 +83,8 @@ void WinEDA_BasicFrame::ReCreateMenuBar() } -/** Virtual function SetLanguage +/** + * Function SetLanguage (virtual) * called on a language menu selection * when using a derived function, do not forget to call this one */ diff --git a/common/build_version.cpp b/common/build_version.cpp index 8804da762d..e0118535ee 100644 --- a/common/build_version.cpp +++ b/common/build_version.cpp @@ -14,7 +14,7 @@ /** - * Function GetBuildVersion() + * Function GetBuildVersion * Return the build date and version */ wxString GetBuildVersion() diff --git a/common/class_marker_base.cpp b/common/class_marker_base.cpp index 5cd89eedcc..e09b171baf 100644 --- a/common/class_marker_base.cpp +++ b/common/class_marker_base.cpp @@ -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 */ void MARKER_BASE::DisplayMarkerInfo( WinEDA_DrawFrame* aFrame ) diff --git a/common/class_undoredo_container.cpp b/common/class_undoredo_container.cpp index abe64a2724..064651c535 100644 --- a/common/class_undoredo_container.cpp +++ b/common/class_undoredo_container.cpp @@ -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 * Useful when pop a list from Undo to Redo (and vice-versa) * because sometimes undo (or redo) a command needs to keep the diff --git a/common/drawframe.cpp b/common/drawframe.cpp index 1dabd2c2fb..3a9b25398a 100644 --- a/common/drawframe.cpp +++ b/common/drawframe.cpp @@ -184,7 +184,8 @@ void WinEDA_DrawFrame::ToolOnRightClick( wxCommandEvent& event ) { } -/** Virtual function PrintPage +/** + * Function PrintPage (virtual) * used to print a page * this basic function must be derived to be used for printing * 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: * - Absolute Cursor coordinates * - Relative Cursor coordinates (relative to the last coordinate stored diff --git a/common/drawpanel.cpp b/common/drawpanel.cpp index a87e20d01e..62a1a340bb 100644 --- a/common/drawpanel.cpp +++ b/common/drawpanel.cpp @@ -338,7 +338,7 @@ wxPoint WinEDA_DrawPanel::CursorScreenPosition() /** - * Function GetScreenCenterRealPosition() + * Function GetScreenCenterRealPosition * @return position (in internal units) of the current area center showed * 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. * * When using wxDC for scaling, the clip box coordinates are in drawing (logical) diff --git a/common/drawtxt.cpp b/common/drawtxt.cpp index 67427a9a81..c919777406 100644 --- a/common/drawtxt.cpp +++ b/common/drawtxt.cpp @@ -100,7 +100,7 @@ int NegableTextLength( const wxString& aText ) } -/* Function GetHersheyShapeDescription() +/* Function GetHersheyShapeDescription * return a pointer to the shape corresponding to unicode value AsciiCode * Note we use the same font for Bold and Normal texts * because kicad handles a variable pen size to do that diff --git a/common/projet_config.cpp b/common/projet_config.cpp index 42ff0c96d0..a2beb3003a 100644 --- a/common/projet_config.cpp +++ b/common/projet_config.cpp @@ -226,7 +226,7 @@ void WinEDA_App::WriteProjectConfig( const wxString& fileName, /** - * Function SaveCurrentSetupValues() + * Function SaveCurrentSetupValues * Save the current setup values in m_EDA_Config * saved parameters are parameters that have the .m_Setup member set to true * @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 * saved parameters are parameters that have the .m_Setup member set to true * @param aList = array of PARAM_CFG_BASE pointers diff --git a/eeschema/annotate.cpp b/eeschema/annotate.cpp index ad31d76b06..e3a626109c 100644 --- a/eeschema/annotate.cpp +++ b/eeschema/annotate.cpp @@ -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 * in sheet * @param aComponentsList = a std::vector list to fill diff --git a/eeschema/lib_pin.cpp b/eeschema/lib_pin.cpp index 4d3457d0ee..f367b55c93 100644 --- a/eeschema/lib_pin.cpp +++ b/eeschema/lib_pin.cpp @@ -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 * Pin num is coded as a long * 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 ... * 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 */ EDA_Rect LIB_PIN::GetBoundingBox() diff --git a/eeschema/libedit.cpp b/eeschema/libedit.cpp index 30c9a6a0c8..3ffd755e4b 100644 --- a/eeschema/libedit.cpp +++ b/eeschema/libedit.cpp @@ -53,7 +53,7 @@ void WinEDA_LibeditFrame::SelectActiveLibrary() /** - * Function LoadOneLibraryPart() + * Function LoadOneLibraryPart * load a library component from the current selected library * Prompt user for component name * If there is no current selected library, diff --git a/eeschema/libedit_plot_component.cpp b/eeschema/libedit_plot_component.cpp index 6f33f95ce6..4dd76a34ab 100644 --- a/eeschema/libedit_plot_component.cpp +++ b/eeschema/libedit_plot_component.cpp @@ -124,7 +124,8 @@ void WinEDA_LibeditFrame::CreatePNGorJPEGFile( const wxString& aFileName, bool a image.Destroy(); } -/** Virtual function PrintPage +/** + * Function PrintPage (virtual) * used to print a page. * @param aDC = wxDC given by the calling print function * @param aPrint_Sheet_Ref = true to print page references diff --git a/eeschema/libeditframe.h b/eeschema/libeditframe.h index 3c8ab15835..ef149810a7 100644 --- a/eeschema/libeditframe.h +++ b/eeschema/libeditframe.h @@ -110,7 +110,7 @@ public: void SaveSettings(); /** - * Function CloseWindow() + * Function CloseWindow * triggers the wxCloseEvent, which is handled by the function given * to EVT_CLOSE() macro: *

@@ -123,7 +123,7 @@ public: } /** - * Function OnModify() + * Function OnModify * Must be called after a schematic change * in order to set the "modify" flag of the current screen */ diff --git a/eeschema/netlist.h b/eeschema/netlist.h index 91ade5f843..fbbfd9547b 100644 --- a/eeschema/netlist.h +++ b/eeschema/netlist.h @@ -140,7 +140,8 @@ extern bool g_OptNetListUseNames; /* TRUE to use names rather than /* Prototypes: */ void FreeNetObjectsList( std::vector & aNetObjectslist ); -/** Function ReturnUserNetlistTypeName +/** + * Function ReturnUserNetlistTypeName * to retrieve user netlist type names * @param first = true: return first name of the list, false = return next * @return a wxString : name of the type netlist or empty string diff --git a/eeschema/protos.h b/eeschema/protos.h index c13a2128cf..c214ff4f80 100644 --- a/eeschema/protos.h +++ b/eeschema/protos.h @@ -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 ); // operations_on_item_lists.cpp -/** function DuplicateStruct +/** + * Function DuplicateStruct * Routine to create a new copy of given struct. * @param aDrawStruct = the SCH_ITEM to duplicate * @param aClone (defualt = true) diff --git a/eeschema/sch_component.cpp b/eeschema/sch_component.cpp index 6bb5b94879..a214e27b36 100644 --- a/eeschema/sch_component.cpp +++ b/eeschema/sch_component.cpp @@ -857,7 +857,7 @@ void SCH_COMPONENT::SetOrientation( int aOrientation ) /** - * Function GetOrientation() + * Function GetOrientation * Used to display component orientation (in dialog editor or info) * @return the orientation and mirror * Note: Because there are different ways to have a given orientation/mirror, diff --git a/eeschema/sch_component.h b/eeschema/sch_component.h index 272b026bc6..7ec964cd3d 100644 --- a/eeschema/sch_component.h +++ b/eeschema/sch_component.h @@ -168,7 +168,7 @@ public: void SetOrientation( int aOrientation ); /** - * Function GetOrientation() + * Function GetOrientation * Used to display component orientation (in dialog editor or info) * @return the orientation and mirror * Note: Because there are different ways to have a given orientation/mirror, diff --git a/eeschema/sch_field.cpp b/eeschema/sch_field.cpp index 8711d3e50a..ec1c64368f 100644 --- a/eeschema/sch_field.cpp +++ b/eeschema/sch_field.cpp @@ -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 * a text field, * according to the component position, rotation, mirror ... diff --git a/eeschema/sch_sheet_path.h b/eeschema/sch_sheet_path.h index 7a6890de85..87d500d419 100644 --- a/eeschema/sch_sheet_path.h +++ b/eeschema/sch_sheet_path.h @@ -272,7 +272,7 @@ public: } /** - * Function GetCount() + * Function GetCount * @return the number of sheets in list: * usually the number of sheets found in the whole hierarchy */ diff --git a/eeschema/sch_sheet_pin.cpp b/eeschema/sch_sheet_pin.cpp index afa2e5b6af..529e06462c 100644 --- a/eeschema/sch_sheet_pin.cpp +++ b/eeschema/sch_sheet_pin.cpp @@ -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 * @param aCorner_list = a buffer to fill with polygon corners coordinates * @param aPos = Position of the shape diff --git a/eeschema/sch_text.cpp b/eeschema/sch_text.cpp index ed343d1759..c799451c45 100644 --- a/eeschema/sch_text.cpp +++ b/eeschema/sch_text.cpp @@ -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 */ void SCH_LABEL::Draw( WinEDA_DrawPanel* panel, wxDC* DC, const wxPoint& offset, diff --git a/eeschema/schematic_undo_redo.cpp b/eeschema/schematic_undo_redo.cpp index 6ae08ef45b..605d617dd5 100644 --- a/eeschema/schematic_undo_redo.cpp +++ b/eeschema/schematic_undo_redo.cpp @@ -345,7 +345,7 @@ void WinEDA_SchematicFrame::SaveCopyInUndoList( PICKED_ITEMS_LIST& aItemsList, /** - * Function PutDataInPreviousState() + * Function PutDataInPreviousState * Used in undo or redo command. * Put data pointed by List in the previous state, i.e. the state memorized * by List diff --git a/eeschema/schframe.cpp b/eeschema/schframe.cpp index 0ac9b79a2a..690a60b123 100644 --- a/eeschema/schframe.cpp +++ b/eeschema/schframe.cpp @@ -465,7 +465,7 @@ wxString WinEDA_SchematicFrame::GetUniqueFilenameForCurrentSheet() } /** - * Function OnModify() + * Function OnModify * Must be called after a schematic change * in order to set the "modify" flag of the current screen * and update the date in frame reference diff --git a/gerbview/toolbars_gerber.cpp b/gerbview/toolbars_gerber.cpp index e5f81ff6a4..5e0c868fe7 100644 --- a/gerbview/toolbars_gerber.cpp +++ b/gerbview/toolbars_gerber.cpp @@ -213,7 +213,7 @@ void WinEDA_GerberFrame::ReCreateOptToolbar( void ) /** - * Function SetToolbars() + * Function SetToolbars * Set the tools state for the toolbars, according to display options */ void WinEDA_GerberFrame::SetToolbars() diff --git a/include/appl_wxstruct.h b/include/appl_wxstruct.h index 0e46b63236..0147d883ef 100644 --- a/include/appl_wxstruct.h +++ b/include/appl_wxstruct.h @@ -134,7 +134,7 @@ public: WinEDA_App(); PARAM_CFG_ARRAY& params ); /** - * Function SaveCurrentSetupValues() + * Function SaveCurrentSetupValues * Save the current setup values in m_EDA_Config * saved parameters are parameters that have the .m_Setup member set to * true @@ -144,7 +144,7 @@ public: WinEDA_App(); void SaveCurrentSetupValues( PARAM_CFG_ARRAY& List ); /** - * Function ReadCurrentSetupValues() + * Function ReadCurrentSetupValues * Raed the current setup values previously saved, from m_EDA_Config * saved parameters are parameters that have the .m_Setup member set to * true diff --git a/include/build_version.h b/include/build_version.h index d942d338cb..f9de4cd3c1 100644 --- a/include/build_version.h +++ b/include/build_version.h @@ -3,7 +3,8 @@ #ifndef KICAD_BUILD_VERSION_H #define KICAD_BUILD_VERSION_H -/** Function GetBuildVersion() +/** + * Function GetBuildVersion * Return the build date and version */ wxString GetBuildVersion(); diff --git a/include/class_marker_base.h b/include/class_marker_base.h index de23a11c9e..b2632494e8 100644 --- a/include/class_marker_base.h +++ b/include/class_marker_base.h @@ -167,7 +167,7 @@ public: /** - * Function DisplayMarkerInfo() + * Function DisplayMarkerInfo * Displays the full info of this marker, in a HTML window */ void DisplayMarkerInfo(WinEDA_DrawFrame * aFrame); diff --git a/include/class_undoredo_container.h b/include/class_undoredo_container.h index 3820ad3863..232ea06005 100644 --- a/include/class_undoredo_container.h +++ b/include/class_undoredo_container.h @@ -133,7 +133,7 @@ public: void ClearListAndDeleteItems(); /** - * Function GetCount() + * Function GetCount * @return the count of pickers stored in this list */ unsigned GetCount() const @@ -142,7 +142,7 @@ public: } /** - * Function ReversePickersListOrder() + * Function ReversePickersListOrder * reverses the order of pickers stored in this list * Useful when pop a list from Undo to Redo (and vice-versa) * because sometimes undo (or redo) a command needs to keep the diff --git a/include/common.h b/include/common.h index e2dbcc35d1..62201c9038 100644 --- a/include/common.h +++ b/include/common.h @@ -196,7 +196,8 @@ extern BASE_SCREEN* ActiveScreen; /* COMMON.CPP */ -/** function SetLocaleTo_C_standard +/** + * Function SetLocaleTo_C_standard * because kicad is internationalized, switch internalization to "C" standard * i.e. uses the . (dot) as separator in print/read float numbers * (some countries (France, Germany ..) use , (comma) as separator) @@ -209,7 +210,8 @@ extern BASE_SCREEN* ActiveScreen; */ void SetLocaleTo_C_standard( void ); -/** function SetLocaleTo_Default +/** + * Function SetLocaleTo_Default * because kicad is internationalized, switch internalization to default * to use the default separator in print/read float numbers * (. (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 Internal_Unit ); -/** Function ReturnStringFromValue +/** + * Function ReturnStringFromValue * Return the string from Value, according to units (inch, mm ...) for display, * and the initial unit for value * @param aUnit = display units (INCHES, MILLIMETRE ..) diff --git a/include/drawtxt.h b/include/drawtxt.h index ffe53ca78f..f5e7037bf5 100644 --- a/include/drawtxt.h +++ b/include/drawtxt.h @@ -12,7 +12,8 @@ class WinEDA_DrawPanel; class PLOTTER; -/** Function Clamp_Text_PenSize +/** + * Function Clamp_Text_PenSize *As a rule, pen width should not be >1/4em, otherwise the character * will be cluttered up in its own fatness * 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, wxSize aSize, bool aBold = true ); -/** Function GetPensizeForBold +/** + * Function GetPensizeForBold * @return the "best" value for a pen size to draw/plot a bold text * @param aTextSize = the char size (height or width) */ int GetPenSizeForBold( int aTextSize ); -/** Function ReturnGraphicTextWidth +/** + * Function ReturnGraphicTextWidth * @return the X size of the graphic text * the full X size is ReturnGraphicTextWidth + the thickness of graphic lines */ 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 */ int NegableTextLength( const wxString& aText ); -/** Function DrawGraphicText +/** + * Function DrawGraphicText * Draw a graphic text (like module texts) * @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 diff --git a/include/eda_doc.h b/include/eda_doc.h index d4002fb5f7..4ef705c0a2 100644 --- a/include/eda_doc.h +++ b/include/eda_doc.h @@ -17,7 +17,8 @@ int KeyWordOk( const wxString& KeyList, const wxString& Database ); -/** Function GetAssociatedDocument +/** + * Function GetAssociatedDocument * open a document (file) with the suitable browser * @param aFrame = main frame * @param aDocName = filename of file to open (Full filename or short filename) diff --git a/include/gestfich.h b/include/gestfich.h index 65248402f4..63177b5f91 100644 --- a/include/gestfich.h +++ b/include/gestfich.h @@ -16,7 +16,8 @@ class WinEDAListBox; -/** Function OpenPDF +/** + * Function OpenPDF * run the PDF viewer and display a PDF file * @param file = PDF file to open * @return true is success, false if no PDF viewer found diff --git a/include/gr_basic.h b/include/gr_basic.h index 1e60f3af36..04bcfe9cc9 100644 --- a/include/gr_basic.h +++ b/include/gr_basic.h @@ -56,12 +56,14 @@ void GRResetPenAndBrush( wxDC* DC ); void GRSetColorPen( wxDC* DC, int Color, int width = 1, wxPenStyle stype = wxPENSTYLE_SOLID ); 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 */ void GRForceBlackPen( bool flagforce ); -/** function GetGRForceBlackPenState +/** + * Function GetGRForceBlackPenState * @return ForceBlackPen (True if a black pen was forced) */ 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, int x2, int y2, int width, int Color, int BgColor ); -/** Function GRLineArray +/** + * Function GRLineArray * draws an array of lines (not a polygon). * @param aClipBox = the clip box * @param aDC = the device context into which drawing should occur. diff --git a/include/hotkeys_basic.h b/include/hotkeys_basic.h index 01fcbbfc96..a8997a5384 100644 --- a/include/hotkeys_basic.h +++ b/include/hotkeys_basic.h @@ -60,7 +60,8 @@ extern wxString g_ModuleEditSectionTag; void AddHotkeyConfigMenu( wxMenu* menu ); void HandleHotkeyConfigMenuSelection( WinEDA_DrawFrame* frame, int id ); -/** function ReturnKeyNameFromKeyCode +/** + * Function ReturnKeyNameFromKeyCode * return the key name from the key code * Only some wxWidgets key values are handled for function key ( see * s_Hotkey_Name_List[] ) @@ -70,7 +71,8 @@ void HandleHotkeyConfigMenuSelection( WinEDA_DrawFrame* frame, int id */ wxString ReturnKeyNameFromKeyCode( int aKeycode, bool * aIsFound = NULL ); -/** function ReturnKeyNameFromCommandId +/** + * Function ReturnKeyNameFromCommandId * return the key name from the Command id value ( m_Idcommand member value) * @param aList = pointer to a Ki_HotkeyInfo list of commands * @param aCommandId = Command Id value @@ -78,7 +80,8 @@ wxString ReturnKeyNameFromKeyCode( int aKeycode, bool * aIsFound = NULL ) */ wxString ReturnKeyNameFromCommandId( Ki_HotkeyInfo** aList, int aCommandId ); -/** function ReturnKeyCodeFromKeyName +/** + * Function ReturnKeyCodeFromKeyName * return the key code from its key name * Only some wxWidgets key values are handled for function key * @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 ); -/** function AddHotkeyName +/** + * Function AddHotkeyName * Add the key name from the Command id value ( m_Idcommand member value) * @param aText = a wxString. returns aText + key name * @param aList = pointer to a Ki_HotkeyInfo list of commands @@ -100,7 +104,8 @@ wxString AddHotkeyName( const wxString& aText, Ki_HotkeyInfo** aList, int aCommandId, bool aIsShortCut = true); -/** function AddHotkeyName +/** + * Function AddHotkeyName * Add the key name from the Command id value ( m_Idcommand member value) * @param aText = a wxString. returns aText + key name * @param aList = pointer to a Ki_HotkeyInfoSectionDescriptor DescrList of commands @@ -114,7 +119,8 @@ wxString AddHotkeyName( const wxString& aText, int aCommandId, bool aIsShortCut = true); -/** function DisplayHotkeyList +/** + * Function DisplayHotkeyList * Displays the current hotkey list * @param aFrame = current active frame * @param aList = pointer to a Ki_HotkeyInfoSectionDescriptor list @@ -124,7 +130,8 @@ wxString AddHotkeyName( const wxString& aText, void DisplayHotkeyList( WinEDA_DrawFrame* aFrame, struct Ki_HotkeyInfoSectionDescriptor* aList ); -/** function GetDescriptorFromHotkey +/** + * Function GetDescriptorFromHotkey * 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 aList = pointer to a Ki_HotkeyInfo list of commands @@ -156,8 +163,8 @@ enum common_hotkey_id_commnand { HK_ZOOM_REDRAW, HK_ZOOM_CENTER, HK_ZOOM_AUTO, - HK_UNDO, - HK_REDO, + HK_UNDO, + HK_REDO, HK_COMMON_END }; diff --git a/include/plot_common.h b/include/plot_common.h index aadff0e604..1b7920b7de 100644 --- a/include/plot_common.h +++ b/include/plot_common.h @@ -46,7 +46,7 @@ public: /** - * Function GetPlotterType() + * Function GetPlotterType * @return the format of the plot file */ PlotFormat GetPlotterType() diff --git a/include/trigo.h b/include/trigo.h index 206493c120..2868ea5e0e 100644 --- a/include/trigo.h +++ b/include/trigo.h @@ -53,7 +53,8 @@ bool HitTestPoints(wxPoint pointA, wxPoint pointB, double threshold); int CrossProduct(wxPoint vectorA, wxPoint vectorB); -/** Function TestSegmentHit +/** + * Function TestSegmentHit * test for hit on line segment * i.e. cursor within a given distance from segment * @param aRefPoint = cursor (point to test) coords diff --git a/include/wxBasePcbFrame.h b/include/wxBasePcbFrame.h index 454d266ebe..0294adfe3d 100644 --- a/include/wxBasePcbFrame.h +++ b/include/wxBasePcbFrame.h @@ -216,7 +216,7 @@ public: MODULE* GetModuleByName(); /** - * Function OnModify() + * Function OnModify * Virtual * Must be called after a change * in order to set the "modify" flag of the current screen diff --git a/include/wxEeschemaStruct.h b/include/wxEeschemaStruct.h index dd38de512e..d742964a5e 100644 --- a/include/wxEeschemaStruct.h +++ b/include/wxEeschemaStruct.h @@ -180,7 +180,7 @@ public: /** - * Function OnModify() + * Function OnModify * Must be called after a schematic change * in order to set the "modify" flag of the current screen * and update the date in frame reference @@ -548,7 +548,7 @@ public: private: /** - * Function PutDataInPreviousState() + * Function PutDataInPreviousState * Used in undo or redo command. * Put data pointed by List in the previous state, i.e. the state * memorized by List diff --git a/include/wxPcbStruct.h b/include/wxPcbStruct.h index 108d8e34df..c77ef1fb18 100644 --- a/include/wxPcbStruct.h +++ b/include/wxPcbStruct.h @@ -437,7 +437,7 @@ public: wxPoint( 0, 0 ) ); /** - * Function PutDataInPreviousState() + * Function PutDataInPreviousState * Used in undo or redo command. * Put data pointed by List in the previous state, i.e. the state memorized * by List @@ -582,7 +582,7 @@ public: // BOARD handling /** - * Function Clear_Pcb() + * Function Clear_Pcb * delete all and reinitialize the current board * @param aQuery = true to prompt user for confirmation, false to * initialize silently @@ -887,7 +887,7 @@ public: bool End_Zone( wxDC* DC ); /** - * Function Fill_Zone() + * Function Fill_Zone * Calculate the zone filling for the outline zone_container * The zone outline is a frontier, and can be complex (with holes) * The filling starts from starting points like pads, tracks. @@ -899,7 +899,7 @@ public: int Fill_Zone( ZONE_CONTAINER* zone_container, bool verbose = TRUE ); /** - * Function Fill_All_Zones() + * Function Fill_All_Zones * Fill all zones on the board * The old fillings are removed * @param verbose = true to show error messages diff --git a/pcbnew/basepcbframe.cpp b/pcbnew/basepcbframe.cpp index f9cd1a314c..8ea0fe05ba 100644 --- a/pcbnew/basepcbframe.cpp +++ b/pcbnew/basepcbframe.cpp @@ -433,7 +433,7 @@ void WinEDA_BasePcbFrame::SaveSettings() /** - * Function OnModify() + * Function OnModify * Must be called after a schematic change * in order to set the "modify" flag of the current screen * and update the date in frame reference diff --git a/pcbnew/board_items_to_polygon_shape_transform.cpp b/pcbnew/board_items_to_polygon_shape_transform.cpp index b99fd628e6..723582fc64 100644 --- a/pcbnew/board_items_to_polygon_shape_transform.cpp +++ b/pcbnew/board_items_to_polygon_shape_transform.cpp @@ -80,7 +80,7 @@ void TransformArcToPolygon( std::vector & aCornerBuffer, /** - * Function TEXTE_PCB::TransformShapeWithClearanceToPolygon + * Function TransformShapeWithClearanceToPolygon * Convert the track shape to a closed polygon * Used in filling zones calculations * 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 * Used in filling zones calculations * 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 * Used in filling zones calculations * 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 * Used in filling zones calculations * Circles (vias) and arcs (ends of tracks) are approximated by segments @@ -351,7 +351,7 @@ void TransformRoundedEndsSegmentToPolygon( std::vector & aCornerBuffer, /** - * Function D_PAD::TransformShapeWithClearanceToPolygon + * Function TransformShapeWithClearanceToPolygon * Convert the pad shape to a closed polygon * Used in filling zones calculations * Circles and arcs are approximated by segments diff --git a/pcbnew/board_undo_redo.cpp b/pcbnew/board_undo_redo.cpp index 75baf65e90..7f97a1d4eb 100644 --- a/pcbnew/board_undo_redo.cpp +++ b/pcbnew/board_undo_redo.cpp @@ -474,7 +474,7 @@ void WinEDA_PcbFrame::SaveCopyInUndoList( PICKED_ITEMS_LIST& aItemsList, /** - * Function PutDataInPreviousState() + * Function PutDataInPreviousState * Used in undo or redo command. * 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 diff --git a/pcbnew/class_board.cpp b/pcbnew/class_board.cpp index faa6607845..95fa46e4ae 100644 --- a/pcbnew/class_board.cpp +++ b/pcbnew/class_board.cpp @@ -742,7 +742,7 @@ unsigned BOARD::GetNodesCount() /** - * Function ComputeBoundaryBox() + * Function ComputeBoundaryBox * Calculate the bounding box of the board * This box contains pcb edges, pads , vias and tracks * Update m_PcbBox member diff --git a/pcbnew/class_module.h b/pcbnew/class_module.h index 0873afce3d..042ed63bd5 100644 --- a/pcbnew/class_module.h +++ b/pcbnew/class_module.h @@ -110,13 +110,13 @@ public: /** - * Function Set_Rectangle_Encadrement() + * Function Set_Rectangle_Encadrement * calculates the bounding box for orient 0 at origin = module anchor) */ void Set_Rectangle_Encadrement(); /** - * Function SetRectangleExinscrit() + * Function SetRectangleExinscrit * Calculates the real bounding box according to the board position, * and real orientation and also calculates the area value (used in * automatic placement) diff --git a/pcbnew/class_pad.cpp b/pcbnew/class_pad.cpp index 5576093248..44261252db 100644 --- a/pcbnew/class_pad.cpp +++ b/pcbnew/class_pad.cpp @@ -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 * 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. diff --git a/pcbnew/class_track.cpp b/pcbnew/class_track.cpp index 63544ae0ee..749530f803 100644 --- a/pcbnew/class_track.cpp +++ b/pcbnew/class_track.cpp @@ -106,7 +106,8 @@ TRACK* TRACK::Copy() const 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 * returned clearance is the greater of this object's clearance and * aItem's clearance. If \a aItem is NULL, then this objects diff --git a/pcbnew/class_zone.h b/pcbnew/class_zone.h index 9ddadaf33b..1db68ab8f6 100644 --- a/pcbnew/class_zone.h +++ b/pcbnew/class_zone.h @@ -246,7 +246,7 @@ public: bool HitTest( EDA_Rect& refArea ); /** - * Function Fill_Zone() + * Function Fill_Zone * Calculate the zone filling * The zone outline is a frontier, and can be complex (with holes) * 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 ); /** - * Function Fill_Zone_Areas_With_Segments() + * Function Fill_Zone_Areas_With_Segments * 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. * all intersecting points with the horizontal infinite line and polygons to fill are calculated @@ -360,7 +360,7 @@ public: return m_Poly->GetHatchStyle(); } /** - * Function IsSame() + * Function IsSame * test is 2 zones are equivalent: * 2 zones are equivalent if they have same parameters and same outlines * info relative to filling is not take in account diff --git a/pcbnew/connect.cpp b/pcbnew/connect.cpp index 36e13fefa9..98b92ad949 100644 --- a/pcbnew/connect.cpp +++ b/pcbnew/connect.cpp @@ -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() * 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 diff --git a/pcbnew/debug_kbool_key_file_fct.h b/pcbnew/debug_kbool_key_file_fct.h index c8005b13fe..d01cd8287d 100644 --- a/pcbnew/debug_kbool_key_file_fct.h +++ b/pcbnew/debug_kbool_key_file_fct.h @@ -17,13 +17,15 @@ #define KEYFILE_FILENAME "pcbnew_dbgfile.key" -/** function CreateKeyFile +/** + * Function CreateKeyFile * open KEYFILE_FILENAME file * and create header */ void CreateKeyFile(); -/** function CloseKeyFile +/** + * Function CloseKeyFile * close KEYFILE_FILENAME file */ void CloseKeyFile(); diff --git a/pcbnew/dialog_copper_zones.cpp b/pcbnew/dialog_copper_zones.cpp index 09e8956e7b..f27b9f7c12 100644 --- a/pcbnew/dialog_copper_zones.cpp +++ b/pcbnew/dialog_copper_zones.cpp @@ -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. * @param aPromptForErrors = true to prompt user on incorrectparams * @param aUseExportableSetupOnly = true to use exportable parametres only (used to export this setup to other zones) diff --git a/pcbnew/dialog_design_rules.cpp b/pcbnew/dialog_design_rules.cpp index 8b646b0ce7..fb9bf20085 100644 --- a/pcbnew/dialog_design_rules.cpp +++ b/pcbnew/dialog_design_rules.cpp @@ -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 */ void DIALOG_DESIGN_RULES::InitRulesList() diff --git a/pcbnew/drag.h b/pcbnew/drag.h index d1aa86c5cb..d92c4439d7 100644 --- a/pcbnew/drag.h +++ b/pcbnew/drag.h @@ -45,7 +45,8 @@ void Collect_TrackSegmentsToDrag( WinEDA_DrawPanel* panel, wxDC* DC, wxPoint& point, int MasqueLayer, int net_code ); -/** function EraseDragList +/** + * Function EraseDragList * clear the .m_Flags of all track segments managed by in g_DragSegmentList * and clear the list. * In order to avoid useless memory allocation, the memory is not freed diff --git a/pcbnew/files.cpp b/pcbnew/files.cpp index a9e25ff8a7..c70de07d64 100644 --- a/pcbnew/files.cpp +++ b/pcbnew/files.cpp @@ -119,7 +119,7 @@ void WinEDA_PcbFrame::Files_io( wxCommandEvent& event ) /** - * Function WinEDA_PcbFrame::LoadOnePcbFile + * Function LoadOnePcbFile * Load a Kicad board (.brd) file. * * @param aFileName - File name including path. If empty, a file dialog will diff --git a/pcbnew/initpcb.cpp b/pcbnew/initpcb.cpp index 5f481200b9..6d5ed19199 100644 --- a/pcbnew/initpcb.cpp +++ b/pcbnew/initpcb.cpp @@ -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 * @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 * @param aQuery = true to prompt user for confirmation, false to initialize silently */ diff --git a/pcbnew/module_editor_frame.h b/pcbnew/module_editor_frame.h index 06604425d3..950dade9bd 100644 --- a/pcbnew/module_editor_frame.h +++ b/pcbnew/module_editor_frame.h @@ -85,7 +85,7 @@ public: // BOARD handling /** - * Function Clear_Pcb() + * Function Clear_Pcb * delete all and reinitialize the current board * @param aQuery = true to prompt user for confirmation, false to * initialize silently diff --git a/pcbnew/moduleframe.cpp b/pcbnew/moduleframe.cpp index 399feb1aa8..54a1bf8c52 100644 --- a/pcbnew/moduleframe.cpp +++ b/pcbnew/moduleframe.cpp @@ -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 * the current state of the footprint editor: * >> 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 * in order to set the "modify" flag of the current screen * and prepare, if needed the refresh of the 3D frame showing the footprint diff --git a/pcbnew/pcbframe.cpp b/pcbnew/pcbframe.cpp index 81a0120fd7..3262ad44e5 100644 --- a/pcbnew/pcbframe.cpp +++ b/pcbnew/pcbframe.cpp @@ -707,7 +707,8 @@ void WinEDA_PcbFrame::SetLastNetListRead( const wxString& aLastNetListRead ) } } -/** Virtual Function OnModify() +/** + * Function OnModify() (virtual) * Must be called after a change * in order to set the "modify" flag of the current screen * and prepare, if needed the refresh of the 3D frame showing the footprint diff --git a/pcbnew/print_board_functions.cpp b/pcbnew/print_board_functions.cpp index 61ab80ab64..b6ef466414 100644 --- a/pcbnew/print_board_functions.cpp +++ b/pcbnew/print_board_functions.cpp @@ -21,7 +21,7 @@ static void Print_Module( WinEDA_DrawPanel* aPanel, wxDC* aDC, MODULE* aModule, PRINT_PARAMETERS::DrillShapeOptT aDrillShapeOpt ); /** - * Function WinEDA_ModuleEditFrame::PrintPage + * Function PrintPage * Used to print the board (on printer, or when creating SVF files). * Print the board, but only layers allowed by aPrintMaskLayer * @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 * @param aDC = the print device context * @param aPrint_Sheet_Ref = true to print frame references diff --git a/pcbnew/protos.h b/pcbnew/protos.h index 21a5225c08..d22ccca9af 100644 --- a/pcbnew/protos.h +++ b/pcbnew/protos.h @@ -11,7 +11,8 @@ class COMMAND; -/** Function SwapData +/** + * Function SwapData * Used in undo / redo command: * swap data between Item and a copy * swapped data is data modified by edition, so NOT ALL values are swapped diff --git a/pcbnew/ratsnest.cpp b/pcbnew/ratsnest.cpp index 21782ffba0..8a965f5bcf 100644 --- a/pcbnew/ratsnest.cpp +++ b/pcbnew/ratsnest.cpp @@ -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 * net ) * 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 function creates the link (ratsnest) between 2 pads ( fitting the same * 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 testing the ratsnest between 2 blocks ( same net ) * 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 * Activates the ratsnest between 2 pads ( supposes du meme net ) * The function links 1 pad not already connected an other pad and activate diff --git a/pcbnew/specctra.h b/pcbnew/specctra.h index fa5a4470e9..d97cb291fb 100644 --- a/pcbnew/specctra.h +++ b/pcbnew/specctra.h @@ -2580,7 +2580,7 @@ typedef boost::ptr_vector PADSTACKS; /** - * Function operator<() + * Function operator< * is used by the PADSTACKSET boost::ptr_set below */ inline bool operator<( const PADSTACK& lhs, const PADSTACK& rhs ) diff --git a/pcbnew/track.cpp b/pcbnew/track.cpp index 5a6e1907ca..93a3d81ac1 100644 --- a/pcbnew/track.cpp +++ b/pcbnew/track.cpp @@ -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 * ref_pos on layers allowed in masque_layer * - Put segments fount in aList diff --git a/pcbnew/zone_filling_algorithm.cpp b/pcbnew/zone_filling_algorithm.cpp index 2710de8be4..50a5ef9cdc 100644 --- a/pcbnew/zone_filling_algorithm.cpp +++ b/pcbnew/zone_filling_algorithm.cpp @@ -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 * 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 @@ -220,7 +220,7 @@ int Propagation( WinEDA_PcbFrame* frame ) /********************************************/ /** - * Function Propagation() + * Function Propagation * Used now only in autoplace calculations * Uses the routing matrix to fill the cells within the zone * Search and mark cells within the zone, and agree with DRC options. diff --git a/pcbnew/zones_by_polygon_fill_functions.cpp b/pcbnew/zones_by_polygon_fill_functions.cpp index d7b3fc7365..1daeb18cef 100644 --- a/pcbnew/zones_by_polygon_fill_functions.cpp +++ b/pcbnew/zones_by_polygon_fill_functions.cpp @@ -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 * The zone outline is a frontier, and can be complex (with holes) * 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 * The old fillings are removed * @param verbose = true to show error messages diff --git a/pcbnew/zones_functions_for_undo_redo.cpp b/pcbnew/zones_functions_for_undo_redo.cpp index ba971a8acb..3ebc8adc7e 100644 --- a/pcbnew/zones_functions_for_undo_redo.cpp +++ b/pcbnew/zones_functions_for_undo_redo.cpp @@ -53,7 +53,7 @@ #include "zones_functions_for_undo_redo.h" /** - * Function ZONE_CONTAINER::IsSame() + * Function IsSame * test is 2 zones are equivalent: * 2 zones are equivalent if they have same parameters and same outlines * 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, * and fill a pick list with pickers to handle these copies * 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 * and set the type of operation in picker (UR_DELETED, UR_CHANGED) * if an item is deleted, the initial values are retrievered, diff --git a/pcbnew/zones_functions_for_undo_redo.h b/pcbnew/zones_functions_for_undo_redo.h index 6c8959bcda..82c87c3503 100644 --- a/pcbnew/zones_functions_for_undo_redo.h +++ b/pcbnew/zones_functions_for_undo_redo.h @@ -45,7 +45,8 @@ #define ZONES_FUNCTIONS_TO_UNDO_REDO_H -/** function SaveCopyOfZones() +/** + * Function SaveCopyOfZones * creates a copy of zones having a given netcode on a given layer, * and fill a pick list with pickers to handle these copies * @param aPickList = the pick list @@ -57,7 +58,8 @@ 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 * and set the type of operation in picker (UR_DELETED, UR_CHANGED) * @param aPickList = the main pick list diff --git a/polygon/PolyLine.h b/polygon/PolyLine.h index 1886445290..f30d8d3ad9 100644 --- a/polygon/PolyLine.h +++ b/polygon/PolyLine.h @@ -31,7 +31,8 @@ enum -/** Function ArmBoolEng +/** + * Function ArmBoolEng * Initialise parameters used in kbool * @param aBooleng = pointer to the Bool_Engine to initialise * @param aConvertHoles = mode for holes when a boolean operation is made diff --git a/polygon/math_for_graphics.h b/polygon/math_for_graphics.h index 78916fc429..24e0d5050b 100644 --- a/polygon/math_for_graphics.h +++ b/polygon/math_for_graphics.h @@ -7,21 +7,22 @@ typedef struct PointTag { - double X,Y; + double X,Y; } PointT; typedef struct EllipseTag { - PointT Center; /* ellipse center */ - double xrad, yrad; // radii on x and y - double theta1, theta2; // start and end angle for arc + PointT Center; /* ellipse center */ + double xrad, yrad; // radii on x and y + double theta1, theta2; // start and end angle for arc } EllipseKH; // math stuff for graphics 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 * @param xi,yi and xf,yf = the end-points of the line segment * @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 ); 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 xi2, int yi2, int xf2, int yf2, int style2, - double x[]=NULL, double y[]=NULL ); + int xi2, int yi2, int xf2, int yf2, int style2, + double x[]=NULL, double y[]=NULL ); 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 ); -/** function TestForIntersectionOfStraightLineSegments +/** + * Function TestForIntersectionOfStraightLineSegments * Test for intersection of line segments * If lines are parallel, returns false * 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. */ bool TestForIntersectionOfStraightLineSegments( int x1i, int y1i, int x1f, int y1f, - int x2i, int y2i, int x2f, int y2f, - int * x=NULL, int * y=NULL, double * dist=NULL ); + int x2i, int y2i, int x2f, int y2f, + int * x=NULL, int * y=NULL, double * dist=NULL ); 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 max_cl, int * x, int * y ); + int x2i, int y2i, int x2f, int y2f, int style2, int w2, + int max_cl, int * x, int * y ); -/** Function GetPointToLineSegmentDistance +/** + * Function GetPointToLineSegmentDistance * Get distance between line segment and point * @param x,y = point * @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 ); double Distance( int x1, int y1, int x2, int y2 ); int GetArcIntersections( EllipseKH * el1, EllipseKH * el2, - double * x1=NULL, double * y1=NULL, - double * x2=NULL, double * y2=NULL ); + double * x1=NULL, double * y1=NULL, + double * x2=NULL, double * y2=NULL ); diff --git a/polygon/polygon_test_point_inside.h b/polygon/polygon_test_point_inside.h index 92e36fff15..6669e6762b 100644 --- a/polygon/polygon_test_point_inside.h +++ b/polygon/polygon_test_point_inside.h @@ -10,7 +10,8 @@ public: int x, y; }; #endif -/** Function TestPointInsidePolygon +/** + * Function TestPointInsidePolygon * test if a point is inside or outside a polygon. * @param aPolysList: the list of polygons * @param aIdxstart: the starting point of a given polygon in m_FilledPolysList. @@ -23,7 +24,8 @@ bool TestPointInsidePolygon( std::vector aPolysList, int aIdxend, int aRefx, int aRefy); -/** Function TestPointInsidePolygon (overlaid) +/** + * Function TestPointInsidePolygon (overlaid) * same as previous, but mainly use wxPoint * @param aPolysList: the list of polygons * @param aCount: corners count in aPolysList.