From 636b2d301ea7286a26c9afc0e9f82bd6f446cda1 Mon Sep 17 00:00:00 2001 From: Dick Hollenbeck Date: Fri, 12 Nov 2010 10:36:43 -0600 Subject: [PATCH] function comments, fix ones in *.cpp files until they can be deleted if they exist in the headers --- 3d-viewer/3d_draw.cpp | 6 +- bitmap2component/bitmap2component.cpp | 3 +- common/base_screen.cpp | 3 +- common/base_struct.cpp | 18 +- common/block_commande.cpp | 12 +- common/build_version.cpp | 3 +- common/class_marker_base.cpp | 6 +- common/class_undoredo_container.cpp | 45 +- common/common.cpp | 12 +- common/common_plotDXF_functions.cpp | 5 +- common/common_plotGERBER_functions.cpp | 12 +- common/common_plotHPGL_functions.cpp | 3 +- common/common_plotPS_functions.cpp | 3 +- common/dialog_load_error.cpp | 17 +- common/drawframe.cpp | 6 +- common/drawpanel.cpp | 21 +- common/drawtxt.cpp | 15 +- common/eda_doc.cpp | 3 +- common/edaappl.cpp | 21 +- common/gestfich.cpp | 12 +- common/gr_basic.cpp | 12 +- common/hotkeys_basic.cpp | 39 +- common/projet_config.cpp | 9 +- common/trigo.cpp | 6 +- common/worksheet.cpp | 3 +- common/zoom.cpp | 11 +- cvpcb/class_DisplayFootprintsFrame.cpp | 9 +- cvpcb/class_components_listbox.cpp | 3 +- cvpcb/class_footprints_listbox.cpp | 3 +- eeschema/annotate.cpp | 9 +- eeschema/backanno.cpp | 6 +- eeschema/class_libentry.cpp | 6 +- eeschema/controle.cpp | 6 +- eeschema/dialogs/dialog_erc.cpp | 3 +- eeschema/erc.cpp | 3 +- eeschema/lib_arc.cpp | 12 +- eeschema/lib_bezier.cpp | 9 +- eeschema/lib_circle.cpp | 6 +- eeschema/lib_field.cpp | 6 +- eeschema/lib_pin.cpp | 27 +- eeschema/lib_polyline.cpp | 9 +- eeschema/lib_rectangle.cpp | 6 +- eeschema/lib_text.cpp | 6 +- eeschema/libedit_plot_component.cpp | 6 +- eeschema/libeditframe.cpp | 9 +- eeschema/locate.cpp | 11 +- eeschema/netlist.cpp | 11 +- eeschema/netlist_control.cpp | 18 +- eeschema/onleftclick.cpp | 3 +- eeschema/operations_on_items_lists.cpp | 9 +- eeschema/sch_component.cpp | 12 +- eeschema/sch_field.cpp | 3 +- eeschema/sch_items.cpp | 18 +- eeschema/sch_screen.cpp | 3 +- eeschema/sch_sheet.cpp | 42 +- eeschema/sch_sheet_path.cpp | 36 +- eeschema/sch_sheet_pin.cpp | 6 +- eeschema/sch_text.cpp | 60 +- eeschema/schematic_undo_redo.cpp | 15 +- eeschema/schframe.cpp | 12 +- eeschema/viewlibs.cpp | 3 +- gerbview/class_GERBER.cpp | 12 +- gerbview/class_aperture_macro.cpp | 9 +- gerbview/class_gerber_draw_item.cpp | 15 +- gerbview/class_gerbview_layer_widget.cpp | 3 +- gerbview/dcode.cpp | 12 +- gerbview/dialogs/dialog_gerber_config.cpp | 3 +- gerbview/draw_gerber_screen.cpp | 3 +- gerbview/gerberframe.cpp | 18 +- gerbview/options.cpp | 3 +- gerbview/rs274x.cpp | 6 +- gerbview/toolbars_gerber.cpp | 3 +- kicad/commandframe.cpp | 6 +- kicad/tree_project_frame.cpp | 9 +- pcbnew/basepcbframe.cpp | 3 +- pcbnew/block.cpp | 6 +- ...board_items_to_polygon_shape_transform.cpp | 24 +- pcbnew/board_undo_redo.cpp | 24 +- pcbnew/class_board.cpp | 12 +- pcbnew/class_board_connected_item.cpp | 3 +- pcbnew/class_dimension.cpp | 3 +- pcbnew/class_module.cpp | 6 +- pcbnew/class_netinfo_item.cpp | 6 +- pcbnew/class_netinfolist.cpp | 9 +- pcbnew/class_pad.cpp | 6 +- pcbnew/class_pad_draw_functions.cpp | 9 +- pcbnew/class_pcb_layer_widget.cpp | 3 +- pcbnew/class_pcb_text.cpp | 6 +- pcbnew/class_text_mod.cpp | 6 +- pcbnew/class_zone.cpp | 16 +- pcbnew/class_zone_setting.cpp | 6 +- pcbnew/clean.cpp | 3 +- pcbnew/connect.cpp | 12 +- pcbnew/dialog_copper_zones.cpp | 3 +- pcbnew/dialog_design_rules.cpp | 6 +- pcbnew/dialog_orient_footprints.cpp | 6 +- pcbnew/dragsegm.cpp | 5 +- pcbnew/edgemod.cpp | 9 +- pcbnew/edit_track_width.cpp | 12 +- pcbnew/event_handlers_tracks_vias_sizes.cpp | 3 +- pcbnew/files.cpp | 3 +- pcbnew/globaleditpad.cpp | 3 +- pcbnew/gpcb_exchange.cpp | 3 +- pcbnew/graphpcb.cpp | 3 +- pcbnew/hotkeys.cpp | 12 +- pcbnew/initpcb.cpp | 6 +- pcbnew/ioascii.cpp | 3 +- pcbnew/librairi.cpp | 9 +- pcbnew/loadcmp.cpp | 12 +- pcbnew/modedit.cpp | 3 +- pcbnew/modedit_undo_redo.cpp | 6 +- pcbnew/moduleframe.cpp | 3 +- pcbnew/move-drag_pads.cpp | 3 +- pcbnew/muonde.cpp | 3 +- pcbnew/netlist.cpp | 15 +- pcbnew/onleftclick.cpp | 3 +- pcbnew/onrightclick.cpp | 3 +- pcbnew/pcbframe.cpp | 15 +- pcbnew/plot_rtn.cpp | 3 +- pcbnew/print_board_functions.cpp | 3 +- pcbnew/ratsnest.cpp | 9 +- pcbnew/surbrill.cpp | 3 +- pcbnew/tr_modif.cpp | 3 +- pcbnew/xchgmod.cpp | 3 +- pcbnew/zone_filling_algorithm.cpp | 9 +- pcbnew/zones_by_polygon.cpp | 6 +- pcbnew/zones_by_polygon_fill_functions.cpp | 9 +- ...nvert_brd_items_to_polygons_with_Boost.cpp | 3 +- ...nvert_brd_items_to_polygons_with_Kbool.cpp | 9 +- pcbnew/zones_functions_for_undo_redo.cpp | 9 +- ...ones_polygons_insulated_copper_islands.cpp | 3 +- pcbnew/zones_polygons_test_connections.cpp | 6 +- pcbnew/zones_test_and_combine_areas.cpp | 6 +- polygon/PolyLine.cpp | 23 +- polygon/math_for_graphics.cpp | 2045 +++++++++-------- polygon/polygon_test_point_inside.cpp | 3 +- 136 files changed, 1841 insertions(+), 1443 deletions(-) diff --git a/3d-viewer/3d_draw.cpp b/3d-viewer/3d_draw.cpp index b6df68fdac..4a13b64520 100644 --- a/3d-viewer/3d_draw.cpp +++ b/3d-viewer/3d_draw.cpp @@ -384,7 +384,8 @@ void Pcb3D_GLCanvas::Draw3D_Track( TRACK* track ) } -/** Function Draw3D_SolidPolygonsInZones +/** + * Function Draw3D_SolidPolygonsInZones * draw all solid polygons used as filles areas in a zone * @param aZone_c = the zone to draw */ @@ -1252,7 +1253,8 @@ static void Draw3D_CircleSegment( double startx, double starty, double endx, } -/** Function Pcb3D_GLCanvas::Draw3D_Polygon +/** + * Function Pcb3D_GLCanvas::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/bitmap2component/bitmap2component.cpp b/bitmap2component/bitmap2component.cpp index 07d3534aec..89b32ffbc8 100644 --- a/bitmap2component/bitmap2component.cpp +++ b/bitmap2component/bitmap2component.cpp @@ -96,7 +96,8 @@ BITMAPCONV_INFO::BITMAPCONV_INFO() } -/** 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/common/base_screen.cpp b/common/base_screen.cpp index 8e85ca74f7..12a2dc8a06 100644 --- a/common/base_screen.cpp +++ b/common/base_screen.cpp @@ -122,7 +122,8 @@ wxPoint BASE_SCREEN::CursorRealPosition( const wxPoint& ScreenPos ) return curpos; } -/** Function SetScalingFactor +/** + * Function SetScalingFactor * calculates the .m_Zoom member to have a given scaling factor * @param the the current scale used to draw items on screen * draw coordinates are user coordinates * GetScalingFactor( ) diff --git a/common/base_struct.cpp b/common/base_struct.cpp index 06abecfbb2..7c5badd98e 100644 --- a/common/base_struct.cpp +++ b/common/base_struct.cpp @@ -207,7 +207,8 @@ int EDA_TextStruct::LenSize( const wxString& aLine ) const } -/** Function GetTextBox +/** + * Function GetTextBox * useful in multiline texts to calculate the full text or a line area (for zones filling, locate functions....) * @return the rect containing the line of text (i.e. the position and the size of one line) * this rectangle is calculated for 0 orient text. if orient is not 0 the rect must be rotated to match the physical area @@ -346,7 +347,8 @@ void EDA_TextStruct::Draw( WinEDA_DrawPanel* aPanel, wxDC* aDC, GRTraceMode aFillMode, EDA_Colors aAnchor_color ) /***************************************************************/ -/** Function Draw +/** + * Function Draw * Draws this, that can be a multiline text * @param aPanel = the current DrawPanel * @param aDC = the current Device Context @@ -397,7 +399,8 @@ void EDA_TextStruct::Draw( WinEDA_DrawPanel* aPanel, wxDC* aDC, } -/** Function DrawOneLineOfText +/** + * Function DrawOneLineOfText * Draw a single text line. * Used to draw each line of this EDA_TextStruct, that can be multiline * @param aPanel = the current DrawPanel @@ -485,7 +488,8 @@ void EDA_Rect::Normalize() -/** Function Move +/** + * Function Move * Move this rectangle by the aMoveVector value (this is a relative move) * @param aMoveVector = a wxPoint that is the value to move this rectangle */ @@ -548,7 +552,8 @@ bool EDA_Rect::Intersects( const EDA_Rect aRect ) const EDA_Rect& EDA_Rect::Inflate( int aDelta ) /**************************************************/ -/** Function Inflate +/** + * Function Inflate * Inflate "this": move each horizontal edgeand each vertical edge by aDelta * toward rect outside * if aDelta is negative, move toward rect inside (deflate) @@ -564,7 +569,8 @@ EDA_Rect& EDA_Rect::Inflate( int aDelta ) EDA_Rect& EDA_Rect::Inflate( wxCoord dx, wxCoord dy ) /**************************************************/ -/** Function Inflate +/** + * Function Inflate * Inflate "this": move each horizontal edge by dx and each vertical edge by dy * toward rect outside * if dx and/or dy is negative, move toward rect inside (deflate) diff --git a/common/block_commande.cpp b/common/block_commande.cpp index 2badfe8a86..40fa052860 100644 --- a/common/block_commande.cpp +++ b/common/block_commande.cpp @@ -115,7 +115,8 @@ void BLOCK_SELECTOR::Draw( WinEDA_DrawPanel* aPanel, wxDC* aDC, } -/** function InitData +/** + * Function InitData * Init the initial values of a BLOCK_SELECTOR, before starting a block command */ void BLOCK_SELECTOR::InitData( WinEDA_DrawPanel* aPanel, @@ -130,7 +131,8 @@ void BLOCK_SELECTOR::InitData( WinEDA_DrawPanel* aPanel, } -/** Function ClearItemsList +/** + * Function ClearItemsList * delete only the list of EDA_BaseStruct * pointers, NOT the pointed data * itself */ @@ -139,7 +141,8 @@ void BLOCK_SELECTOR::ClearItemsList() m_ItemsSelection.ClearItemsList(); } -/** Function ClearListAndDeleteItems +/** + * Function ClearListAndDeleteItems * delete only the list of EDA_BaseStruct * pointers, AND the data pinted * by m_Item */ @@ -148,7 +151,8 @@ void BLOCK_SELECTOR::ClearListAndDeleteItems() m_ItemsSelection.ClearListAndDeleteItems(); } -/** Function PushItem +/** + * Function PushItem * Add aItem to the list of items * @param aItem = an ITEM_PICKER to add to the list */ diff --git a/common/build_version.cpp b/common/build_version.cpp index 18094c212d..8804da762d 100644 --- a/common/build_version.cpp +++ b/common/build_version.cpp @@ -13,7 +13,8 @@ #define VERSION_STABILITY "testing" -/** 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 b4535fe56a..5cd89eedcc 100644 --- a/common/class_marker_base.cpp +++ b/common/class_marker_base.cpp @@ -147,7 +147,8 @@ void MARKER_BASE::DrawMarker( WinEDA_DrawPanel* aPanel, wxDC* aDC, int aDrawMode const wxPoint& aOffset ) /**********************************************************************/ -/** Function DrawMarker +/** + * Function DrawMarker * The shape is the polygon defined in m_Corners (array of wxPoints) */ { @@ -172,7 +173,8 @@ 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 97c88aa0ba..abe64a2724 100644 --- a/common/class_undoredo_container.cpp +++ b/common/class_undoredo_container.cpp @@ -78,7 +78,8 @@ ITEM_PICKER PICKED_ITEMS_LIST::PopItem() } -/** Function ClearItemsList +/** + * Function ClearItemsList * delete only the list of pickers, NOT the picked data itself */ void PICKED_ITEMS_LIST::ClearItemsList() @@ -87,7 +88,8 @@ void PICKED_ITEMS_LIST::ClearItemsList() } -/** Function ClearListAndDeleteItems +/** + * Function ClearListAndDeleteItems * delete the list of pickers, AND the data pointed * by m_PickedItem or m_PickedItemLink, according to the type of undo/redo command recorded */ @@ -161,7 +163,8 @@ void PICKED_ITEMS_LIST::ClearListAndDeleteItems() } -/** function GetItemWrapper +/** + * Function GetItemWrapper * @return the picker of a picked item * @param aIdx = index of the picker in the picked list * if this picker does not exist, a picker is returned, @@ -178,7 +181,8 @@ ITEM_PICKER PICKED_ITEMS_LIST::GetItemWrapper( unsigned int aIdx ) } -/** function GetPickedItem +/** + * Function GetPickedItem * @return a pointer to the picked item, or null if does not exist * @param aIdx = index of the picked item in the picked list */ @@ -191,7 +195,8 @@ EDA_BaseStruct* PICKED_ITEMS_LIST::GetPickedItem( unsigned int aIdx ) } -/** function GetPickedItemLink +/** + * Function GetPickedItemLink * @return link of the picked item, or null if does not exist * @param aIdx = index of the picked item in the picked list */ @@ -204,7 +209,8 @@ EDA_BaseStruct* PICKED_ITEMS_LIST::GetPickedItemLink( unsigned int aIdx ) } -/** function GetPickedItemStatus +/** + * Function GetPickedItemStatus * @return the type of undo/redo opertaion associated to the picked item, * or UR_UNSPECIFIED if does not exist * @param aIdx = index of the picked item in the picked list @@ -217,7 +223,8 @@ UndoRedoOpType PICKED_ITEMS_LIST::GetPickedItemStatus( unsigned int aIdx ) return UR_UNSPECIFIED; } -/** function GetPickerFlags +/** + * Function GetPickerFlags * return the value of the picker flag * @param aIdx = index of the picker in the picked list * @return the value stored in the picker, if the picker exists, or 0 if does not exist @@ -230,7 +237,8 @@ int PICKED_ITEMS_LIST::GetPickerFlags( unsigned aIdx ) return 0; } -/** function SetPickedItem +/** + * Function SetPickedItem * @param aItem = a pointer to the item to pick * @param aIdx = index of the picker in the picked list * @return true if the picker exists, or false if does not exist @@ -247,7 +255,8 @@ bool PICKED_ITEMS_LIST::SetPickedItem( EDA_BaseStruct* aItem, unsigned aIdx ) } -/** function SetPickedItemLink +/** + * Function SetPickedItemLink * Set the link associated to a given picked item * @param aLink = the link to the item associated to the picked item * @param aIdx = index of the picker in the picked list @@ -265,7 +274,8 @@ bool PICKED_ITEMS_LIST::SetPickedItemLink( EDA_BaseStruct* aLink, unsigned aIdx } -/** function SetPickedItem +/** + * Function SetPickedItem * @param aItem = a pointer to the item to pick * @param aStatus = the type of undo/redo operation associated to the item to pick * @param aIdx = index of the picker in the picked list @@ -286,7 +296,8 @@ bool PICKED_ITEMS_LIST::SetPickedItem( EDA_BaseStruct* aItem, } -/** function SetPickedItemStatus +/** + * Function SetPickedItemStatus * Set the the type of undo/redo operation for a given picked item * @param aStatus = the type of undo/redo operation associated to the picked item * @param aIdx = index of the picker in the picked list @@ -302,7 +313,8 @@ bool PICKED_ITEMS_LIST::SetPickedItemStatus( UndoRedoOpType aStatus, unsigned aI else return false; } -/** function SetPickerFlags +/** + * Function SetPickerFlags * Set the flags of the picker (usually to the picked item m_Flags value) * @param aFlags = the value to save in picker * @param aIdx = index of the picker in the picked list @@ -320,7 +332,8 @@ bool PICKED_ITEMS_LIST::SetPickerFlags( int aFlags, unsigned aIdx ) } -/** function RemovePicker +/** + * Function RemovePicker * rem�ove one entry (one picker) from the list of picked items * @param aIdx = index of the picker in the picked list * @return true if ok, or false if did not exist @@ -334,7 +347,8 @@ bool PICKED_ITEMS_LIST::RemovePicker( unsigned aIdx ) } -/** Function CopyList +/** + * Function CopyList * copy all data from aSource * Picked items are not copied. just pointers on them are copied */ @@ -343,7 +357,8 @@ void PICKED_ITEMS_LIST::CopyList( const PICKED_ITEMS_LIST& aSource ) m_ItemsList = aSource.m_ItemsList; // Vector's copy } -/** 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/common.cpp b/common/common.cpp index d925c05d60..92c164b5da 100644 --- a/common/common.cpp +++ b/common/common.cpp @@ -119,7 +119,8 @@ StructColors ColorRefs[NBCOLOR] = { 128, 255, 255, LIGHTYELLOW, wxT( "LIGHTYELLOW" ), LIGHTYELLOW } }; -/** Function to use local notation or C standard notation for floating point numbers +/** + * Function to use local notation or C standard notation for floating point numbers * some countries use 1,5 and others (and C) 1.5 * so we switch from local to C and C to local when reading or writing files * And other problem is a bug when cross compiling under linux: @@ -130,7 +131,8 @@ StructColors ColorRefs[NBCOLOR] = bool g_DisableFloatingPointLocalNotation = false; -/** 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) @@ -147,7 +149,8 @@ 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 separator) @@ -334,7 +337,8 @@ int ReturnValueFromTextCtrl( const wxTextCtrl& TextCtr, 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/common/common_plotDXF_functions.cpp b/common/common_plotDXF_functions.cpp index ecd08c26d1..b755386535 100644 --- a/common/common_plotDXF_functions.cpp +++ b/common/common_plotDXF_functions.cpp @@ -111,7 +111,7 @@ void DXF_PLOTTER::circle( wxPoint centre, int diameter, FILL_T fill, int width ) fprintf( output_file, "0\nVERTEX\n8\n%s\n", CONV_TO_UTF8( cname )); fprintf( output_file, "10\n%d.0\n 20\n%d.0\n42\n1.0\n", centre.x+r,centre.y); fprintf( output_file, "0\nSEQEND\n"); - } + } } } @@ -175,7 +175,8 @@ void DXF_PLOTTER::set_dash( bool dashed ) } -/** Function Plot a filled segment (track) +/** + * Function Plot a filled segment (track) * @param start = starting point * @param end = ending point * @param aWidth = segment width (thickness) diff --git a/common/common_plotGERBER_functions.cpp b/common/common_plotGERBER_functions.cpp index 40530fc427..1c1a4fedce 100644 --- a/common/common_plotGERBER_functions.cpp +++ b/common/common_plotGERBER_functions.cpp @@ -15,7 +15,8 @@ #include "build_version.h" -/** function set_viewport +/** + * Function set_viewport * Set the plot offset for the current plotting * @param aOffset = plot offset * @param aScale = coordinate scale (scale coefficient for coordinates) @@ -34,7 +35,8 @@ void GERBER_PLOTTER::set_viewport( wxPoint offset, } -/** Function start_plot +/** + * Function start_plot * Write GERBER header to file * initialize global variable g_Plot_PlotOutputFile * @param aFile: an opened file to write to @@ -259,7 +261,8 @@ void GERBER_PLOTTER::rect( wxPoint p1, wxPoint p2, FILL_T fill, int width ) } -/** Function circle +/** + * Function circle * writes a non filled circle to output file * Plot one circle as segments (6 to 16 depending on its radius * @param aCentre = center coordinates @@ -290,7 +293,8 @@ void GERBER_PLOTTER::circle( wxPoint aCentre, int aDiameter, FILL_T fill, } -/** Function PlotFilledPolygon_GERBER +/** + * Function PlotFilledPolygon_GERBER * writes a filled polyline to output file * @param aCornersCount = number of corners * @param aCoord = buffer of corners coordinates diff --git a/common/common_plotHPGL_functions.cpp b/common/common_plotHPGL_functions.cpp index f9d02f7249..4214e1d276 100644 --- a/common/common_plotHPGL_functions.cpp +++ b/common/common_plotHPGL_functions.cpp @@ -166,7 +166,8 @@ void HPGL_PLOTTER::set_dash( bool dashed ) } -/** Function Plot a filled segment (track) +/** + * Function Plot a filled segment (track) * @param start = starting point * @param end = ending point * @param aWidth = segment width (thickness) diff --git a/common/common_plotPS_functions.cpp b/common/common_plotPS_functions.cpp index a210a69b1f..ef42e9c987 100644 --- a/common/common_plotPS_functions.cpp +++ b/common/common_plotPS_functions.cpp @@ -168,7 +168,8 @@ void PS_PLOTTER::arc( wxPoint centre, int StAngle, int EndAngle, int radius, } -/** Function poly +/** + * Function poly * @brief Draw a polygon ( a filled polygon if fill == 1 ) in POSTSCRIPT format * @param nb_segm = corner count * @param coord = corner list (a corner uses 2 int = X coordinate followed by Y diff --git a/common/dialog_load_error.cpp b/common/dialog_load_error.cpp index 5bc565d74f..34f279a01a 100644 --- a/common/dialog_load_error.cpp +++ b/common/dialog_load_error.cpp @@ -18,10 +18,11 @@ void DIALOG_LOAD_ERROR::OnCloseButtonClick( wxCommandEvent& event ) void DIALOG_LOAD_ERROR::ListClear(void) { - m_htmlWindow->SetPage(wxEmptyString); + m_htmlWindow->SetPage(wxEmptyString); } -/** Function ListSet +/** + * Function ListSet * Add a list of items. * @param aList = a string containing items. Items are separated by '\n' */ @@ -31,7 +32,7 @@ void DIALOG_LOAD_ERROR::ListSet(const wxString &aList) wxArrayString* strings_list = wxStringSplit( aList, wxChar('\n') ); m_htmlWindow->AppendToPage(wxT("