Commit 31a864e7 authored by dickelbeck's avatar dickelbeck
Browse files

comment cleanups

parent 780c49b4

change_log.txt

+89 −79
Original line number Original line Diff line number Diff line
@@ -5,6 +5,16 @@ Please add newer entries at the top, list the date and your name with 
email address.

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>

2007-Oct-31 UPDATE  Jean-Pierre Charras <jean-pierre.charras@inpg.fr>

================================================================================

================================================================================

+all:

+all:

include/base_struct.h

+1 −1
Original line number Original line Diff line number Diff line
@@ -505,7 +505,7 @@ public: 
    

    

    /**

    /**

     * Function Save

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

     * @param aFile The FILE to write to.

     * @return bool - true if success writing else false.

     * @return bool - true if success writing else false.

     */ 

     */

include/pcbstruct.h

+3 −15
Original line number Original line Diff line number Diff line
@@ -268,18 +268,6 @@ public: 
        const KICAD_T scanTypes[] );

        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

     * Function FindNet

     * searches for a net with the given netcode.

     * searches for a net with the given netcode.
@@ -291,7 +279,7 @@ public: 




    /**

    /**

     * Function Save

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

     * @param aFile The FILE to write to.

     * @return bool - true if success writing else false.

     * @return bool - true if success writing else false.

     */ 

     */
@@ -382,7 +370,7 @@ public: 
    

    

    /**

    /**

     * Function Save

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

     * @param aFile The FILE to write to.

     * @return bool - true if success writing else false.

     * @return bool - true if success writing else false.

     */ 

     */
@@ -448,7 +436,7 @@ public: 
    

    

    /**

    /**

     * Function Save

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

     * @param aFile The FILE to write to.

     * @return bool - true if success writing else false.

     * @return bool - true if success writing else false.

     */ 

     */

include/wxstruct.h

+5 −0
Original line number Original line Diff line number Diff line
@@ -724,6 +724,11 @@ public: 
    EDGE_ZONE*          Del_SegmEdgeZone( wxDC* DC, EDGE_ZONE* edge_zone );

    EDGE_ZONE*          Del_SegmEdgeZone( wxDC* DC, EDGE_ZONE* edge_zone );

    void                CaptureNetName( wxDC* DC );

    void                CaptureNetName( wxDC* DC );

    EDGE_ZONE*          Begin_Zone();

    EDGE_ZONE*          Begin_Zone();

    

    /**

     * Function End_Zone

     * terminates the zone edge creation process

     */

    void                End_Zone( wxDC* DC );

    void                End_Zone( wxDC* DC );

    void                Fill_Zone( wxDC* DC );

    void                Fill_Zone( wxDC* DC );

pcbnew/class_board.cpp

+9 −9
Original line number Original line Diff line number Diff line
@@ -562,18 +562,18 @@ BOARD_ITEM* BOARD::FindPadOrModule( const wxPoint& refPos, int layer ) 
 */

 */

EQUIPOT* BOARD::FindNet( int anetcode ) const

EQUIPOT* BOARD::FindNet( int anetcode ) const

{

{

    if( anetcode <= 0 )

    // the first valid netcode is 1.

        return NULL;

    // zero is reserved for "no connection" and is not used.



    if( anetcode > 0 )  

    EQUIPOT* net = (EQUIPOT*) m_Equipots;

    {

    while( net )

        for( EQUIPOT* net = m_Equipots;  net;  net=net->Next() )

        {

        {

            if( net->GetNet() == anetcode )

            if( net->GetNet() == anetcode )

            break;

        net = (EQUIPOT*) net->Pnext;

    }

                return net;

                return net;

        }

        }

    }

    return NULL;

}