Skip to content

K
kicad-source-mirror
Commit 31a864e7 authored by dickelbeck's avatar dickelbeck
Browse files
Options

comment cleanups

parent 780c49b4
Hide whitespace changes
Inline Side-by-side
Showing with 144 additions and 149 deletions
change_log.txt
View file @ 31a864e7
......@@ -5,11 +5,21 @@ Please add newer entries at the top, list the date and your name with
email address.
2007-Oct-31 UPDATE Dick Hollenbeck <dickelbeck@yahoo.com>
================================================================================
+ all
* Added Doxygen configuration file, whose standard name is Doxyfile. Output
is set to go to ./doxygen directory just off the project tree.
* added a note to todo.txt which asks folks to start using "Doxygen compatible"
comments in member functions and classes. Run Doxygen on the project, then
look at the documentation for class INSPECTOR as an example.
2007-Oct-31 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+all:
gcc 4.2.1 compatibility: change char * to const char * whenever it was necessary,
mainly in .xpm files
gcc 4.2.1 compatibility: change char * to const char * whenever it was necessary,
mainly in .xpm files
2007-Oct-30 UPDATE Dick Hollenbeck <dick@softplc.com>
......@@ -34,11 +44,11 @@ email address.
2007-Oct-30 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+cvpcb: listboxes.cpp problem solved: exists only under windows
now apply to windows only, because this Workaround creates a problem undex linux
now apply to windows only, because this Workaround creates a problem undex linux
+others:
some very minor problems solved
some very minor problems solved
+eeschema:
in B.O.M.: the footprint field can be added to the field list
in B.O.M.: the footprint field can be added to the field list
2007-Oct-29 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
......@@ -48,33 +58,33 @@ email address.
and if the selected item is near the end of the long list,
the new list is not displayed from the top of the list box
+eeschema:
Implemented: graying in/out of "Edit/Undo", "Edit/Redo" menu items,
when Undo/Redo stack is empty/filled.
Implemented: graying in/out of "Edit/Undo", "Edit/Redo" menu items,
when Undo/Redo stack is empty/filled.
+pcbnew:
Implemented: action for ID_POPUP_PCB_DELETE_MARKER
Implemented: action for ID_POPUP_PCB_DELETE_MARKER
2007-Oct-27 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+ all:
remove unused files.
some translations
remove unused files.
some translations
+cvpcb:
set flag wxFRAME_FLOAT_ON_PARENT when create the footprint 3D frame and the
display frame
minor other changes
set flag wxFRAME_FLOAT_ON_PARENT when create the footprint 3D frame and the
display frame
minor other changes
+ pcbnew:
Use collector class to locate items in modedit.
This is a big enhancement,
but a small work for me because Dick made all the work.
Use collector class to locate items in modedit.
This is a big enhancement,
but a small work for me because Dick made all the work.
2007-Oct-26 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+ pcbnew:
Add class_marker.cpp and class_marker.h and move MARQUEUR functions in class_marker.cpp
Change MARQUEUR::HitTest to take in account the zoom level.
change global var EDA_Appl to g_EDA_Appl
Add class_marker.cpp and class_marker.h and move MARQUEUR functions in class_marker.cpp
Change MARQUEUR::HitTest to take in account the zoom level.
change global var EDA_Appl to g_EDA_Appl
2007-Oct-25 UPDATE Geoff Harland <gharlandau@yahoo.com.au>
......@@ -91,8 +101,8 @@ email address.
2007-Oct-24 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+ cvpcb:
2 missing .prj files added (and updated)
dialog_display_option.cpp is rebuild from its dialog_display_option.prj source
2 missing .prj files added (and updated)
dialog_display_option.cpp is rebuild from its dialog_display_option.prj source
2007-Oct-23 UPDATE Geoff Harland <gharlandau@yahoo.com.au>
......@@ -120,12 +130,12 @@ email address.
2007-Oct-21 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+ pcbnew:
rename dialog_clean_pcb.pjd to cleaningoptions_dialog.pjd,
accordind to the corresponding cpp filename.
enter the new tool tips in cleaningoptions_dialog.pjd.
rename dialog_clean_pcb.pjd to cleaningoptions_dialog.pjd,
accordind to the corresponding cpp filename.
enter the new tool tips in cleaningoptions_dialog.pjd.
+all:
USE_RESIZE_BORDER is now defined (default) in fctsys.h.
Therefore, under windows, dialogs are now resizable (like under unix)
USE_RESIZE_BORDER is now defined (default) in fctsys.h.
Therefore, under windows, dialogs are now resizable (like under unix)
2007-Oct-21 UPDATE Geoff Harland <gharlandau@yahoo.com.au>
......@@ -150,10 +160,10 @@ email address.
2007-Oct-17 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+ pcbnew:
Removed enhancements in connectivity computation because
rastnest computation does not work (errors) with short track segments
(lenght < width) . This is not a bug, but an algorithm problem, so
I must work on algos.
Removed enhancements in connectivity computation because
rastnest computation does not work (errors) with short track segments
(lenght < width) . This is not a bug, but an algorithm problem, so
I must work on algos.
2007-Oct-17 UPDATE Geoff Harland <gharlandau@yahoo.com.au>
......@@ -167,19 +177,19 @@ email address.
2007-Oct-13 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+ pcbnew:
remove a change for Read VIA because via attributes
(TROUGH VIA, BLIND VIA or BURIED VIA) are autorisations for layer connection,
and are not a real layer indicator.
If a via connect layers from copper to component, it can have a BURIED VIA attribute.
the meaning is for this via the layer pair can be changed for other layer pair
if after editing this via connect 2 tracks which are only int internal layers,
its layer pair can be changed.
If a via has a TROUGH VIA attribute, it connects ALL layers, whenever tracks
connected to it.
Note: curenty: only TROUGH VIA are handled.
Other types (BLIND VIA and BURIED VIA) are only experimental.
A **lot** of code is needed for a full support.
enhancements in connectivity computation
remove a change for Read VIA because via attributes
(TROUGH VIA, BLIND VIA or BURIED VIA) are autorisations for layer connection,
and are not a real layer indicator.
If a via connect layers from copper to component, it can have a BURIED VIA attribute.
the meaning is for this via the layer pair can be changed for other layer pair
if after editing this via connect 2 tracks which are only int internal layers,
its layer pair can be changed.
If a via has a TROUGH VIA attribute, it connects ALL layers, whenever tracks
connected to it.
Note: curenty: only TROUGH VIA are handled.
Other types (BLIND VIA and BURIED VIA) are only experimental.
A **lot** of code is needed for a full support.
enhancements in connectivity computation
2007-Oct-15 UPDATE Geoff Harland <gharlandau@yahoo.com.au>
......@@ -202,11 +212,11 @@ email address.
2007-Oct-13 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+ pcbnew:
ratsnest.cpp translated into english.
Many infos on the LEE algorithm used here added.
todo (by myself): connect.cpp translation.
onrightclick() bug (created by last change) solved: one could reselect an item,
while moving a previously selected item (pcbnew crashes).
ratsnest.cpp translated into english.
Many infos on the LEE algorithm used here added.
todo (by myself): connect.cpp translation.
onrightclick() bug (created by last change) solved: one could reselect an item,
while moving a previously selected item (pcbnew crashes).
2007-Oct-13 UPDATE Geoff Harland <gharlandau@yahoo.com.au>
......@@ -342,7 +352,7 @@ email address.
2007-Oct-09 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+ eeschema:
cross-probing minor bug solved ( due to last modification): pins/pads not probed
cross-probing minor bug solved ( due to last modification): pins/pads not probed
2007-Oct-08 UPDATE Geoff Harland <gharlandau@yahoo.com.au>
......@@ -355,15 +365,15 @@ email address.
2007-Oct-7 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+ eeschema
create new file cross-probing.cpp
move RemoteCommand() to cross-probing.cpp and create SendMessageToPCBNEW()
create new file cross-probing.cpp
move RemoteCommand() to cross-probing.cpp and create SendMessageToPCBNEW()
+ pcbnew
bug in move pad fixed (could crash pcbnew)
Small change in selection clarification (side effect removed):
- Escape or click on title does not show the next popup menu.
- the title is displayed under linux
- definition CUIVRE_N translated into COPPER_LAYER_N
bug in move pad fixed (could crash pcbnew)
Small change in selection clarification (side effect removed):
- Escape or click on title does not show the next popup menu.
- the title is displayed under linux
- definition CUIVRE_N translated into COPPER_LAYER_N
2007-Oct-07 UPDATE Geoff Harland <gharlandau@yahoo.com.au>
......@@ -417,8 +427,8 @@ email address.
2007-Oct-6 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+ pcbnew
create new file cross-probing.cpp
move RemoteCommand() and SendMessageToEESCHEMA() to cross-probing.cpp
create new file cross-probing.cpp
move RemoteCommand() and SendMessageToEESCHEMA() to cross-probing.cpp
2007-Oct-3 UPDATE Dick Hollenbeck <dick@softplc.com>
......@@ -448,15 +458,15 @@ email address.
2007-Oct-01 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+ pcbnew/eeschema
Cross-probing pcbnew to eeschema:
A left click on a pad in pcbnew moves the eeschema cursor on the corresponding component pin
A left click on a footprint ref or value in pcbnew moves the eeschema cursor on the corresponding component ref or value
A left ckick on a footprint moves the eeschema cursor on the corresponding component anchor
Cross-probing pcbnew to eeschema:
A left click on a pad in pcbnew moves the eeschema cursor on the corresponding component pin
A left click on a footprint ref or value in pcbnew moves the eeschema cursor on the corresponding component ref or value
A left ckick on a footprint moves the eeschema cursor on the corresponding component anchor
+ pcbnew
removed drc.cpp change line 584, and translate comments in english.
nothing broken:
-> a pad with its netcode = 0 means the pad ** must be left unconnected ** (not attached to * a net).
-> a track with its netcode = 0 means the track is not attached to a net (cannot be connected to any pad).
removed drc.cpp change line 584, and translate comments in english.
nothing broken:
-> a pad with its netcode = 0 means the pad ** must be left unconnected ** (not attached to * a net).
-> a track with its netcode = 0 means the track is not attached to a net (cannot be connected to any pad).
2007-Sep-30 UPDATE Dick Hollenbeck <dick@softplc.com>
......@@ -480,20 +490,20 @@ email address.
2007-Sep-29 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+ pcbnew
create new file onleftclick.cpp
move onleftcligk() and onleftDcligk() from edit.cpp to onleftclick.cpp
create new file onleftclick.cpp
move onleftcligk() and onleftDcligk() from edit.cpp to onleftclick.cpp
2007-Sep-27 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+ all
test case for OnLeftClick() handling enhancements.
TAB key removed, because is not needed for block selection and double click.
(SHIHT ou CTRL or ALT key is sufficient to suppress the popup menu
if needed for a double click )
Some work is still needed, of course
(SHIHT ou CTRL or ALT key is sufficient to suppress the popup menu
if needed for a double click )
Some work is still needed, of course
+ pcbnew
Color grid setting now works
Color grid setting now works
2007-Sep-26 UPDATE Dick Hollenbeck <dick@softplc.com>
......@@ -529,10 +539,10 @@ email address.
2007-sept-25 UPDATE Jean-Pierre Charras <jean-pierre.charras@inpg.fr>
================================================================================
+ pcbnew:
* add class_board_item.cpp file and move BOARD_ITEM::MenuText() and BOARD_ITEM::MenuIcon() in it
* Add zone detection, forgotten in PcbGeneralLocateAndDisplay()
* add class_board_item.cpp file and move BOARD_ITEM::MenuText() and BOARD_ITEM::MenuIcon() in it
* Add zone detection, forgotten in PcbGeneralLocateAndDisplay()
+ class_collector.h:
add void COLLECTOR::Remove( unsigned int item_position ), needed by zone detection, see PcbGeneralLocateAndDisplay
add void COLLECTOR::Remove( unsigned int item_position ), needed by zone detection, see PcbGeneralLocateAndDisplay
2007-Sep-25 UPDATE Geoff Harland <gharlandau@yahoo.com.au>
......@@ -550,11 +560,11 @@ email address.
================================================================================
+ all
* small change in hotkeys handling
(Ki_HotkeyInfo: new member m_IdMenuEvent to call an existing event handler from a hotkey list)
(Ki_HotkeyInfo: new member m_IdMenuEvent to call an existing event handler from a hotkey list)
+ eeschema:
* added drag component in pop up menu and hotkeys
* plot svg format: incorrect arc draw fixed
* added drag component in pop up menu and hotkeys
* plot svg format: incorrect arc draw fixed
2007-Sep-22 UPDATE Dick Hollenbeck <dick@softplc.com>
......
include/base_struct.h
View file @ 31a864e7
......@@ -505,7 +505,7 @@ public:
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.pcb" format.
* 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.
*/
......
include/pcbstruct.h
View file @ 31a864e7
......@@ -268,18 +268,6 @@ public:
const KICAD_T scanTypes[] );
/**
* Function FindPadOrModule
* searches for either a pad or module, giving precedence to pads.
* Any Pad or Module on the desired layer that HitTest()s true will be
* returned, otherwise any visible Pad or Module on any other layer.
* The provided layer must be visible.
* @param refPos The wxPoint to hit-test.
* @return BOARD_ITEM* - if a direct hit, else NULL.
*/
// BOARD_ITEM* FindPadOrModule( const wxPoint& refPos, int layer );
/**
* Function FindNet
* searches for a net with the given netcode.
......@@ -291,7 +279,7 @@ public:
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.pcb" format.
* 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.
*/
......@@ -382,7 +370,7 @@ public:
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.pcb" format.
* 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.
*/
......@@ -448,7 +436,7 @@ public:
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.pcb" format.
* 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.
*/
......
include/wxstruct.h
View file @ 31a864e7
......@@ -724,6 +724,11 @@ public:
EDGE_ZONE* Del_SegmEdgeZone( wxDC* DC, EDGE_ZONE* edge_zone );
void CaptureNetName( wxDC* DC );
EDGE_ZONE* Begin_Zone();
/**
* Function End_Zone
* terminates the zone edge creation process
*/
void End_Zone( wxDC* DC );
void Fill_Zone( wxDC* DC );
......
pcbnew/class_board.cpp
View file @ 31a864e7
......@@ -562,17 +562,17 @@ BOARD_ITEM* BOARD::FindPadOrModule( const wxPoint& refPos, int layer )
*/
EQUIPOT* BOARD::FindNet( int anetcode ) const
{
if( anetcode <= 0 )
return NULL;
EQUIPOT* net = (EQUIPOT*) m_Equipots;
while( net )
// the first valid netcode is 1.
// zero is reserved for "no connection" and is not used.
if( anetcode > 0 )
{
if( net->GetNet() == anetcode )
break;
net = (EQUIPOT*) net->Pnext;
for( EQUIPOT* net = m_Equipots; net; net=net->Next() )
{
if( net->GetNet() == anetcode )
return net;
}
}
return net;
return NULL;
}
......
pcbnew/class_cotation.h
View file @ 31a864e7
......@@ -32,7 +32,7 @@ public:
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.pcb" format.
* 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.
*/
......
pcbnew/class_edge_mod.h
View file @ 31a864e7
......@@ -36,7 +36,7 @@ public:
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.pcb" format.
* 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.
*/
......
pcbnew/class_equipot.h
View file @ 31a864e7
......@@ -28,15 +28,17 @@ public:
EQUIPOT( BOARD_ITEM* StructFather );
~EQUIPOT();
EQUIPOT* Next() { return (EQUIPOT*) Pnext; }
/* Effacement memoire de la structure */
void UnLink();
void UnLink();
/* Readind and writing data on files */
int ReadEquipotDescr( FILE* File, int* LineNum );
int ReadEquipotDescr( FILE* File, int* LineNum );
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.pcb" format.
* 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.
*/
......
pcbnew/class_marker.h
View file @ 31a864e7
......@@ -35,7 +35,7 @@ public:
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.pcb" format.
* 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.
*/
......
pcbnew/class_mire.h
View file @ 31a864e7
......@@ -21,7 +21,7 @@ public:
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.pcb" format.
* 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.
*/
......
pcbnew/class_module.h
View file @ 31a864e7
......@@ -119,7 +119,7 @@ public:
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.pcb" format.
* 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.
*/
......
pcbnew/class_pad.h
View file @ 31a864e7
......@@ -80,7 +80,7 @@ public:
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.pcb" format.
* 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.
*/
......
pcbnew/class_pcb_text.h
View file @ 31a864e7
......@@ -27,7 +27,7 @@ public:
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.pcb" format.
* 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.
*/
......
pcbnew/class_text_mod.h
View file @ 31a864e7
......@@ -49,7 +49,7 @@ public:
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.pcb" format.
* 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.
*/
......
pcbnew/class_track.h
View file @ 31a864e7
......@@ -62,7 +62,7 @@ public:
/**
* Function Save
* writes the data structures for this object out to a FILE in "*.pcb" format.
* 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.
*/
......
pcbnew/onrightclick.cpp
View file @ 31a864e7
......@@ -165,7 +165,6 @@ bool WinEDA_PcbFrame::OnRightClick( const wxPoint& aMousePos, wxMenu* aPopMenu )
/* Select a proper item */
#if 1 // try this
wxPoint cursorPos = GetScreen()->m_Curseur;
wxPoint selectPos = m_Collector->GetRefPos();
......@@ -173,16 +172,19 @@ bool WinEDA_PcbFrame::OnRightClick( const wxPoint& aMousePos, wxMenu* aPopMenu )
// printf( "cursor=(%d, %d) select=(%d,%d)\n", cursorPos.x, cursorPos.y, selectPos.x, selectPos.y );
/* We can reselect an other item only if there are no item being edited
* because ALL moving functions use GetCurItem(),
* therefore GetCurItem() must return the same item during moving.
* We know an item is moving if ( item && (item->m_Flags != 0)) is true
* and after calling PcbGeneralLocateAndDisplay(), GetCurItem() is any arbitrary BOARD_ITEM,
* not the current editen item.
/* We can reselect another item only if there are no item being edited
because ALL moving functions use GetCurItem(), therefore GetCurItem()
must return the same item during moving. We know an item is moving
if( item && (item->m_Flags != 0)) is true and after calling
PcbGeneralLocateAndDisplay(), GetCurItem() is any arbitrary BOARD_ITEM,
not the current item being edited. In such case we cannot call
PcbGeneralLocateAndDisplay().
*/
if ( ! item || (item->m_Flags == 0) )
if( !item || (item->m_Flags == 0) )
{
if( !item || cursorPos != selectPos ) // Filter
// show "item selector" menu only if no item now or selected item was not
// previously picked at this position
if( !item || cursorPos != selectPos )
{
DrawPanel->m_AbortRequest = false;
item = PcbGeneralLocateAndDisplay();
......@@ -194,23 +196,6 @@ bool WinEDA_PcbFrame::OnRightClick( const wxPoint& aMousePos, wxMenu* aPopMenu )
}
}
#else
if( !item || !item->m_Flags )
{
DrawPanel->m_AbortRequest = false;
item = PcbGeneralLocateAndDisplay();
if( DrawPanel->m_AbortRequest )
{
DrawPanel->CursorOn( &dc );
return false;
}
SetCurItem( item );
}
#endif
item = GetCurItem();
if( item )
flags = item->m_Flags;
......
todo.txt
View file @ 31a864e7
......@@ -32,13 +32,18 @@ static inline void ADD_MENUITEM(menu, id, text, icon)
}
*** Set up a DOXYGEN environment starting with a configuration file that:
- understands the JavaDoc style comments that we have started using
- gives preference to comments in header files over *.cpp files
- outputs its HTML stuff relative to the base of trunk, say for example trunk/doxygen
- is then added to the svn repository (this configuration file only)
Then add a shell script and batch file to generate the docs using the config file.
Then review the generated docs and start to go through the source and make the
*** rework zones so they are modifiable and so that the user does not
need to enter tracks for thru hole pads or vias which connect to a zone.
I propose a two step solution:
1) interim enhancement: make zone edges retained in BRD file and make the
edges editable.
2) final solution: get rid of requirement for tracks buried within a zone.
Reivew the GEDA source code and other sources to gather ideas before doing 2).
*** Use DOXYGEN compatible comments on member functions. As configured,
Doxygen gives priority to comments in header files over *.cpp files.
Review the generated docs and start to go through the source and make the
generated doxygen docs readable and clear using the JavaDoc style comments,
mostly in the header files. The error and warning output of the doxygen
compiler can help with this too.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment