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

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

This commit is contained in:
Dick Hollenbeck 2010-11-12 10:36:43 -06:00
parent 5e1bf243d5
commit 636b2d301e
136 changed files with 1841 additions and 1443 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

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

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

3
bitmap2component/bitmap2component.cpp
View File

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

3
common/base_screen.cpp
View File

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

18
common/base_struct.cpp
View File

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

12
common/block_commande.cpp
View File

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

3
common/build_version.cpp
View File

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

6
common/class_marker_base.cpp
View File

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

45
common/class_undoredo_container.cpp
View File

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

12
common/common.cpp
View File

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

5
common/common_plotDXF_functions.cpp
View File

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

12
common/common_plotGERBER_functions.cpp
View File

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

3
common/common_plotHPGL_functions.cpp
View File

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

3
common/common_plotPS_functions.cpp
View File

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

17
common/dialog_load_error.cpp
View File

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

6
common/drawframe.cpp
View File

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

21
common/drawpanel.cpp
View File

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

15
common/drawtxt.cpp
View File

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

3
common/eda_doc.cpp
View File

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

21
common/edaappl.cpp
View File

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

12
common/gestfich.cpp
View File

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

12
common/gr_basic.cpp
View File

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

39
common/hotkeys_basic.cpp
View File

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

9
common/projet_config.cpp
View File

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

6
common/trigo.cpp
View File

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

3
common/worksheet.cpp
View File

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

11
common/zoom.cpp
View File

@ -47,7 +47,7 @@ void WinEDA_DrawFrame::Recadre_Trace( bool ToMouse )
/** Adjust the coordinate to the nearest grid value
* @param aCoord = coordinate to adjust
* @param aGridSize = pointer to a grid value. if NULL uses the current grid size
* @param aGridSize = pointer to a grid value. if NULL uses the current grid size
*/
void WinEDA_DrawFrame::PutOnGrid( wxPoint* aCoord , wxRealPoint* aGridSize )
{
@ -57,12 +57,12 @@ void WinEDA_DrawFrame::PutOnGrid( wxPoint* aCoord , wxRealPoint* aGridSize )
else
grid_size = GetBaseScreen()->GetGridSize();
const wxPoint& grid_origin = GetBaseScreen()->GetGridOrigin();
double offset = fmod(grid_origin.x, grid_size.x);
const wxPoint& grid_origin = GetBaseScreen()->GetGridOrigin();
double offset = fmod(grid_origin.x, grid_size.x);
int tmp = wxRound( (aCoord->x - offset) / grid_size.x );
aCoord->x = wxRound( tmp * grid_size.x + offset );
offset = fmod(grid_origin.y, grid_size.y);
offset = fmod(grid_origin.y, grid_size.y);
tmp = wxRound( (aCoord->y - offset) / grid_size.y );
aCoord->y = wxRound ( tmp * grid_size.y + offset );
}
@ -102,7 +102,8 @@ void WinEDA_DrawFrame::Window_Zoom( EDA_Rect& Rect )
}
/** Function OnZoom
/**
* Function OnZoom
* Called from any zoom event (toolbar , hotkey or popup )
*/
void WinEDA_DrawFrame::OnZoom( wxCommandEvent& event )

9
cvpcb/class_DisplayFootprintsFrame.cpp
View File

@ -535,7 +535,8 @@ void PCB_SCREEN::ClearUndoORRedoList(UNDO_REDO_CONTAINER&, int )
{
}
/** Function IsGridVisible() , virtual
/**
* Function IsGridVisible() , virtual
* @return true if the grid must be shown
*/
bool DISPLAY_FOOTPRINTS_FRAME::IsGridVisible()
@ -543,7 +544,8 @@ bool DISPLAY_FOOTPRINTS_FRAME::IsGridVisible()
return m_DrawGrid;
}
/** Function SetGridVisibility() , virtual
/**
* Function SetGridVisibility() , virtual
* It may be overloaded by derived classes
* if you want to store/retrieve the grid visiblity in configuration.
* @param aVisible = true if the grid must be shown
@ -553,7 +555,8 @@ void DISPLAY_FOOTPRINTS_FRAME::SetGridVisibility(bool aVisible)
m_DrawGrid = aVisible;
}
/** Function GetGridColor() , virtual
/**
* Function GetGridColor() , virtual
* @return the color of the grid
*/
int DISPLAY_FOOTPRINTS_FRAME::GetGridColor()

3
cvpcb/class_components_listbox.cpp
View File

@ -97,7 +97,8 @@ void COMPONENTS_LISTBOX::SetSelection( unsigned index, bool State )
}
/** function OnChar
/**
* Function OnChar
* called on a key pressed
* Call default handler for some special keys,
* and for "ascii" keys, select the first component

3
cvpcb/class_footprints_listbox.cpp
View File

@ -280,7 +280,8 @@ FOOTPRINT* GetModuleDescrByName( const wxString& FootprintName,
}
/** function OnChar
/**
* Function OnChar
* called on a key pressed
* Call default handler for some special keys,
* and for "ascii" keys, select the first footprint

9
eeschema/annotate.cpp
View File

@ -197,7 +197,8 @@ static bool SortByTimeStamp( const OBJ_CMP_TO_LIST& item1,
}
/** Function DeleteAnnotation
/**
* Function DeleteAnnotation
* Remove current component annotations
* @param aCurrentSheetOnly : if false: remove all annotations, else remove
* annotation relative to the current sheet only
@ -347,7 +348,8 @@ 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
@ -984,7 +986,8 @@ static bool SortItemByTimeStamp( const SCH_ITEM* item1, const SCH_ITEM* item2 )
}
/** Function ReplaceDuplicatedTimeStamps
/**
* Function ReplaceDuplicatedTimeStamps
* Search for duplicate time stamps in the whole hierarchy, and replace
* duplicate by new time stamps
*/

6
eeschema/backanno.cpp
View File

@ -17,7 +17,8 @@
#include "sch_component.h"
/** function FillFootprintFieldForAllInstancesofComponent
/**
* Function FillFootprintFieldForAllInstancesofComponent
* Search for component "aReference", and place a Footprint in Footprint field
* @param aReference = reference of the component to initialize
* @param aFootPrint = new value for the filed Footprint component
@ -85,7 +86,8 @@ bool WinEDA_SchematicFrame::FillFootprintFieldForAllInstancesofComponent(
}
/** Function ProcessStuffFile
/**
* Function ProcessStuffFile
* Read a "stuff" file created by cvpcb.
* That file has lines like:
* comp = "C1" module = "CP6"

6
eeschema/class_libentry.cpp
View File

@ -252,7 +252,8 @@ wxString LIB_COMPONENT::GetLibraryName()
}
/** function IsMulti
/**
* Function IsMulti
* @return the sub reference for component having multiple parts per package.
* The sub reference identify the part (or unit)
* @param aUnit = the part identifier ( 1 to 26)
@ -1350,7 +1351,8 @@ LIB_DRAW_ITEM* LIB_COMPONENT::LocateDrawItem( int aUnit, int aConvert,
return NULL;
}
/** Function HitTest (overlaid)
/**
* Function HitTest (overlaid)
* @return true if the point aPosRef is near this object
* @param aPosRef = a wxPoint to test
* @param aThreshold = max distance to this object (usually the half

6
eeschema/controle.cpp
View File

@ -22,7 +22,8 @@
#include "sch_component.h"
/** Function SchematicGeneralLocateAndDisplay
/**
* Function SchematicGeneralLocateAndDisplay
* Overlaid function
* Find the schematic item at cursor position
* the priority order is:
@ -100,7 +101,8 @@ SCH_ITEM* WinEDA_SchematicFrame:: SchematicGeneralLocateAndDisplay( bool Include
}
/** Function SchematicGeneralLocateAndDisplay
/**
* Function SchematicGeneralLocateAndDisplay
* Overlaid function
* Find the schematic item at a given position
* the priority order is:

3
eeschema/dialogs/dialog_erc.cpp
View File

@ -301,7 +301,8 @@ void DIALOG_ERC::ReBuildMatrixPanel()
}
/** Function DisplayERC_MarkersList
/**
* Function DisplayERC_MarkersList
* read the schematic and display the list of ERC markers
*/
void DIALOG_ERC::DisplayERC_MarkersList()

3
eeschema/erc.cpp
View File

@ -152,7 +152,8 @@ static int MinimalReq[PIN_NMAX][PIN_NMAX] =
};
/** Function TestDuplicateSheetNames( )
/**
* Function TestDuplicateSheetNames( )
* inside a given sheet, one cannot have sheets with duplicate names (file
* names can be duplicated).
* @return the error count

12
eeschema/lib_arc.cpp
View File

@ -174,7 +174,8 @@ bool LIB_ARC::HitTest( const wxPoint& aRefPoint )
return HitTest( aRefPoint, mindist, DefaultTransform );
}
/** Function HitTest
/**
* Function HitTest
* @return true if the point aPosRef is near this object
* @param aRefPoint = a wxPoint to test
* @param aThreshold = max distance to this object (usually the half thickness
@ -212,14 +213,14 @@ bool LIB_ARC::HitTest( wxPoint aReferencePoint, int aThreshold, const TRANSFORM&
// relative to the start point to end point vector lies
if( CrossProduct( startEndVector, startRelativePositionVector ) < 0 )
{
EXCHG( crossProductStart, crossProductEnd );
EXCHG( crossProductStart, crossProductEnd );
}
// When the cross products have a different sign, the point lies in sector
// also check, if the reference is near start or end point
return HitTestPoints( m_ArcStart, relativePosition, MINIMUM_SELECTION_DISTANCE ) ||
HitTestPoints( m_ArcEnd, relativePosition, MINIMUM_SELECTION_DISTANCE ) ||
( crossProductStart <= 0 && crossProductEnd >= 0 );
HitTestPoints( m_ArcEnd, relativePosition, MINIMUM_SELECTION_DISTANCE ) ||
( crossProductStart <= 0 && crossProductEnd >= 0 );
}
@ -327,7 +328,8 @@ void LIB_ARC::DoPlot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill,
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int LIB_ARC::GetPenSize()

9
eeschema/lib_bezier.cpp
View File

@ -232,7 +232,8 @@ void LIB_BEZIER::DoPlot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill,
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int LIB_BEZIER::GetPenSize()
@ -311,7 +312,8 @@ bool LIB_BEZIER::HitTest( const wxPoint& aRefPos )
return HitTest( aRefPos, mindist, DefaultTransform );
}
/** Function HitTest
/**
* Function HitTest
* @return if the point aPosRef is near a segment
* @param aPosRef = a wxPoint to test
* @param aThreshold = max distance to a segment
@ -334,7 +336,8 @@ bool LIB_BEZIER::HitTest( wxPoint aPosRef, int aThreshold, const TRANSFORM& aTra
}
/** Function GetBoundingBox
/**
* Function GetBoundingBox
* @return the boundary box for this, in library coordinates
*/
EDA_Rect LIB_BEZIER::GetBoundingBox()

6
eeschema/lib_circle.cpp
View File

@ -85,7 +85,8 @@ bool LIB_CIRCLE::HitTest( const wxPoint& aPosRef )
}
/** Function HitTest
/**
* Function HitTest
* @return true if the point aPosRef is near this object
* @param aPosRef = a wxPoint to test
* @param aThreshold = max distance to this object (usually the half
@ -187,7 +188,8 @@ void LIB_CIRCLE::DoPlot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFill,
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int LIB_CIRCLE::GetPenSize()

6
eeschema/lib_field.cpp
View File

@ -277,7 +277,8 @@ bool LIB_FIELD::Load( char* line, wxString& errorMsg )
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int LIB_FIELD::GetPenSize()
@ -412,7 +413,8 @@ LIB_DRAW_ITEM* LIB_FIELD::DoGenCopy()
}
/** Function Copy
/**
* Function Copy
* copy parameters of this to Target. Pointers are not copied
* @param Target = the LIB_FIELD to set with "this" values
*/

27
eeschema/lib_pin.cpp
View File

@ -541,7 +541,8 @@ bool LIB_PIN::HitTest( const wxPoint& aRefPos )
return HitTest( aRefPos, mindist, DefaultTransform );
}
/** Function HitTest
/**
* Function HitTest
* @return true if the point aPosRef is near a pin
* @param aRefPos = a wxPoint to test
* @param aThreshold = max distance to a segment
@ -791,7 +792,8 @@ bool LIB_PIN::Load( char* line, wxString& errorMsg )
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int LIB_PIN::GetPenSize()
@ -853,7 +855,8 @@ void LIB_PIN::drawGraphic( WinEDA_DrawPanel* aPanel,
}
/** Function DrawPinSymbol
/**
* Function DrawPinSymbol
* Draw the pin symbol (without texts)
* if Color != 0 draw with Color, else with the normal pin color
*/
@ -1489,7 +1492,8 @@ wxPoint LIB_PIN::ReturnPinEndPoint() const
}
/** Function ReturnPinDrawOrient
/**
* Function ReturnPinDrawOrient
* Return the pin real orientation (PIN_UP, PIN_DOWN, PIN_RIGHT, PIN_LEFT),
* according to its orientation and the matrix transform (rot, mirror) TransMat
* @param TransMat = transform matrix
@ -1533,7 +1537,8 @@ int LIB_PIN::ReturnPinDrawOrient( const TRANSFORM& aTransform )
}
/** Function ReturnPinStringNum
/**
* Function ReturnPinStringNum
* fill a buffer with pin num as a wxString
* Pin num is coded as a long or 4 ascii chars
* Used to print/draw the pin num
@ -1545,7 +1550,8 @@ void LIB_PIN::ReturnPinStringNum( wxString& aStringBuffer ) const
}
/** Function ReturnPinStringNum (static function)
/**
* Function ReturnPinStringNum (static function)
* Pin num is coded as a long or 4 ascii chars
* @param aPinNum = a long containing a pin num
* @return aStringBuffer = the wxString to store the pin num as an unicode string
@ -1563,7 +1569,8 @@ wxString LIB_PIN::ReturnPinStringNum( long aPinNum )
}
/** Function LIB_PIN::SetPinNumFromString()
/**
* Function LIB_PIN::SetPinNumFromString()
* fill the buffer with pin num as a wxString
* Pin num is coded as a long
* Used to print/draw the pin num
@ -1688,7 +1695,8 @@ void LIB_PIN::DoPlot( PLOTTER* plotter, const wxPoint& offset, bool fill,
}
/** Function LIB_PIN::DisplayInfo
/**
* Function LIB_PIN::DisplayInfo
* Displays info (pin num and name, orientation ...
* on the Info window
*/
@ -1728,7 +1736,8 @@ void LIB_PIN::DisplayInfo( WinEDA_DrawFrame* frame )
}
/** Function LIB_PIN::GetBoundingBox
/**
* Function LIB_PIN::GetBoundingBox
* @return the boundary box for this, in schematic coordinates
*/
EDA_Rect LIB_PIN::GetBoundingBox()

9
eeschema/lib_polyline.cpp
View File

@ -230,7 +230,8 @@ void LIB_POLYLINE::AddPoint( const wxPoint& point )
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int LIB_POLYLINE::GetPenSize()
@ -329,7 +330,8 @@ bool LIB_POLYLINE::HitTest( const wxPoint& aRefPos )
}
/** Function HitTest
/**
* Function HitTest
* @return true if the point aPosRef is near a segment
* @param aPosRef = a wxPoint to test
* @param aThreshold = max distance to a segment
@ -352,7 +354,8 @@ bool LIB_POLYLINE::HitTest( wxPoint aPosRef, int aThreshold, const TRANSFORM& aT
}
/** Function GetBoundingBox
/**
* Function GetBoundingBox
* @return the boundary box for this, in library coordinates
*/
EDA_Rect LIB_POLYLINE::GetBoundingBox()

6
eeschema/lib_rectangle.cpp
View File

@ -162,7 +162,8 @@ void LIB_RECTANGLE::DoPlot( PLOTTER* aPlotter, const wxPoint& aOffset, bool aFil
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int LIB_RECTANGLE::GetPenSize()
@ -257,7 +258,8 @@ bool LIB_RECTANGLE::HitTest( const wxPoint& aRefPoint )
}
/** Function HitTest
/**
* Function HitTest
* @return true if the point aPosRef is near this object
* @param aRefPoint = a wxPoint to test
* @param aThreshold = max distance to this object (usually the half thickness

6
eeschema/lib_text.cpp
View File

@ -148,7 +148,8 @@ bool LIB_TEXT::HitTest( const wxPoint& refPos )
}
/** Function HitTest
/**
* Function HitTest
* @return true if the point aPosRef is near this item
* @param aPosRef = a wxPoint to test, in eeschema space
* @param aThreshold = unused here (TextHitTest calculates its threshold )
@ -269,7 +270,8 @@ void LIB_TEXT::DoPlot( PLOTTER* plotter, const wxPoint& offset, bool fill,
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int LIB_TEXT::GetPenSize( )

6
eeschema/libedit_plot_component.cpp
View File

@ -18,7 +18,8 @@
#include "class_library.h"
/** function OnPlotCurrentComponent
/**
* Function OnPlotCurrentComponent
* plot in SVG or PNG format the curren component
*/
void WinEDA_LibeditFrame::OnPlotCurrentComponent( wxCommandEvent& event )
@ -90,7 +91,8 @@ void WinEDA_LibeditFrame::OnPlotCurrentComponent( wxCommandEvent& event )
}
/** function CreatePNGorJPEGFile
/**
* Function CreatePNGorJPEGFile
* Create an image (screenshot) of the current component.
* Output file format is png or jpeg
* @param aFileName = the full filename

9
eeschema/libeditframe.cpp
View File

@ -952,7 +952,8 @@ void WinEDA_LibeditFrame::SetLanguage( wxCommandEvent& event )
}
/** Function TempCopyComponent
/**
* Function TempCopyComponent
* create a temporary copy of the current edited component
* Used to prepare an Undo ant/or abort command before editing the component
*/
@ -965,7 +966,8 @@ void WinEDA_LibeditFrame::TempCopyComponent()
m_tempCopyComponent = new LIB_COMPONENT( *m_component );
}
/** Function RestoreComponent
/**
* Function RestoreComponent
* Restore the current edited component from its temporary copy.
* Used to abort a command
*/
@ -979,7 +981,8 @@ void WinEDA_LibeditFrame::RestoreComponent()
m_tempCopyComponent = NULL;
}
/** Function ClearTempCopyComponent
/**
* Function ClearTempCopyComponent
* delete temporary copy of the current component and clear pointer
*/
void WinEDA_LibeditFrame::ClearTempCopyComponent()

11
eeschema/locate.cpp
View File

@ -123,7 +123,8 @@ SCH_ITEM* PickStruct( const wxPoint& refpos,
}
/** Function PickStruct
/**
* Function PickStruct
* Search items in a block
* @return items count
* @param aBlock a BLOCK_SELECTOR that gives the search area boundary
@ -417,11 +418,11 @@ bool IsItemInBox( EDA_Rect& aBox, SCH_ITEM* DrawStruct )
break;
case DRAW_JUNCTION_STRUCT_TYPE:
#undef STRUCT
#undef STRUCT
#define STRUCT ( (SCH_JUNCTION*) DrawStruct )
if( aBox.Inside(STRUCT->m_Pos) )
return true;
break;
if( aBox.Inside(STRUCT->m_Pos) )
return true;
break;
case DRAW_NOCONNECT_STRUCT_TYPE:
case TYPE_SCH_LABEL:

11
eeschema/netlist.cpp
View File

@ -307,7 +307,8 @@ void WinEDA_SchematicFrame::BuildNetListBase()
}
/** function FindBestNetNameForEachNet
/**
* Function FindBestNetNameForEachNet
* fill the .m_NetNameCandidate member of each item of aNetItemBuffer
* with a reference to the "best" NETLIST_OBJECT usable to give a name to the net
* If no suitable object found, .m_NetNameCandidate is filled with 0.
@ -359,7 +360,8 @@ void FindBestNetNameForEachNet( NETLIST_OBJECT_LIST& aNetItemBuffer )
}
}
/** Function FindBestNetName
/**
* Function FindBestNetName
* @return a reference to the "best" label that can be used to give a name
* to a net.
* @param aLabelItemBuffer = list of NETLIST_OBJECT type labels candidates.
@ -422,7 +424,7 @@ static NETLIST_OBJECT* FindBestNetName( NETLIST_OBJECT_LIST& aLabelItemBuffer )
// for other labels, we select them before by sheet deep order
// because the actual name is /sheetpath/label
// and for a given path length, by alphabetic order
if( item_priority >= PRIO_MAX-1 ) // global label or pin label
{ // selection by alphabetic order:
if( candidate->m_Label.Cmp( item->m_Label ) < 0 )
@ -488,7 +490,8 @@ static void SheetLabelConnect( NETLIST_OBJECT* SheetLabel )
}
/** Function AddConnectedObjects
/**
* Function AddConnectedObjects
* Creates the list of objects related to connections (pins of components,
* wires, labels, junctions ...)
*

18
eeschema/netlist_control.cpp
View File

@ -38,7 +38,8 @@ int TestDuplicateSheetNames( bool aCreateMarker );
wxString ReturnUserNetlistTypeName( bool first_item )
/****************************************************/
/** 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
@ -442,7 +443,8 @@ void WinEDA_NetlistFrame::NetlistUpdateOpt()
void WinEDA_NetlistFrame::GenNetlist( wxCommandEvent& event )
/**********************************************************/
/** Function GenNetlist
/**
* Function GenNetlist
* Create the netlist file:
* calculate the filename with the suitable extensions
* and run the netlist creator
@ -509,7 +511,8 @@ void WinEDA_NetlistFrame::GenNetlist( wxCommandEvent& event )
}
/** Function CreateNetlist
/**
* Function CreateNetlist
* Create a netlist file:
* build netlist info
* test issues
@ -605,7 +608,8 @@ void WinEDA_NetlistFrame::RunSimulator( wxCommandEvent& event )
void WinEDA_NetlistFrame::WriteCurrentNetlistSetup( void )
/*********************************************************/
/** Function WriteCurrentNetlistSetup
/**
* Function WriteCurrentNetlistSetup
* Write the current netlist options setup in the configuration
*/
{
@ -648,7 +652,8 @@ void WinEDA_NetlistFrame::WriteCurrentNetlistSetup( void )
void WinEDA_NetlistFrame::DeletePluginPanel( wxCommandEvent& event )
/******************************************************************/
/** Function DeletePluginPanel
/**
* Function DeletePluginPanel
* Remove a panel relative to a netlist plugin
*/
{
@ -671,7 +676,8 @@ void WinEDA_NetlistFrame::DeletePluginPanel( wxCommandEvent& event )
void WinEDA_NetlistFrame::ValidatePluginPanel( wxCommandEvent& event )
/******************************************************************/
/** Function ValidatePluginPanel
/**
* Function ValidatePluginPanel
* Validate the panel info relative to a new netlist plugin
*/
{

3
eeschema/onleftclick.cpp
View File

@ -313,7 +313,8 @@ void WinEDA_SchematicFrame::OnLeftClick( wxDC* DC, const wxPoint& MousePos )
}
/** Function OnLeftDClick
/**
* Function OnLeftDClick
* called on a double click event from the drawpanel mouse handler
* if an editable item is found (text, component)
* Call the suitable dialog editor.

9
eeschema/operations_on_items_lists.cpp
View File

@ -58,7 +58,8 @@ void Mirror_X_ListOfItems( PICKED_ITEMS_LIST& aItemsList, wxPoint& aMirrorPoint
}
/** Function MoveItemsInList
/**
* Function MoveItemsInList
* Move a list of items to a given move vector
* @param aItemsList = list of picked items
* @param aMoveVector = the move vector value
@ -73,7 +74,8 @@ void MoveItemsInList( PICKED_ITEMS_LIST& aItemsList, const wxPoint aMoveVector )
}
/** function DeleteItemsInList
/**
* Function DeleteItemsInList
* delete schematic items in aItemsList
* deleted items are put in undo list
*/
@ -206,7 +208,8 @@ void DuplicateItemsInList( SCH_SCREEN* screen, PICKED_ITEMS_LIST& aItemsList,
}
/** function DuplicateStruct
/**
* Function DuplicateStruct
* Routine to create a new copy of given struct.
* The new object is not put in draw list (not linked)
* @param aDrawStruct = the SCH_ITEM to duplicate

12
eeschema/sch_component.cpp
View File

@ -409,7 +409,8 @@ void SCH_COMPONENT::SetRef( SCH_SHEET_PATH* sheet, const wxString& ref )
}
/** function SetTimeStamp
/**
* Function SetTimeStamp
* Change the old time stamp to the new time stamp.
* the time stamp is also modified in paths
* @param aNewTimeStamp = new time stamp
@ -855,7 +856,8 @@ 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,
@ -1478,7 +1480,8 @@ void SCH_COMPONENT::DisplayInfo( WinEDA_DrawFrame* frame )
}
/** virtual function Mirror_Y
/**
* Function Mirror_Y (virtual)
* mirror item relative to an Y axis
* @param aYaxis_position = the y axis position
*/
@ -1501,7 +1504,8 @@ void SCH_COMPONENT::Mirror_Y( int aYaxis_position )
}
/** virtual function Mirror_X
/**
* Function Mirror_X (virtual)
* mirror item relative to an X axis
* @param aXaxis_position = the x axis position
*/

3
eeschema/sch_field.cpp
View File

@ -49,7 +49,8 @@ SCH_FIELD::~SCH_FIELD()
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int SCH_FIELD::GetPenSize()

18
eeschema/sch_items.cpp
View File

@ -153,7 +153,8 @@ EDA_Rect SCH_BUS_ENTRY::GetBoundingBox()
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int SCH_BUS_ENTRY::GetPenSize()
@ -321,7 +322,8 @@ EDA_Rect SCH_JUNCTION::GetBoundingBox()
}
/** Function HitTest
/**
* Function HitTest
* @return true if the point aPosRef is within item area
* @param aPosRef = a wxPoint to test
*/
@ -334,7 +336,8 @@ bool SCH_JUNCTION::HitTest( const wxPoint& aPosRef )
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
* has no meaning for SCH_JUNCTION
*/
@ -519,7 +522,8 @@ bool SCH_NO_CONNECT::Load( LINE_READER& aLine, wxString& aErrorMsg )
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int SCH_NO_CONNECT::GetPenSize()
@ -752,7 +756,8 @@ bool SCH_LINE::Load( LINE_READER& aLine, wxString& aErrorMsg )
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int SCH_LINE::GetPenSize()
@ -1082,7 +1087,8 @@ bool SCH_POLYLINE::Load( LINE_READER& aLine, wxString& aErrorMsg )
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int SCH_POLYLINE::GetPenSize()

3
eeschema/sch_screen.cpp
View File

@ -326,7 +326,8 @@ bool SCH_SCREEN::Save( FILE* aFile ) const
}
/** Function ClearUndoORRedoList
/**
* Function ClearUndoORRedoList
* free the undo or redo list from List element
* Wrappers are deleted.
* datas pointed by wrappers are deleted if not in use in schematic

42
eeschema/sch_sheet.cpp
View File

@ -55,7 +55,8 @@ SCH_SHEET::~SCH_SHEET()
}
/** Function Save
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.brd" format.
* @param aFile The FILE to write to.
* @return bool - true if success writing else false.
@ -483,7 +484,8 @@ SCH_SHEET_PIN* SCH_SHEET::GetLabel( const wxPoint& aPosition )
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int SCH_SHEET::GetPenSize()
@ -492,7 +494,8 @@ int SCH_SHEET::GetPenSize()
}
/** function GetSheetNamePosition
/**
* Function GetSheetNamePosition
* @return the position of the anchor of sheet name text
*/
wxPoint SCH_SHEET::GetSheetNamePosition()
@ -511,7 +514,8 @@ wxPoint SCH_SHEET::GetSheetNamePosition()
return pos;
}
/** function GetFileNamePosition
/**
* Function GetFileNamePosition
* @return the position of the anchor of filename text
*/
wxPoint SCH_SHEET::GetFileNamePosition()
@ -531,7 +535,8 @@ wxPoint SCH_SHEET::GetFileNamePosition()
}
/** Function Draw
/**
* Function Draw
* Draw the hierarchical sheet shape
* @param aPanel = the current DrawPanel
* @param aDc = the current Device Context
@ -603,7 +608,8 @@ void SCH_SHEET::Draw( WinEDA_DrawPanel* aPanel, wxDC* aDC,
}
/** Function GetBoundingBox
/**
* Function GetBoundingBox
* @return an EDA_Rect giving the bounding box of the sheet
*/
EDA_Rect SCH_SHEET::GetBoundingBox()
@ -626,7 +632,8 @@ EDA_Rect SCH_SHEET::GetBoundingBox()
}
/** Function HitTest
/**
* Function HitTest
* @return true if the point aPosRef is within item area
* @param aPosRef = a wxPoint to test
*/
@ -638,7 +645,8 @@ bool SCH_SHEET::HitTest( const wxPoint& aPosRef )
}
/** Function ComponentCount
/**
* Function ComponentCount
* count our own components, without the power components.
* @return the component count.
*/
@ -669,7 +677,8 @@ int SCH_SHEET::ComponentCount()
}
/** Function SearchHierarchy
/**
* Function SearchHierarchy
* search the existing hierarchy for an instance of screen "FileName".
* @param aFilename = the filename to find
* @param aFilename = a location to return a pointer to the screen (if found)
@ -703,7 +712,8 @@ bool SCH_SHEET::SearchHierarchy( wxString aFilename, SCH_SCREEN** aScreen )
}
/** Function LocatePathOfScreen
/**
* Function LocatePathOfScreen
* search the existing hierarchy for an instance of screen "FileName".
* don't bother looking at the root sheet - it must be unique,
* no other references to its m_AssociatedScreen otherwise there would be
@ -738,7 +748,8 @@ bool SCH_SHEET::LocatePathOfScreen( SCH_SCREEN* aScreen, SCH_SHEET_PATH* aList )
}
/** Function Load.
/**
* Function Load.
* for the sheet: load the file m_FileName
* if a screen already exists, the file is already read.
* m_AssociatedScreen point on the screen, and its m_RefCount is incremented
@ -787,7 +798,8 @@ bool SCH_SHEET::Load( WinEDA_SchematicFrame* aFrame )
}
/** Function CountSheets
/**
* Function CountSheets
* calculates the number of sheets found in "this"
* this number includes the full subsheets count
* @return the full count of sheets+subsheets contained by "this"
@ -818,7 +830,8 @@ wxString SCH_SHEET::GetFileName( void )
}
/** Function ChangeFileName
/**
* Function ChangeFileName
* Set a new filename and manage data and associated screen
* The main difficulty is the filename change in a complex hierarchy.
* - if new filename is not already used: change to the new name (and if an
@ -976,7 +989,8 @@ void SCH_SHEET::Mirror_X( int aXaxis_position )
}
/** virtual function Mirror_Y
/**
* Function Mirror_Y (virtual)
* mirror item relative to an Y axis
* @param aYaxis_position = the y axis position
*/

36
eeschema/sch_sheet_path.cpp
View File

@ -36,7 +36,8 @@ SCH_SHEET_PATH::SCH_SHEET_PATH()
}
/** Function BuildSheetPathInfoFromSheetPathValue
/**
* Function BuildSheetPathInfoFromSheetPathValue
* Fill this with data to access to the hierarchical sheet known by its path
* aPath
* @param aPath = path of the sheet to reach (in non human readable format)
@ -73,7 +74,8 @@ bool SCH_SHEET_PATH::BuildSheetPathInfoFromSheetPathValue( const wxString& aPath
}
/** Function Cmp
/**
* Function Cmp
* Compare if this is the same sheet path as aSheetPathToTest
* @param aSheetPathToTest = sheet path to compare
* @return -1 if different, 0 if same
@ -100,7 +102,8 @@ int SCH_SHEET_PATH::Cmp( const SCH_SHEET_PATH& aSheetPathToTest ) const
}
/** Function Last
/**
* Function Last
* returns a pointer to the last sheet of the list
* One can see the others sheet as the "path" to reach this last sheet
*/
@ -112,7 +115,8 @@ SCH_SHEET* SCH_SHEET_PATH::Last()
}
/** Function LastScreen
/**
* Function LastScreen
* @return the SCH_SCREEN relative to the last sheet in list
*/
SCH_SCREEN* SCH_SHEET_PATH::LastScreen()
@ -124,7 +128,8 @@ SCH_SCREEN* SCH_SHEET_PATH::LastScreen()
}
/** Function LastScreen
/**
* Function LastScreen
* @return a pointer to the first schematic item handled by the
* SCH_SCREEN relative to the last sheet in list
*/
@ -160,7 +165,8 @@ SCH_ITEM* SCH_SHEET_PATH::FirstDrawList()
}
/** Function Push
/**
* Function Push
* store (push) aSheet in list
* @param aSheet = pointer to the SCH_SHEET to store in list
*/
@ -181,7 +187,8 @@ void SCH_SHEET_PATH::Push( SCH_SHEET* aSheet )
}
/** Function Pop
/**
* Function Pop
* retrieves (pop) the last entered sheet and remove it from list
* @return a SCH_SHEET* pointer to the removed sheet in list
*/
@ -196,7 +203,8 @@ SCH_SHEET* SCH_SHEET_PATH::Pop()
}
/** Function Path
/**
* Function Path
* the path uses the time stamps which do not changes even when editing sheet
* parameters
* a path is something like / (root) or /34005677 or /34005677/00AE4523
@ -220,7 +228,8 @@ wxString SCH_SHEET_PATH::Path()
}
/** Function PathHumanReadable
/**
* Function PathHumanReadable
* Return the sheet path in a readable form, i.e.
* as a path made from sheet names.
* (the "normal" path uses the time stamps which do not changes even when
@ -436,7 +445,8 @@ SCH_SHEET_LIST::SCH_SHEET_LIST( SCH_SHEET* aSheet )
}
/** Function GetFirst
/**
* Function GetFirst
* @return the first item (sheet) in m_List and prepare calls to GetNext()
*/
SCH_SHEET_PATH* SCH_SHEET_LIST::GetFirst()
@ -448,7 +458,8 @@ SCH_SHEET_PATH* SCH_SHEET_LIST::GetFirst()
}
/** Function GetNext
/**
* Function GetNext
* @return the next item (sheet) in m_List or NULL if no more item in sheet
* list
*/
@ -482,7 +493,8 @@ SCH_SHEET_PATH* SCH_SHEET_LIST::GetPrevious()
}
/** Function GetSheet
/**
* Function GetSheet
* @return the item (sheet) in aIndex position in m_List or NULL if less than
* index items
* @param aIndex = index in sheet list to get the sheet

6
eeschema/sch_sheet_pin.cpp
View File

@ -98,7 +98,8 @@ bool SCH_SHEET_PIN::operator==( const SCH_SHEET_PIN* aPin ) const
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int SCH_SHEET_PIN::GetPenSize()
@ -329,7 +330,8 @@ bool SCH_SHEET_PIN::Load( LINE_READER& aLine, wxString& aErrorMsg )
}
/** function Matches
/**
* Function Matches
* Compare hierarchical pin name against search string.
* @param aSearchData - Criteria to search against.
* @param aAuxData - a pointer on auxiliary data, not used here

60
eeschema/sch_text.cpp
View File

@ -87,7 +87,8 @@ SCH_TEXT::SCH_TEXT( const wxPoint& pos, const wxString& text, KICAD_T aType ) :
}
/** Function HitTest
/**
* Function HitTest
* @return true if the point aPosRef is within item area
* @param aPosRef = a wxPoint to test
*/
@ -137,7 +138,8 @@ SCH_TEXT* SCH_TEXT::GenCopy()
}
/** function GetSchematicTextOffset (virtual)
/**
* Function GetSchematicTextOffset (virtual)
* @return the offset between the SCH_TEXT position and the text itself
* position
* This offset depend on orientation, and the type of text
@ -187,7 +189,8 @@ bool SCH_TEXT::Matches( wxFindReplaceData& aSearchData, void* aAuxData, wxPoint
}
/** virtual function Mirror_Y
/**
* Function Mirror_Y (virtual)
* mirror item relative to an Y axis
* @param aYaxis_position = the y axis position
*/
@ -232,7 +235,8 @@ void SCH_TEXT::Mirror_Y( int aYaxis_position )
}
/** virtual function Mirror_X
/**
* Function Mirror_X (virtual)
* mirror item relative to an X axis
* @param aXaxis_position = the x axis position
*/
@ -310,7 +314,8 @@ void SCH_TEXT::Rotate( wxPoint rotationPoint )
}
/** function SetTextOrientAndJustifyParmeters (virtual)
/**
* Function SetTextOrientAndJustifyParmeters (virtual)
* Set m_SchematicOrientation, and initialize
* m_orient,m_HJustified and m_VJustified, according to the value of
* m_SchematicOrientation
@ -394,7 +399,8 @@ void SCH_TEXT::Place( WinEDA_SchematicFrame* frame, wxDC* DC )
}
/** Function GetPenSize
/**
* Function GetPenSize
* @return the size of the "pen" that be used to draw or plot this item
*/
int SCH_TEXT::GetPenSize()
@ -693,7 +699,8 @@ void SCH_TEXT::Show( int nestLevel, std::ostream& os )
#endif
/** function GetSchematicTextOffset (virtual)
/**
* Function GetSchematicTextOffset (virtual)
* @return the offset between the SCH_TEXT position and the text itself
* position
* This offset depend on orientation, and the type of text
@ -705,7 +712,8 @@ wxPoint SCH_LABEL::GetSchematicTextOffset()
}
/** function SetTextOrientAndJustifyParmeters
/**
* Function SetTextOrientAndJustifyParmeters
* Set m_SchematicOrientation, and initialize
* m_orient,m_HJustified and m_VJustified, according to the value of
* m_SchematicOrientation (for a label)
@ -733,7 +741,8 @@ SCH_LABEL::SCH_LABEL( const wxPoint& pos, const wxString& text ) :
}
/** virtual function Mirror_X
/**
* Function Mirror_X (virtual)
* mirror item relative to an X axis
* @param aXaxis_position = the x axis position
*/
@ -846,7 +855,8 @@ bool SCH_LABEL::Load( LINE_READER& aLine, wxString& aErrorMsg )
}
/** Function SCH_LABEL::Draw
/**
* Function SCH_LABEL::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,
@ -1003,7 +1013,8 @@ bool SCH_GLOBALLABEL::Load( LINE_READER& aLine, wxString& aErrorMsg )
}
/** Function HitTest
/**
* Function HitTest
* @return true if the point aPosRef is within item area
* @param aPosRef = a wxPoint to test
*/
@ -1015,7 +1026,8 @@ bool SCH_GLOBALLABEL::HitTest( const wxPoint& aPosRef )
}
/** virtual function Mirror_Y
/**
* Function Mirror_Y (virtual)
* mirror item relative to an Y axis
* @param aYaxis_position = the y axis position
*/
@ -1069,7 +1081,8 @@ void SCH_GLOBALLABEL::Rotate( wxPoint rotationPoint )
}
/** function GetSchematicTextOffset (virtual)
/**
* Function GetSchematicTextOffset (virtual)
* @return the offset between the SCH_TEXT position and the text itself
* position
* This offset depend on orientation, and the type of text
@ -1124,7 +1137,8 @@ wxPoint SCH_GLOBALLABEL::GetSchematicTextOffset()
}
/** function SetTextOrientAndJustifyParmeters
/**
* Function SetTextOrientAndJustifyParmeters
* Set m_SchematicOrientation, and initialize
* m_orient,m_HJustified and m_VJustified, according to the value of
* m_SchematicOrientation
@ -1212,7 +1226,8 @@ void SCH_GLOBALLABEL::Draw( WinEDA_DrawPanel* panel,
}
/** function CreateGraphicShape
/**
* Function CreateGraphicShape
* Calculates the graphic shape (a polygon) associated to the text
* @param aCorner_list = a buffer to fill with polygon corners coordinates
* @param Pos = Position of the shape
@ -1451,7 +1466,8 @@ bool SCH_HIERLABEL::Load( LINE_READER& aLine, wxString& aErrorMsg )
}
/** Function HitTest
/**
* Function HitTest
* @return true if the point aPosRef is within item area
* @param aPosRef = a wxPoint to test
*/
@ -1463,7 +1479,8 @@ bool SCH_HIERLABEL::HitTest( const wxPoint& aPosRef )
}
/** function SetTextOrientAndJustifyParmeters
/**
* Function SetTextOrientAndJustifyParmeters
* Set m_SchematicOrientation, and initialize
* m_orient,m_HJustified and m_VJustified, according to the value of
* m_SchematicOrientation
@ -1552,7 +1569,8 @@ void SCH_HIERLABEL::Draw( WinEDA_DrawPanel* panel,
}
/** Function CreateGraphicShape
/**
* Function CreateGraphicShape
* calculates the graphic shape (a polygon) associated to the text
* @param aCorner_list = a buffer to fill with polygon corners coordinates
* @param Pos = Postion of the shape
@ -1631,7 +1649,8 @@ EDA_Rect SCH_HIERLABEL::GetBoundingBox()
}
/** function GetSchematicTextOffset (virtual)
/**
* Function GetSchematicTextOffset (virtual)
* @return the offset between the SCH_TEXT position and the text itself
* position
* This offset depend on orientation, and the type of text
@ -1668,7 +1687,8 @@ wxPoint SCH_HIERLABEL::GetSchematicTextOffset()
}
/** virtual function Mirror_Y
/**
* Function Mirror_Y (virtual)
* mirror item relative to an Y axis
* @param aYaxis_position = the y axis position
*/

15
eeschema/schematic_undo_redo.cpp
View File

@ -183,7 +183,8 @@ void SwapData( EDA_BaseStruct* aItem, EDA_BaseStruct* aImage )
}
/** function SaveCopyInUndoList
/**
* Function SaveCopyInUndoList
* Create a copy of the current schematic item, and put it in the undo list.
*
* flag_type_command =
@ -269,7 +270,8 @@ void WinEDA_SchematicFrame::SaveCopyInUndoList( SCH_ITEM* aItem,
}
/** function SaveCopyInUndoList
/**
* Function SaveCopyInUndoList
* @param aItemsList = a PICKED_ITEMS_LIST of items to save
* @param aTypeCommand = type of command ( UR_CHANGED, UR_NEW, UR_DELETED ...
*/
@ -342,7 +344,8 @@ 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
@ -440,7 +443,8 @@ void WinEDA_SchematicFrame::PutDataInPreviousState( PICKED_ITEMS_LIST* aList,
}
/** Function GetSchematicFromUndoList
/**
* Function GetSchematicFromUndoList
* Undo the last edition:
* - Save the current schematic in Redo list
* - Get the previous version of the schematic from undo list
@ -472,7 +476,8 @@ void WinEDA_SchematicFrame::GetSchematicFromUndoList( wxCommandEvent& event )
}
/** Function GetSchematicFromRedoList
/**
* Function GetSchematicFromRedoList
* Redo the last edition:
* - Save the current schematic in undo list
* - Get the previous version from Redo list

12
eeschema/schframe.cpp
View File

@ -261,7 +261,8 @@ SCH_SHEET_PATH* WinEDA_SchematicFrame::GetSheet()
}
/** Function SetSheetNumberAndCount
/**
* Function SetSheetNumberAndCount
* Set the m_ScreenNumber and m_NumberOfScreen members for screens
* must be called after a delete or add sheet command, and when entering a
* sheet
@ -421,7 +422,8 @@ int WinEDA_SchematicFrame::BestZoom()
}
/** Function GetUniqueFilenameForCurrentSheet
/**
* Function GetUniqueFilenameForCurrentSheet
* @return a filename that can be used in plot and print functions
* for the current screen and sheet path.
* This filename is unique and must be used insteed of the screen filename
@ -462,7 +464,8 @@ wxString WinEDA_SchematicFrame::GetUniqueFilenameForCurrentSheet()
return filename;
}
/** 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
@ -749,7 +752,8 @@ void WinEDA_SchematicFrame::OnExit( wxCommandEvent& event )
Close( true );
}
/** function SetLanguage
/**
* Function SetLanguage
* called on a language menu selection
*/
void WinEDA_SchematicFrame::SetLanguage( wxCommandEvent& event )

3
eeschema/viewlibs.cpp
View File

@ -242,7 +242,8 @@ void WinEDA_ViewlibFrame::ViewOneLibraryContent( CMP_LIBRARY* Lib, int Flag )
}
/** function RedrawActiveWindow
/**
* Function RedrawActiveWindow
* Display the current selected component.
* If the component is an alias, the ROOT component is displayed
*/

12
gerbview/class_GERBER.cpp
View File

@ -220,7 +220,8 @@ void GERBER_IMAGE::InitToolTable()
}
/** function ReportMessage
/**
* Function ReportMessage
* Add a message (a string) in message list
* for instance when reading a Gerber file
* @param aMessage = the straing to add in list
@ -231,7 +232,8 @@ void GERBER_IMAGE::ReportMessage( const wxString aMessage )
}
/** function ClearMessageList
/**
* Function ClearMessageList
* Clear the message list
* Call it before reading a Gerber file
*/
@ -241,7 +243,8 @@ void GERBER_IMAGE::ClearMessageList()
}
/** Function StepAndRepeatItem
/**
* Function StepAndRepeatItem
* Gerber format has a command Step an Repeat
* This function must be called when reading a gerber file and
* after creating a new gerber item that must be repeated
@ -276,7 +279,8 @@ void GERBER_IMAGE::StepAndRepeatItem( const GERBER_DRAW_ITEM& aItem )
}
/** Function DisplayImageInfo
/**
* Function DisplayImageInfo
* has knowledge about the frame and how and where to put status information
* about this object into the frame's message panel.
* Display info about Image Parameters.

9
gerbview/class_aperture_macro.cpp
View File

@ -124,7 +124,8 @@ int AM_PRIMITIVE::GetExposure(GERBER_DRAW_ITEM* aParent) const
return (int) params[0].GetValue( aParent->GetDcodeDescr() );
}
/** function DrawBasicShape
/**
* Function DrawBasicShape
* Draw the primitive shape for flashed items.
*/
void AM_PRIMITIVE::DrawBasicShape( GERBER_DRAW_ITEM* aParent,
@ -414,7 +415,8 @@ void AM_PRIMITIVE::DrawBasicShape( GERBER_DRAW_ITEM* aParent,
}
/** function ConvertShapeToPolygon (virtual)
/**
* Function ConvertShapeToPolygon (virtual)
* convert a shape to an equivalent polygon.
* Arcs and circles are approximated by segments
* Useful when a shape is not a graphic primitive (shape with hole,
@ -717,7 +719,8 @@ int AM_PRIMITIVE::GetShapeDim( GERBER_DRAW_ITEM* aParent )
}
/** function DrawApertureMacroShape
/**
* Function DrawApertureMacroShape
* Draw the primitive shape for flashed items.
* When an item is flashed, this is the shape of the item
*/

15
gerbview/class_gerber_draw_item.cpp
View File

@ -170,7 +170,8 @@ wxPoint GERBER_DRAW_ITEM::GetXYPosition( const wxPoint& aABPosition )
}
/** function SetLayerParameters
/**
* Function SetLayerParameters
* Initialize draw parameters from Image and Layer parameters
* found in the gerber file:
* m_UnitsMetric,
@ -299,7 +300,8 @@ void GERBER_DRAW_ITEM::MoveXY( const wxPoint& aMoveVector )
}
/** function Save.
/**
* Function Save.
* currently: no nothing, but must be defined to meet requirements
* of the basic class
*/
@ -458,7 +460,8 @@ void GERBER_DRAW_ITEM::Draw( WinEDA_DrawPanel* aPanel, wxDC* aDC, int aDrawMode,
}
}
/** function ConvertSegmentToPolygon
/**
* Function ConvertSegmentToPolygon
* convert a line to an equivalent polygon.
* Useful when a line is plotted using a rectangular pen.
* In this case, the usual segment plot cannot be used
@ -521,7 +524,8 @@ void GERBER_DRAW_ITEM::ConvertSegmentToPolygon( )
}
/** function DrawGbrPoly
/**
* Function DrawGbrPoly
* a helper function used id ::Draw to draw the polygon stored in m_PolyCorners
* Draw filled polygons
*/
@ -544,7 +548,8 @@ void GERBER_DRAW_ITEM::DrawGbrPoly( EDA_Rect* aClipBox,
}
/** Function DisplayInfo
/**
* Function DisplayInfo
* has knowledge about the frame and how and where to put status information
* about this object into the frame's message panel.
* Display info about this GERBER item

3
gerbview/class_gerbview_layer_widget.cpp
View File

@ -94,7 +94,8 @@ GERBER_LAYER_WIDGET::GERBER_LAYER_WIDGET( WinEDA_GerberFrame* aParent, wxWindow*
// using installRightLayerClickHandler
}
/** Function SetLayersManagerTabsText
/**
* Function SetLayersManagerTabsText
* Update the layer manager tabs labels
* Useful when changing Language or to set labels to a non default value
*/

12
gerbview/dcode.cpp
View File

@ -136,7 +136,8 @@ int D_CODE::GetShapeDim( GERBER_DRAW_ITEM* aParent )
}
/** Function Read_D_Code_File
/**
* Function Read_D_Code_File
* Can be useful only with old RS274D Gerber file format.
* Is not needed with RS274X files format.
* These files need an auxiliary DCode file description. There is no defined file format for this.
@ -325,7 +326,8 @@ void WinEDA_GerberFrame::CopyDCodesSizeToItems()
}
/** function DrawFlashedShape
/**
* Function DrawFlashedShape
* Draw the dcode shape for flashed items.
* When an item is flashed, the DCode shape is the shape of the item
*/
@ -440,7 +442,8 @@ void D_CODE::DrawFlashedShape( GERBER_DRAW_ITEM* aParent,
}
/** function DrawFlashedPolygon
/**
* Function DrawFlashedPolygon
* a helper function used id ::Draw to draw the polygon stored ion m_PolyCorners
* Draw some Apertures shapes when they are defined as filled polygons.
* APT_POLYGON is always a polygon, but some complex shapes are also converted to
@ -475,7 +478,8 @@ static void addHoleToPolygon( std::vector<wxPoint>& aBuffer,
wxSize aSize,
wxPoint aAnchorPos );
/** function ConvertShapeToPolygon
/**
* Function ConvertShapeToPolygon
* convert a shape to an equivalent polygon.
* Arcs and circles are approximated by segments
* Useful when a shape is not a graphic primitive (shape with hole,

3
gerbview/dialogs/dialog_gerber_config.cpp
View File

@ -51,7 +51,8 @@ BEGIN_EVENT_TABLE( WinEDA_ConfigFrame, wxDialog )
END_EVENT_TABLE()
/** Function InstallConfigFrame
/**
* Function InstallConfigFrame
* install the dialog box to configure some gerbview options
* mainly the default file extensions
*/

3
gerbview/draw_gerber_screen.cpp
View File

@ -21,7 +21,8 @@
static void Show_Items_DCode_Value( WinEDA_DrawPanel* panel, wxDC* DC,
BOARD* Pcb, int drawmode );
/** virtual Function PrintPage
/**
* Function PrintPage (virtual)
* 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

18
gerbview/gerberframe.cpp
View File

@ -340,7 +340,8 @@ void WinEDA_GerberFrame::ReFillLayerWidget()
syncLayerWidget();
}
/** Function IsGridVisible() , virtual
/**
* Function IsGridVisible() , virtual
* @return true if the grid must be shown
*/
bool WinEDA_GerberFrame::IsGridVisible()
@ -348,7 +349,8 @@ bool WinEDA_GerberFrame::IsGridVisible()
return IsElementVisible( GERBER_GRID_VISIBLE );
}
/** Function SetGridVisibility() , virtual
/**
* Function SetGridVisibility() , virtual
* It may be overloaded by derived classes
* if you want to store/retrieve the grid visiblity in configuration.
* @param aVisible = true if the grid must be shown
@ -358,7 +360,8 @@ void WinEDA_GerberFrame::SetGridVisibility(bool aVisible)
SetElementVisibility(GERBER_GRID_VISIBLE, aVisible);
}
/** Function GetGridColor() , virtual
/**
* Function GetGridColor() , virtual
* @return the color of the grid
*/
int WinEDA_GerberFrame::GetGridColor()
@ -366,7 +369,8 @@ int WinEDA_GerberFrame::GetGridColor()
return GetBoard()->GetVisibleElementColor( GERBER_GRID_VISIBLE );
}
/** Function SetGridColor() , virtual
/**
* Function SetGridColor() , virtual
* @param aColor = the new color of the grid
*/
void WinEDA_GerberFrame::SetGridColor(int aColor)
@ -407,7 +411,8 @@ void WinEDA_GerberFrame::syncLayerBox()
UpdateTitleAndInfo();
}
/** function SetLanguage
/**
* Function SetLanguage
* called on a language menu selection
* Update Layer manager title and tabs texts
*/
@ -484,7 +489,8 @@ void WinEDA_GerberFrame::Liste_D_Codes( )
return;
}
/** function UpdateTitleAndInfo
/**
* Function UpdateTitleAndInfo
* displays the short filename (if exists) of the selected layer
* on the caption of the main gerbview window
* displays image name and the last layer name (found in the gerber file: LN <name> command)

3
gerbview/options.cpp
View File

@ -16,7 +16,8 @@
#include "gerbview_id.h"
/** Function OnSelectOptionToolbar
/**
* Function OnSelectOptionToolbar
* called to validate current choices
*/
void WinEDA_GerberFrame::OnSelectOptionToolbar( wxCommandEvent& event )

6
gerbview/rs274x.cpp
View File

@ -798,7 +798,8 @@ bool GetEndOfBlock( char buff[GERBER_BUFZ], char*& text, FILE* gerber_file )
return FALSE;
}
/** function GetNextLine
/**
* Function GetNextLine
* test for an end of line
* if an end of line is found:
* read a new line
@ -1002,7 +1003,8 @@ bool GERBER_IMAGE::ReadApertureMacro( char buff[GERBER_BUFZ],
return true;
}
/** Function ReadMacroParam
/**
* Function ReadMacroParam
* Read one aperture macro parameter
* a parameter can be:
* a number

3
gerbview/toolbars_gerber.cpp
View File

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

6
kicad/commandframe.cpp
View File

@ -64,7 +64,8 @@ END_EVENT_TABLE()
void RIGHT_KM_FRAME::CreateCommandToolbar( void )
/*************************************************/
/** Function CreateCommandToolbar
/**
* Function CreateCommandToolbar
* create the buttons to call eescheman cvpcb, pcbnew and gerbview
*/
{
@ -88,7 +89,8 @@ Creates a component (for Eeschema) or a footprint (for Pcbnew) that shows a B&W
}
/** Function AddBitmapButton
/**
* Function AddBitmapButton
* add a Bitmap Button (fast launch button) to the buttons panel
* @param aId = the button id
* @param aBitmap = the wxBitmap used to create the button

9
kicad/tree_project_frame.cpp
View File

@ -494,7 +494,8 @@ wxString TREE_PROJECT_FRAME::GetFileWildcard( TreeFileType type )
}
/** function AddFile
/**
* Function AddFile
* @brief Add filename "name" to the tree \n
* if name is a directory, add the sub directory file names
* @param aName = the filename or the dirctory name to add
@ -964,7 +965,8 @@ void TREE_PROJECT_FRAME::OnExpand( wxTreeEvent& Event )
}
}
/** function GetSelectedData
/**
* Function GetSelectedData
* return the item data from item currently selected (highlighted)
* Note this is not necessary the "clicked" item,
* because when expanding, collapsing an item this item is not selected
@ -974,7 +976,8 @@ TREEPROJECT_ITEM* TREE_PROJECT_FRAME::GetSelectedData()
return dynamic_cast<TREEPROJECT_ITEM*>( m_TreeProject->GetItemData( m_TreeProject->GetSelection() ) );
}
/** function GetItemIdData
/**
* Function GetItemIdData
* return the item data corresponding to a wxTreeItemId identifier
* @param aId = the wxTreeItemId identifier.
* @return a TREEPROJECT_ITEM pointer correspondinfg to item id aId

3
pcbnew/basepcbframe.cpp
View File

@ -432,7 +432,8 @@ 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

6
pcbnew/block.cpp
View File

@ -20,7 +20,8 @@
#define BLOCK_OUTLINE_COLOR YELLOW
/** Function drawPickedItems
/**
* Function drawPickedItems
* draws items currently selected in a block
* @param aPanel = Current draw panel
* @param aDC = Current device context
@ -28,7 +29,8 @@
**/
static void drawPickedItems( WinEDA_DrawPanel* aPanel, wxDC* aDC,
wxPoint aOffset );
/** Function drawMovingBlock
/**
* Function drawMovingBlock
* handles drawing of a moving block
* @param aPanel = Current draw panel
* @param aDC = Current device context

24
pcbnew/board_items_to_polygon_shape_transform.cpp
View File

@ -15,7 +15,8 @@
/* Exported functions */
/** Function TransformRoundedEndsSegmentToPolygon
/**
* Function TransformRoundedEndsSegmentToPolygon
* convert a segment with rounded ends to a polygon
* Convert arcs to multiple straight lines
* @param aCornerBuffer = a buffer to store the polygon
@ -30,7 +31,8 @@ void TransformRoundedEndsSegmentToPolygon( std::vector <CPolyPt>& aCornerBuffer,
int aWidth );
/** Function TransformArcToPolygon
/**
* Function TransformArcToPolygon
* Creates a polygon from an Arc
* Convert arcs to multiple straight segments
* @param aCornerBuffer = a buffer to store the polygon
@ -77,7 +79,8 @@ void TransformArcToPolygon( std::vector <CPolyPt>& aCornerBuffer,
}
/** Function TEXTE_PCB::TransformShapeWithClearanceToPolygon
/**
* Function TEXTE_PCB::TransformShapeWithClearanceToPolygon
* Convert the track shape to a closed polygon
* Used in filling zones calculations
* Circles and arcs are approximated by segments
@ -123,7 +126,8 @@ void TEXTE_PCB::TransformShapeWithClearanceToPolygon(
}
/** Function DRAWSEGMENT::TransformShapeWithClearanceToPolygon
/**
* Function DRAWSEGMENT::TransformShapeWithClearanceToPolygon
* Convert the track shape to a closed polygon
* Used in filling zones calculations
* Circles and arcs are approximated by segments
@ -164,7 +168,8 @@ void DRAWSEGMENT::TransformShapeWithClearanceToPolygon(
}
}
/** Function EDGE_MODULE::TransformShapeWithClearanceToPolygon
/**
* Function EDGE_MODULE::TransformShapeWithClearanceToPolygon
* Convert the track shape to a closed polygon
* Used in filling zones calculations
* Circles and arcs are approximated by segments
@ -209,7 +214,8 @@ void EDGE_MODULE::TransformShapeWithClearanceToPolygon(
}
/** Function TRACK::TransformShapeWithClearanceToPolygon
/**
* Function TRACK::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
@ -344,7 +350,8 @@ void TransformRoundedEndsSegmentToPolygon( std::vector <CPolyPt>& aCornerBuffer,
}
/** function D_PAD::TransformShapeWithClearanceToPolygon
/**
* Function D_PAD::TransformShapeWithClearanceToPolygon
* Convert the pad shape to a closed polygon
* Used in filling zones calculations
* Circles and arcs are approximated by segments
@ -544,7 +551,8 @@ void D_PAD:: TransformShapeWithClearanceToPolygon( std:: vector < CPolyPt>& aCor
}
/** function CreateThermalReliefPadPolygon
/**
* Function CreateThermalReliefPadPolygon
* Add holes around a pad to create a thermal relief
* copper thickness is min (dx/2, aCopperWitdh) or min (dy/2, aCopperWitdh)
* @param aCornerBuffer = a buffer to store the polygon

24
pcbnew/board_undo_redo.cpp
View File

@ -62,7 +62,8 @@
BOARD_ITEM* DuplicateStruct( BOARD_ITEM* aItem );
/** function TestForExistingItem
/**
* Function TestForExistingItem
* test if aItem exists somewhere in lists of items
* This is a function unsed by PutDataInPreviousState to be sure an item was not deleted
* since an undo or redo.
@ -110,7 +111,8 @@ static bool TestForExistingItem( BOARD* aPcb, BOARD_ITEM* aItem )
void SwapData( BOARD_ITEM* aItem, BOARD_ITEM* aImage )
/***************************************************************/
/** Function SwapData
/**
* Function SwapData
* Used in undo / redo command:
* swap data between Item and a copy
* swapped data is data modified by edition, mainly sizes and texts
@ -330,7 +332,8 @@ void WinEDA_PcbFrame::SaveCopyInUndoList( BOARD_ITEM* aItem,
const wxPoint& aTransformPoint )
/***********************************************************************/
/** function SaveCopyInUndoList
/**
* Function SaveCopyInUndoList
* Create a copy of the current schematic item, and put it in the undo list.
*
* flag_type_command =
@ -397,7 +400,8 @@ void WinEDA_PcbFrame::SaveCopyInUndoList( BOARD_ITEM* aItem,
}
/** function SaveCopyInUndoList
/**
* Function SaveCopyInUndoList
* @param aItemsList = a PICKED_ITEMS_LIST of items to save
* @param aTypeCommand = type of comand ( UR_CHANGED, UR_NEW, UR_DELETED ...
*/
@ -469,7 +473,8 @@ 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
@ -579,7 +584,8 @@ void WinEDA_PcbFrame::PutDataInPreviousState( PICKED_ITEMS_LIST* aList, bool aRe
void WinEDA_PcbFrame::GetBoardFromUndoList( wxCommandEvent& event )
/**********************************************************/
/** Function GetBoardFromUndoList
/**
* Function GetBoardFromUndoList
* Undo the last edition:
* - Save the current board state in Redo list
* - Get an old version of the board state from Undo list
@ -606,7 +612,8 @@ void WinEDA_PcbFrame::GetBoardFromUndoList( wxCommandEvent& event )
}
/** Function GetBoardFromRedoList
/**
* Function GetBoardFromRedoList
* Redo the last edition:
* - Save the current board in Undo list
* - Get an old version of the board from Redo list
@ -640,7 +647,8 @@ void WinEDA_PcbFrame::GetBoardFromRedoList( wxCommandEvent& event )
void PCB_SCREEN::ClearUndoORRedoList( UNDO_REDO_CONTAINER& aList, int aItemCount )
/**********************************************************************************/
/** Function ClearUndoORRedoList
/**
* Function ClearUndoORRedoList
* free the undo or redo list from List element
* Wrappers are deleted.
* datas pointed by wrappers are deleted if not in use in schematic

12
pcbnew/class_board.cpp
View File

@ -141,7 +141,8 @@ bool BOARD::SetCurrentNetClass( const wxString& aNetClassName )
}
/** function GetBiggestClearanceValue
/**
* Function GetBiggestClearanceValue
* @return the biggest clearance value found in NetClasses list
*/
int BOARD::GetBiggestClearanceValue()
@ -161,7 +162,8 @@ int BOARD::GetBiggestClearanceValue()
}
/** function GetCurrentMicroViaSize
/**
* Function GetCurrentMicroViaSize
* @return the current micro via size,
* that is the current netclass value
*/
@ -173,7 +175,8 @@ int BOARD::GetCurrentMicroViaSize()
}
/** function GetCurrentMicroViaDrill
/**
* Function GetCurrentMicroViaDrill
* @return the current micro via drill,
* that is the current netclass value
*/
@ -738,7 +741,8 @@ 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

3
pcbnew/class_board_connected_item.cpp
View File

@ -140,7 +140,8 @@ NETCLASS* BOARD_CONNECTED_ITEM::GetNetClass() const
return board->m_NetClasses.GetDefault();
}
/** function GetNetClassName
/**
* Function GetNetClassName
* @return the Net Class name of this item
*/
wxString BOARD_CONNECTED_ITEM::GetNetClassName( ) const

3
pcbnew/class_dimension.cpp
View File

@ -411,7 +411,8 @@ out:
}
/** function AdjustDimensionDetails
/**
* Function AdjustDimensionDetails
* Calculate coordinates of segments used to draw the dimension.
* @param aDoNotChangeText (bool) if false, the dimension text is initialized
*/

6
pcbnew/class_module.cpp
View File

@ -176,7 +176,8 @@ void MODULE::Copy( MODULE* aModule )
}
/** Function Draw
/**
* Function Draw
* Draws the footprint to the current Device Context
* @param panel = The active Draw Panel (used to know the clip box)
* @param DC = current Device Context
@ -234,7 +235,8 @@ void MODULE::Draw( WinEDA_DrawPanel* panel, wxDC* DC,
}
/** Function DrawEdgesOnly
/**
* Function DrawEdgesOnly
* Draws the footprint edges only to the current Device Context
* @param panel = The active Draw Panel (used to know the clip box)
* @param DC = current Device Context

6
pcbnew/class_netinfo_item.cpp
View File

@ -102,7 +102,8 @@ void NETINFO_ITEM::SetNetname( const wxString& aNetname )
}
/** function Draw (TODO)
/**
* Function Draw (TODO)
*/
void NETINFO_ITEM::Draw( WinEDA_DrawPanel* panel,
wxDC* DC,
@ -185,7 +186,8 @@ RATSNEST_ITEM::RATSNEST_ITEM()
}
/** function Draw
/**
* Function Draw
* Draws a line (a ratsnest) from the starting pad to the ending pad
*/
void RATSNEST_ITEM::Draw( WinEDA_DrawPanel* panel,

9
pcbnew/class_netinfolist.cpp
View File

@ -23,7 +23,8 @@ NETINFO_LIST::~NETINFO_LIST()
}
/** Function GetItem
/**
* Function GetItem
* @param aNetcode = netcode to identify a given NETINFO_ITEM
* @return a NETINFO_ITEM pointer to the selected NETINFO_ITEM by its netcode, or NULL if not found
*/
@ -35,7 +36,8 @@ NETINFO_ITEM* NETINFO_LIST::GetNetItem( int aNetcode )
}
/** Function DeleteData
/**
* Function DeleteData
* delete the list of nets (and free memory)
*/
void NETINFO_LIST::DeleteData()
@ -156,7 +158,8 @@ void NETINFO_LIST::BuildListOfNets()
void NETINFO_LIST::Build_Pads_Full_List()
/*****************************************/
/** Function Build_Pads_Full_List
/**
* Function Build_Pads_Full_List
* Create the pad list, sorted by net names (sorted by an alphabetic case sensitive sort)
* initialise:
* m_Pads (list of pads)

6
pcbnew/class_pad.cpp
View File

@ -246,7 +246,8 @@ int D_PAD::GetClearance( BOARD_CONNECTED_ITEM* aItem ) const
// Mask margins handling:
/** Function GetSolderMaskMargin
/**
* Function GetSolderMaskMargin
* @return the margin for the solder mask layer
* usually > 0 (mask shape bigger than pad
* value is
@ -283,7 +284,8 @@ int D_PAD::GetSolderMaskMargin()
}
/** Function GetSolderPasteMargin
/**
* Function GetSolderPasteMargin
* @return the margin for the solder mask layer
* usually < 0 (mask shape smaller than pad
* value is

9
pcbnew/class_pad_draw_functions.cpp
View File

@ -348,7 +348,8 @@ void D_PAD::Draw( WinEDA_DrawPanel* aPanel, wxDC* aDC, int aDraw_mode,
}
/** function DrawShape
/**
* Function DrawShape
* basic function to draw a pad.
* used by D_PAD::Draw after calculation of parameters (color, final orientation ...)
* this function can be called to draw a pad on a panel
@ -620,7 +621,8 @@ void D_PAD::DrawShape( EDA_Rect* aClipBox, wxDC* aDC, PAD_DRAWINFO& aDrawInfo )
}
}
/** function BuildSegmentFromOvalShape
/**
* Function BuildSegmentFromOvalShape
* Has meaning only for OVAL (and ROUND) pads.
* Build an equivalent segment having the same shape as the OVAL shape,
* aSegStart and aSegEnd are the ending points of the equivalent segment of the shape
@ -657,7 +659,8 @@ int D_PAD::BuildSegmentFromOvalShape(wxPoint& aSegStart, wxPoint& aSegEnd, int a
return width;
}
/** function BuildPadPolygon
/**
* Function BuildPadPolygon
* Has meaning only for polygonal pads (trapeziod and rectangular)
* Build the Corner list of the polygonal shape,
* depending on shape, extra size (clearance ...) and orientation

3
pcbnew/class_pcb_layer_widget.cpp
View File

@ -199,7 +199,8 @@ void PCB_LAYER_WIDGET::onPopupSelection( wxCommandEvent& event )
}
}
/** Function SetLayersManagerTabsText
/**
* Function SetLayersManagerTabsText
* Update the layer manager tabs labels
* Useful when changing Language or to set labels to a non default value
*/

6
pcbnew/class_pcb_text.cpp
View File

@ -55,7 +55,8 @@ void TEXTE_PCB::Copy( TEXTE_PCB* source )
}
/** Function ReadTextePcbDescr
/**
* Function ReadTextePcbDescr
* Read a text description from pcb file.
*
* For a single line text:
@ -179,7 +180,8 @@ bool TEXTE_PCB::Save( FILE* aFile ) const
}
/** Function Draw
/**
* Function Draw
* DrawMode = GR_OR, GR_XOR ..
* Like tracks, texts are drawn in filled or sketch mode, never in line mode
* because the line mode does not keep the actual size of the text

6
pcbnew/class_text_mod.cpp
View File

@ -245,7 +245,8 @@ void TEXTE_MODULE:: SetLocalCoord()
}
/** Function GetTextRect
/**
* Function GetTextRect
* @return an EDA_Rect which gives the position and size of the text area
* (for the footprint orientation)
*/
@ -322,7 +323,8 @@ EDA_Rect TEXTE_MODULE::GetBoundingBox()
}
/** Function Draw
/**
* Function Draw
* Draw the text according to the footprint pos and orient
* @param panel = draw panel, Used to know the clip box
* @param DC = Current Device Context

16
pcbnew/class_zone.cpp
View File

@ -44,9 +44,10 @@ ZONE_CONTAINER::~ZONE_CONTAINER()
/** virtual function GetPosition
* @return a wxPoint, position of the first point of the outline
*/
/**
* Function GetPosition (virtual)
* @return a wxPoint, position of the first point of the outline
*/
wxPoint& ZONE_CONTAINER::GetPosition()
{
static wxPoint pos;
@ -216,7 +217,8 @@ bool ZONE_CONTAINER::Save( FILE* aFile ) const
int ZONE_CONTAINER::ReadDescr( FILE* aFile, int* aLineNum )
/**********************************************************/
/** Function ReadDescr
/**
* Function ReadDescr
* @param aFile = opened file
* @param aLineNum = pointer on a line number counter (can be NULL or missing)
* @return 1 if ok or 0
@ -431,7 +433,8 @@ int ZONE_CONTAINER::ReadDescr( FILE* aFile, int* aLineNum )
void ZONE_CONTAINER::Draw( WinEDA_DrawPanel* panel, wxDC* DC, int draw_mode, const wxPoint& offset )
/****************************************************************************************************/
/** Function Draw
/**
* Function Draw
* @param panel = current Draw Panel
* @param DC = current Device Context
* @param offset = Draw offset (usually wxPoint(0,0))
@ -1121,7 +1124,8 @@ void ZONE_CONTAINER::Mirror( const wxPoint& mirror_ref )
}
/** Function copy
/**
* Function copy
* copy usefull data from the source.
* flags and linked list pointers are NOT copied
*/

6
pcbnew/class_zone_setting.cpp
View File

@ -40,7 +40,8 @@ ZONE_SETTING::ZONE_SETTING( void )
}
/** function ImportSetting
/**
* Function ImportSetting
* copy settings from a given zone
* @param aSource: the given zone
*/
@ -59,7 +60,8 @@ void ZONE_SETTING::ImportSetting( const ZONE_CONTAINER& aSource )
}
/** function ExportSetting
/**
* Function ExportSetting
* copy settings to a given zone
* @param aTarget: the given zone
* @param aFullExport: if false: some parameters are NOT exported

3
pcbnew/clean.cpp
View File

@ -731,7 +731,8 @@ static TRACK* AlignSegment( BOARD* Pcb, TRACK* pt_ref, TRACK* pt_segm, int extre
}
/** Function RemoveMisConnectedTracks
/**
* Function RemoveMisConnectedTracks
* finds all track segments which are mis-connected (to more than one net).
* When such a bad segment is found, mark it as needing to be removed.
* and remove all tracks having at least one flagged segment.

12
pcbnew/connect.cpp
View File

@ -27,7 +27,8 @@ static void RebuildTrackChain( BOARD* pcb );
static int Merge_Two_SubNets( TRACK* pt_start_conn, TRACK* pt_end_conn, int old_val, int new_val )
/**************************************************************************************************/
/** 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
@ -89,7 +90,8 @@ static int Merge_Two_SubNets( TRACK* pt_start_conn, TRACK* pt_end_conn, int old_
static void Propagate_SubNet( TRACK* pt_start_conn, TRACK* pt_end_conn )
/******************************************************************/
/** Function Propagate_SubNet
/**
* Function Propagate_SubNet
* Test a list of track segment, to create or propagate a sub netcode to pads and segments connected together
* the track list must be sorted by nets, and all segments from pt_start_conn to pt_end_conn have the same net
* When 2 items are connected (a track to a pad, or a track to an other track) they are grouped in a cluster.
@ -267,7 +269,8 @@ static void Propagate_SubNet( TRACK* pt_start_conn, TRACK* pt_end_conn )
void WinEDA_BasePcbFrame::test_connexions( wxDC* DC )
/***************************************************/
/** Function testing the connections relative to all nets
/**
* Function testing the connections relative to all nets
* This function update the status of the ratsnest ( flag CH_ACTIF = 0 if a connection is found, = 1 else)
* track segments are assumed to be sorted by net codes.
* This is the case because when a new track is added, it is inserted in the linked list according to its net code.
@ -310,7 +313,8 @@ void WinEDA_BasePcbFrame::test_connexions( wxDC* DC )
void WinEDA_BasePcbFrame::test_1_net_connexion( wxDC* DC, int net_code )
/*************************************************************************/
/** Function testing the connections relative to a given net
/**
* Function testing the connections relative to a given net
* track segments are assumed to be sorted by net codes
* @param DC = current Device Context
* @param net_code = net code to test

3
pcbnew/dialog_copper_zones.cpp
View File

@ -177,7 +177,8 @@ void dialog_copper_zone::OnButtonCancelClick( wxCommandEvent& event )
bool dialog_copper_zone::AcceptOptions( bool aPromptForErrors, bool aUseExportableSetupOnly )
/********************************************************************************************/
/** Function dialog_copper_zone::AcceptOptions(
/**
* Function dialog_copper_zone::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)

6
pcbnew/dialog_design_rules.cpp
View File

@ -85,7 +85,8 @@ wxString NETS_LIST_CTRL::OnGetItemText( long item, long column ) const
}
/** Function setRowItems
/**
* Function setRowItems
* Initialize the net name and the net class name at row aRow
* @param aRow = row index (if aRow > number of stored row, empty rows will be created)
* @param aNetname = the string to display in row aRow, column 0
@ -489,7 +490,8 @@ 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()

6
pcbnew/dialog_orient_footprints.cpp
View File

@ -218,7 +218,8 @@ wxIcon dialog_orient_footprints::GetIconResource( const wxString& name )
/***********************************************/
void WinEDA_PcbFrame::OnOrientFootprints( void )
/***********************************************/
/** function OnOrientFootprints
/**
* Function OnOrientFootprints
* install the dialog box for the comman Orient Footprints
*/
{
@ -232,7 +233,8 @@ void WinEDA_PcbFrame::OnOrientFootprints( void )
void WinEDA_PcbFrame::ReOrientModules( const wxString& ModuleMask,
int Orient, bool include_fixe )
/*******************************************************************/
/** function ReOrientModules
/**
* Function ReOrientModules
* Set the orientation of footprints
* @param ModuleMask = mask (wildcard allowed) selection
* @param Orient = new orientation

5
pcbnew/dragsegm.cpp
View File

@ -182,7 +182,7 @@ void Collect_TrackSegmentsToDrag( WinEDA_DrawPanel* panel, wxDC* DC,
continue; // already put in list
int flag = 0;
if( (track->m_Start == aRefPos) && ((track->m_Flags & STARTPOINT) == 0) )
flag |= STARTPOINT;
@ -205,7 +205,8 @@ void Collect_TrackSegmentsToDrag( WinEDA_DrawPanel* panel, wxDC* DC,
}
/** function EraseDragList
/**
* Function EraseDragList
* clear the .m_Flags of all track segments found in g_DragSegmentList
* and clear the list.
* the memory is not freed and will be reused when creating a new list

9
pcbnew/edgemod.cpp
View File

@ -124,7 +124,8 @@ static void ShowEdgeModule( WinEDA_DrawPanel* panel, wxDC* DC, bool erase )
}
/** Function Edit_Edge_Width
/**
* Function Edit_Edge_Width
* changes the width of module perimeter lines, EDGE_MODULEs.
* param ModuleSegmentWidth (global) = new width
* @param aEdge = edge to edit, or NULL. If aEdge == NULL change
@ -207,7 +208,8 @@ void WinEDA_ModuleEditFrame::Edit_Edge_Layer( EDGE_MODULE* Edge )
}
/** function Enter_Edge_Width
/**
* Function Enter_Edge_Width
* Edition of the edge items width
* Ask for a new width.
* Change the width of EDGE_MODULE Edge if aEdge != NULL
@ -236,7 +238,8 @@ void WinEDA_ModuleEditFrame::Enter_Edge_Width( EDGE_MODULE* aEdge )
}
/** Function Delete_Edge_Module
/**
* Function Delete_Edge_Module
* delete EDGE_MODULE Edge
* @param Edge = edge to delete
*/

12
pcbnew/edit_track_width.cpp
View File

@ -15,7 +15,8 @@
#include "protos.h"
/** Function SetTrackSegmentWidth
/**
* Function SetTrackSegmentWidth
* Modify one track segment width or one via diameter and drill (using DRC control).
* Basic routine used by other routines when editing tracks or vias
* @param aTrackItem = the track segment or via to modify
@ -96,7 +97,8 @@ bool WinEDA_PcbFrame::SetTrackSegmentWidth( TRACK* aTrackItem,
}
/** Function Edit_TrackSegm_Width
/**
* Function Edit_TrackSegm_Width
* Modify one track segment width or one via diameter (using DRC control).
* @param DC = the curred device context (can be NULL)
* @param aTrackItem = the track segment or via to modify
@ -123,7 +125,8 @@ void WinEDA_PcbFrame::Edit_TrackSegm_Width( wxDC* DC, TRACK* aTrackItem )
}
/** Function Edit_Track_Width
/**
* Function Edit_Track_Width
* Modify a full track width (using DRC control).
* a full track is the set of track segments between 2 ends: pads or a point that has more than 2 segments ends connected
* @param DC = the curred device context (can be NULL)
@ -171,7 +174,8 @@ void WinEDA_PcbFrame::Edit_Track_Width( wxDC* DC, TRACK* aTrackSegment )
}
/** function Change_Net_Tracks_And_Vias_Sizes
/**
* Function Change_Net_Tracks_And_Vias_Sizes
* Reset all tracks width and vias diameters and drill
* to their default Netclass value ou current values
* @param aNetcode : the netcode of the net to edit

3
pcbnew/event_handlers_tracks_vias_sizes.cpp
View File

@ -16,7 +16,8 @@
#include "wxPcbStruct.h"
#include "class_board_design_settings.h"
/** Function Tracks_and_Vias_Size_Event
/**
* Function Tracks_and_Vias_Size_Event
* Event handler for tracks and vias size selection (and some options)
* relative to toolbars and popup events
*/

Some files were not shown because too many files have changed in this diff Show More