function comments, fix ones in *.cpp files until they can be deleted if they exist in the headers

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<wxPoint> liste of corners, in physical coordinates
  * @param aZpos = the z position in 3D units

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

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( )

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)

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
  */

common/build_version.cpp

@@ -13,7 +13,8 @@
 #define VERSION_STABILITY       "testing"
 
 
-/** Function GetBuildVersion()
+/**
+ * Function GetBuildVersion()
  * Return the build date and version
  */
 wxString GetBuildVersion()

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 )

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<EFBFBD>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

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 ..)

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)

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

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)

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

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("<ul>") );
-	for ( unsigned ii = 0; ii < strings_list->GetCount(); ii ++ )
+    for ( unsigned ii = 0; ii < strings_list->GetCount(); ii ++ )
     {
         m_htmlWindow->AppendToPage(wxT("<li>") );
         m_htmlWindow->AppendToPage( strings_list->Item(ii) );
@@ -42,14 +43,15 @@ void DIALOG_LOAD_ERROR::ListSet(const wxString &aList)
     delete strings_list;
 }
 
-/** Function ListSet
+/**
+ * Function ListSet
  * Add a list of items.
  * @param aList = a wxArrayString containing items
  */
 void DIALOG_LOAD_ERROR::ListSet(const wxArrayString &aList)
 {
     m_htmlWindow->AppendToPage(wxT("<ul>") );
-	for ( unsigned ii = 0; ii < aList.GetCount(); ii ++ )
+    for ( unsigned ii = 0; ii < aList.GetCount(); ii ++ )
     {
         m_htmlWindow->AppendToPage(wxT("<li>") );
         m_htmlWindow->AppendToPage( aList.Item(ii) );
@@ -58,13 +60,14 @@ void DIALOG_LOAD_ERROR::ListSet(const wxArrayString &aList)
     m_htmlWindow->AppendToPage(wxT("</ul>") );
 }
 
-/** Function MessageSet
+/**
+ * Function MessageSet
  * Add a message (in bold) to message list.
  * @param message = the message
  */
 void DIALOG_LOAD_ERROR::MessageSet(const wxString &message)
 {
-	wxString message_value;
+    wxString message_value;
     message_value.Printf(wxT("<b>%s</b><br>"), GetChars( message ) );
     m_htmlWindow->AppendToPage( message_value );
 }

common/drawframe.cpp

@@ -364,7 +364,8 @@ void WinEDA_DrawFrame::OnSize( wxSizeEvent& SizeEv )
 }
 
 
-/** Function SetToolID
+/**
+ * Function SetToolID
  * Enables the icon of the selected tool in the vertical toolbar.
  * (Or tool ID_NO_SELECT_BUTT default if no new selection)
  * @param aId = new m_ID_current_state value (if aId >= 0)
@@ -552,7 +553,8 @@ void WinEDA_DrawFrame::AdjustScrollBars()
 }
 
 
-/** function SetLanguage
+/**
+ * Function SetLanguage
  * called on a language menu selection
  * when using a derived function, do not forget to call this one
  */

common/drawpanel.cpp

@@ -220,7 +220,8 @@ wxPoint WinEDA_DrawPanel::CursorRealPosition( const wxPoint& aPosition )
 }
 
 
-/** Function IsPointOnDisplay
+/**
+ * Function IsPointOnDisplay
  * @param ref_pos is the position to test in pixels, relative to the panel.
  * @return TRUE if ref_pos is a point currently visible on screen
  *         false if ref_pos is out of screen
@@ -320,7 +321,8 @@ void WinEDA_DrawPanel::ConvertPcbUnitsToPixelsUnits( wxPoint* aPosition )
 }
 
 
-/** Function CursorScreenPosition
+/**
+ * Function CursorScreenPosition
  * @return the cursor current position in pixels in the screen draw area
  */
 wxPoint WinEDA_DrawPanel::CursorScreenPosition()
@@ -335,7 +337,8 @@ wxPoint WinEDA_DrawPanel::CursorScreenPosition()
 }
 
 
-/** Function GetScreenCenterRealPosition()
+/**
+ * Function GetScreenCenterRealPosition()
  * @return position (in internal units) of the current area center showed
  *         on screen
  */
@@ -509,7 +512,8 @@ 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)
@@ -713,7 +717,8 @@ void WinEDA_DrawPanel::ReDraw( wxDC* DC, bool erasebg )
 }
 
 
-/**  Function DrawBackGround
+/**
+ * Function DrawBackGround
  * @param DC = current Device Context
  * Draws (if allowed) :
  * the grid
@@ -750,7 +755,8 @@ void WinEDA_DrawPanel::DrawBackGround( wxDC* DC )
 }
 
 
-/**  Function DrawGrid
+/**
+ * Function DrawGrid
  * @param DC = current Device Context
  * draws the grid
  *  - the grid is drawn only if the zoom level allows a good visibility
@@ -926,7 +932,8 @@ void WinEDA_DrawPanel::DrawGrid( wxDC* DC )
 }
 
 
-/** function DrawAuxiliaryAxis
+/**
+ * Function DrawAuxiliaryAxis
  * Draw the Auxiliary Axis, used in pcbnew which as origin coordinates
  * for gerber and excellon files
  * @param DC = current Device Context

common/drawtxt.cpp

@@ -29,7 +29,8 @@
 double s_HerscheyScaleFactor = HERSHEY_SCALE_FACTOR;
 
 
-/** 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)
  */
@@ -39,7 +40,8 @@ int GetPenSizeForBold( int aTextSize )
 }
 
 
-/** 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
  * so pen width max is aSize/4 for bold text, and aSize/6 for normal text
@@ -78,7 +80,8 @@ int Clamp_Text_PenSize( int aPenSize, wxSize aSize, bool aBold )
  *  substrings between ~ markers can be "negated" (i.e. with an over bar
  */
 
-/** Function NegableTextLength
+/**
+ * Function NegableTextLength
  * Return the text length of a negable string, excluding the ~ markers */
 int NegableTextLength( const wxString& aText )
 {
@@ -198,7 +201,8 @@ static int overbar_position( int size_v, int thickness )
 }
 
 
-/** 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
@@ -493,7 +497,8 @@ void DrawGraphicText( WinEDA_DrawPanel* aPanel,
 }
 
 
-/** Function PlotGraphicText
+/**
+ * Function PlotGraphicText
  *  same as DrawGraphicText, but plot graphic text insteed of draw it
  *  @param aFormat_plot = plot format (PLOT_FORMAT_POST, PLOT_FORMAT_HPGL, PLOT_FORMAT_GERBER)
  *  @param aPos = text position (according to aH_justify, aV_justify)

common/eda_doc.cpp

@@ -68,7 +68,8 @@ static const wxFileTypeInfo EDAfallbacks[] =
 };
 
 
-/** Function GetAssociatedDocument
+/**
+ * Function GetAssociatedDocument
  * open a document (file) with the suitable browser
  * @param aFrame = main frame
  * if DocName is starting by http: or ftp: or www. the default internet

common/edaappl.cpp

@@ -258,7 +258,8 @@ WinEDA_App::~WinEDA_App()
 }
 
 
-/** Function InitEDA_Appl
+/**
+ * Function InitEDA_Appl
  * initialise some general parameters
  *  - Default paths (help, libs, bin)and configuration flies names
  *  - Language and locale
@@ -595,7 +596,8 @@ void WinEDA_App::SetDefaultSearchPaths( void )
 }
 
 
-/** Function GetSettings
+/**
+ * Function GetSettings
  * Get application settings
  * @param aReopenLastUsedDirectory = true to switch to last opened directory, false to use current CWD
  * @return  none
@@ -628,11 +630,11 @@ void WinEDA_App::GetSettings(bool aReopenLastUsedDirectory)
     m_EDA_Config->Read( wxT( "BgColor" ), &g_DrawBgColor );
 
     /* Load per-user search paths from settings file */
-    
+
     wxString   upath;
     int i = 1;
-    while( 1 ) 
-    { 
+    while( 1 )
+    {
         upath = m_EDA_CommonConfig->Read( wxString::Format( wxT( "LibraryPath%d" ), i ), wxT( "" ) );
         if( upath.IsSameAs( wxT( "" ) ) ) break;
         m_libSearchPaths.Add( upath );
@@ -787,7 +789,8 @@ void WinEDA_App::SetLanguagePath( void )
 }
 
 
-/** Function AddMenuLanguageList
+/**
+ * Function AddMenuLanguageList
  * Create menu list for language choice, and add it as submenu to a main menu
  * @param   MasterMenu : The main menu. The sub menu list will be accessible
  *          from the menu item with id ID_LANGUAGE_CHOICE
@@ -1084,7 +1087,8 @@ wxString WinEDA_App::FindLibraryPath( const wxString& aFileName )
 }
 
 
-/** Function RemoveLibraryPath
+/**
+ * Function RemoveLibraryPath
  * Removes the given path(s) from the library path list
  * @param aPaths = path or path list to remove. paths must be separated by ";"
  */
@@ -1103,7 +1107,8 @@ void WinEDA_App::RemoveLibraryPath( const wxString& aPaths )
 }
 
 
-/** Function InsertLibraryPath
+/**
+ * Function InsertLibraryPath
  * insert path(s) int lib paths list.
  * @param aPaths = path or path list to add. paths must be separated by ";"
  * @param aIndex = insertion point

common/gestfich.cpp

@@ -114,7 +114,8 @@ static wxString    s_KicadBinaryPathList[] = {
 };
 
 
-/** Function MakeReducedFileName
+/**
+ * Function MakeReducedFileName
  * Calculate the "reduced" filename from
  * @param  fullfilename = full filename
  * @param  default_path = default path
@@ -180,7 +181,8 @@ wxString MakeReducedFileName( const wxString& fullfilename,
 }
 
 
-/** Function AddDelimiterString
+/**
+ * Function AddDelimiterString
  * Add un " to the start and the end of string (if not already done).
  * @param string = string to modify
  */
@@ -287,7 +289,8 @@ wxString EDA_FileSelector( const wxString& Title,
 }
 
 
-/** Function FindKicadHelpPath
+/**
+ * Function FindKicadHelpPath
  * Find an absolute path for KiCad "help" (or "help/<language>")
  *  Find path kicad/doc/help/xx/ or kicad/doc/help/:
  *  from BinDir
@@ -563,7 +566,8 @@ wxString& WinEDA_App::GetEditorName()
 }
 
 
-/** 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

common/gr_basic.cpp

@@ -624,7 +624,8 @@ void GRSetBrush( wxDC* DC, int Color, int fill )
 }
 
 
-/** function GRForceBlackPen
+/**
+ * Function GRForceBlackPen
  * @param flagforce True to force a black pen whenever the asked color
  */
 void GRForceBlackPen( bool flagforce )
@@ -633,7 +634,8 @@ void GRForceBlackPen( bool flagforce )
 }
 
 
-/** function GetGRForceBlackPenState
+/**
+ * Function GetGRForceBlackPenState
  * @return s_ForceBlackPen (True if  a black pen was forced)
  */
 bool GetGRForceBlackPenState( void )
@@ -898,7 +900,8 @@ void GRSLine( EDA_Rect* ClipBox,
 }
 
 
-/** 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.
@@ -1893,7 +1896,8 @@ void GRSFilledRect( EDA_Rect* ClipBox, wxDC* DC,
 
 #ifdef USE_CLIP_FILLED_POLYGONS
 
-/** Function ClipAndDrawFilledPoly
+/**
+ * Function ClipAndDrawFilledPoly
  *  Used to clip a polygon and draw it as Filled Polygon
  *  uses the Sutherland and Hodgman algo to clip the given poly against a
  *  rectangle.  This rectangle is the drawing area this is useful under

common/hotkeys_basic.cpp

@@ -116,7 +116,8 @@ static struct hotkey_name_descr s_Hotkey_Name_List[] =
 #define MODIFIER_SHIFT  wxT( "Shift+" )
 
 
-/** 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[] )
@@ -169,7 +170,8 @@ wxString ReturnKeyNameFromKeyCode( int aKeycode, bool* aIsFound )
 }
 
 
-/** 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
@@ -198,7 +200,8 @@ wxString AddHotkeyName( const wxString& aText, Ki_HotkeyInfo** aList,
 }
 
 
-/** 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
@@ -237,7 +240,8 @@ wxString AddHotkeyName( const wxString&                        aText,
 }
 
 
-/** 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
@@ -261,7 +265,8 @@ 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[],
@@ -320,7 +325,8 @@ int ReturnKeyCodeFromKeyName( const wxString& keyname )
 }
 
 
-/** function DisplayHotkeyList
+/**
+ * Function DisplayHotkeyList
  * Displays the current hotkey list
  * @param aFrame = current active frame
  * @param aList = pointer to a Ki_HotkeyInfoSectionDescriptor list
@@ -351,7 +357,8 @@ void DisplayHotkeyList( WinEDA_DrawFrame*                      aFrame,
 }
 
 
-/** 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
@@ -370,7 +377,8 @@ Ki_HotkeyInfo* GetDescriptorFromHotkey( int aKey, Ki_HotkeyInfo** aList )
 }
 
 
-/** Function WriteHotkeyConfig
+/**
+ * Function WriteHotkeyConfig
  * Store the current hotkey list
  * It is stored using the standard wxConfig mechanism or a file.
  *
@@ -437,7 +445,8 @@ int WinEDA_BasicFrame::WriteHotkeyConfig( struct Ki_HotkeyInfoSectionDescriptor*
 }
 
 
-/** Function ReadHotkeyConfigFile
+/**
+ * Function ReadHotkeyConfigFile
  * Read an old configuration file (<file>.key) and fill the current hotkey list
  * with hotkeys
  * @param aFilename = file name to read.
@@ -488,7 +497,8 @@ void ReadHotkeyConfig( const wxString&                        Appname,
 }
 
 
-/** Function ReadHotkeyConfig
+/**
+ * Function ReadHotkeyConfig
  * Read configuration data and fill the current hotkey list with hotkeys
  * @param aDescList = current hotkey list descr. to initialise.
  */
@@ -499,7 +509,8 @@ int WinEDA_BasicFrame::ReadHotkeyConfig( struct Ki_HotkeyInfoSectionDescriptor*
 }
 
 
-/** Function ParseHotkeyConfig
+/**
+ * Function ParseHotkeyConfig
  * the input format is: shortcut  "key"  "function"
  * lines starting by # are ignored (comments)
  * lines like [xxx] are tags (example: [common] or [libedit] which identify
@@ -570,7 +581,8 @@ void ParseHotkeyConfig(
 }
 
 
-/** Function ImportHotkeyConfigFromFile
+/**
+ * Function ImportHotkeyConfigFromFile
  * Prompt the user for an old hotkey file to read, and read it.
  * @param aDescList = current hotkey list descr. to initialise.
  */
@@ -598,7 +610,8 @@ void WinEDA_BasicFrame::ImportHotkeyConfigFromFile(
 }
 
 
-/** Function ExportHotkeyConfigToFile
+/**
+ * Function ExportHotkeyConfigToFile
  * Prompt the user for an old hotkey file to read, and read it.
  * @param aDescList = current hotkey list descr. to initialise.
  */

common/projet_config.cpp

@@ -225,7 +225,8 @@ 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
@@ -275,7 +276,8 @@ void WinEDA_App::SaveCurrentSetupValues( PARAM_CFG_ARRAY& List )
 }
 
 
-/** Function ReadProjectConfig
+/**
+ * Function ReadProjectConfig
  *  Read the current "projet" parameters
  *  Parameters are parameters that have the .m_Setup member set to false
  *  read file is the .pro file project
@@ -390,7 +392,8 @@ 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

common/trigo.cpp

@@ -5,7 +5,8 @@
 #include "fctsys.h"
 #include "trigo.h"
 
-/** 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
@@ -22,7 +23,8 @@ bool TestSegmentHit( wxPoint aRefPoint, wxPoint aStart, wxPoint aEnd, int aDist
 }
 
 
-/** Function DistanceTest
+/**
+ * Function DistanceTest
  * Calculate the distance from mouse cursor to a line segment.
  * Returns:
  * False if distance > threshold

common/worksheet.cpp

@@ -1519,7 +1519,8 @@ void WinEDA_DrawFrame::TraceWorkSheet( wxDC* DC, BASE_SCREEN* screen,
 }
 
 
-/** Function GetXYSheetReferences
+/**
+ * Function GetXYSheetReferences
  * Return the X,Y sheet references where the point position is located
  * @param aScreen = screen to use
  * @param aPosition = position to identify by YX ref