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

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

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

common/build_version.cpp

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

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 )

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

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

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)

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

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

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

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

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,

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

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:
      * <p>
@@ -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
      */

eeschema/netlist.h

@@ -140,7 +140,8 @@ extern bool g_OptNetListUseNames;   /* TRUE to use names rather than
 /* Prototypes: */
 void     FreeNetObjectsList( std::vector <NETLIST_OBJECT*>& 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

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)

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,

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,

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

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

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

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,

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

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

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

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

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

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

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

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

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

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)

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

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.

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

include/plot_common.h

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

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

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

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

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

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

pcbnew/board_items_to_polygon_shape_transform.cpp

@@ -80,7 +80,7 @@ void TransformArcToPolygon( std::vector <CPolyPt>& 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 <CPolyPt>& 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

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

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

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)

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.

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

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

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

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

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)

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

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

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

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

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

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

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

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

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

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

pcbnew/specctra.h

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

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

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.

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

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,

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

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

polygon/math_for_graphics.h

@@ -21,7 +21,8 @@ typedef struct EllipseTag
 // 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
@@ -38,7 +39,8 @@ int FindSegmentIntersections( int xi, int yi, int xf, int yf, int style,
 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
@@ -58,7 +60,8 @@ int GetClearanceBetweenSegments( int x1i, int y1i, int x1f, int y1f, int style1,
                                    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

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