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

Doxygen comment improvements. 

Fix lots of Doxygen warnings.

Fix Doxygen comment for IO_MGR::FootprintEnumerate() which was recently
changed.
This commit is contained in:
Wayne Stambaugh 2017-06-13 19:47:05 -04:00
parent e97f49e009
commit 66e97fa905
35 changed files with 90 additions and 120 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
3d-viewer/3d_rendering/3d_render_raytracing/shapes2D/cbbox2d.cpp
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015-2016 Mario Luzeiro <mrluzeiro@ua.pt>
* Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -23,7 +23,7 @@
*/
/**
* @file CBBOX2D2d.cpp
* @file cbbox2d.cpp
* @brief Bounding Box class implementation
*/

6
common/dialogs/dialog_env_var_config.cpp
View File

@ -1,8 +1,8 @@
/*
* This program source code file is part of KICAD, a free EDA CAD application.
*
* Copyright (C) 2015 Wayne Stambaugh <stambaughw@gmail.com>
* Copyright (C) 2015 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 2015-2017 Wayne Stambaugh <stambaughw@gmail.com>
* Copyright (C) 2015-2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -23,7 +23,7 @@
*/
/**
* @file dialg_env_var_config.cpp
* @file dialog_env_var_config.cpp
*/
#include <dialog_env_var_config.h>

2
cvpcb/cvpcb_mainframe.cpp
View File

@ -24,7 +24,7 @@
*/
/**
* @file cvframe.cpp
* @file cvpcb_mainframe.cpp
*/
#include <fctsys.h>

2
cvpcb/listview_classes.h
View File

@ -22,7 +22,7 @@
*/
/**
* @file cvstruct.h
* @file listview_classes.h
*/
#ifndef CVSTRUCT_H

2
eeschema/class_library.h
View File

@ -287,7 +287,7 @@ public:
*
* The object can be either a part or an alias.
*
* @param aEntryName - Name of entry to search for (case sensitive).
* @param aLibId - The library indentifaction of entry to search for (case sensitive).
* @param aLibraryName - Name of the library to search.
* @return The entry object if found, otherwise NULL.
*/

3
eeschema/sch_item_struct.h
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 2004-2011 KiCad Developers, see change_log.txt for contributors.
* Copyright (C) 2004-2017 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -313,7 +313,6 @@ public:
*/
bool IsConnected( const wxPoint& aPoint ) const;
/** @copydoc EDA_ITEM::HitTest(const wxPoint&) */
virtual bool HitTest( const wxPoint& aPosition ) const override
{
return HitTest( aPosition, 0 );

2
eeschema/schframe.h
View File

@ -24,7 +24,7 @@
*/
/**
* @file wxEeschemaStruct.h
* @file schframe.h
*/
#ifndef WX_EESCHEMA_STRUCT_H

6
eeschema/sim/sim_plot_frame.h
View File

@ -2,6 +2,8 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2016 CERN
* Copyright (C) 2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* @author Tomasz Wlostowski <tomasz.wlostowski@cern.ch>
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
@ -27,7 +29,9 @@
#define __sim_plot_frame__
/**
* @file Subclass of SIM_PLOT_FRAME_BASE, which is generated by wxFormBuilder.
* @file sim_plot_frame.h
*
* Subclass of SIM_PLOT_FRAME_BASE, which is generated by wxFormBuilder.
*/
#include "sim_plot_frame_base.h"

6
include/base_struct.h
View File

@ -3,8 +3,8 @@
*
* Copyright (C) 2013-2015 Jean-Pierre Charras, jp.charras at wanadoo.fr
* Copyright (C) 2008-2015 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2008-2015 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 2004-2015 KiCad Developers, see change_log.txt for contributors.
* Copyright (C) 2008-2017 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 2004-2017 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -468,10 +468,8 @@ public:
*/
EDA_ITEM& operator=( const EDA_ITEM& aItem );
/// @copydoc VIEW_ITEM::ViewBBox()
virtual const BOX2I ViewBBox() const override;
/// @copydoc VIEW_ITEM::ViewGetLayers()
virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
#if defined(DEBUG)

3
include/class_board_item.h
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -326,7 +326,6 @@ public:
static std::string FormatInternalUnits( const wxSize& aSize );
/// @copydoc VIEW_ITEM::ViewGetLayers()
virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
};

15
include/draw_frame.h
View File

@ -2,8 +2,8 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 2011 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 2011-2017 Wayne Stambaugh <stambaughw@gmail.com>
* Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -657,15 +657,16 @@ public:
virtual void InitBlockPasteInfos();
/**
* Function HandleBlockBegin
* initializes the block command including the command type, initial position,
* and other variables.
* Initialize a block command.
*
* @param aDC is the device context to perform the block command.
* @param aKey is the block command key press.
* @param aPosition is the logical position of the start of the block command.
* @param aExplicitCommand - if this is given, begin with this command, rather
* than looking up the command from aKey.
* than looking up the command from \a aKey.
*/
virtual bool HandleBlockBegin( wxDC* aDC, EDA_KEY aKey, const wxPoint& aPosition,
int aExplicitCommand = 0 );
int aExplicitCommand = 0 );
/**
* Function BlockCommand

15
include/eda_text.h
View File

@ -300,15 +300,14 @@ public:
EDA_RECT GetTextBox( int aLine = -1, int aThickness = -1, bool aInvertY = false ) const;
/**
* Function GetInterline
* return the distance between 2 text lines
* has meaning only for multiline texts
* Return the distance between two lines of text.
*
* <p>
* Calculates the distance (pitch) between 2 text lines
* the distance includes the interline + room for chars like j { and [
* Is used for multiline texts, but also for single line texts, to calculate
* the text bounding box
*.
* Calculates the distance (pitch) between two lines of text. This distance includes the
* interline distance plus room for characters like j, {, and [. It also used for single
* line text, to calculate the text bounding box.
* </p>
*
* @param aTextThickness Overrides the current thickness when greater than 0.
* this is needed when the current m_Thickness is 0 and a default line thickness
* is used

8
include/fp_lib_table.h
View File

@ -136,14 +136,12 @@ public:
//-----<PLUGIN API SUBSET, REBASED ON aNickname>---------------------------
/**
* Function FootprintEnumerate
* returns a list of footprint names contained within the library given by
* @a aNickname.
* Return a list of footprint names contained within the library given by @a aNickname.
*
* @param aFootprintNames is the list to fill with the footprint names found in \a aNickname
*
* @param aNickname is a locator for the "library", it is a "name" in LIB_TABLE_ROW.
*
* @return wxArrayString - is the array of available footprint names inside a library
*
* @throw IO_ERROR if the library cannot be found, or footprint cannot be loaded.
*/
void FootprintEnumerate( wxArrayString& aFootprintNames, const wxString& aNickname );

8
include/gestfich.h
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009-2014 Jerry Jacobs
* Copyright (C) 1992-2014 KiCad Developers, see CHANGELOG.TXT for contributors.
* Copyright (C) 1992-2017 KiCad Developers, see CHANGELOG.TXT for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -67,7 +67,7 @@ void OpenFile( const wxString& file );
* contains the result of the wxDirDialog when the OK button is used to dismiss
* the dialog.
* @param aFlags is the style of the path dialog, wxDD_???.
* @param aParaent is the parent window of the dialog.
* @param aParent is the parent window of the dialog.
* @param aPosition is the position of the dialog.
* @return true if a path was selected.
*/
@ -87,8 +87,8 @@ bool EDA_PATH_SELECTOR( const wxString& aTitle,
* @param aFileName is a string containing the default file name.
* @param aExtension is a string containing the default file extension.
* @param aWildcard is a string containing the default wildcard.
* @param aParaent is the parent window of the dialog.
* @param aFlags is the style of the path dialog, wxFD_???.
* @param aParent is the parent window of the dialog.
* @param aStyle is the style of the path dialog, wxFD_???.
* @param aKeepWorkingDirectory determines if current working directory should be set to the
* user selected path.
* @param aPosition is the position of the dialog.

10
include/lib_id.h
View File

@ -2,8 +2,8 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2010-2012 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2012-2016 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 2010-2016 KiCad Developers, see change_log.txt for contributors.
* Copyright (C) 2012-2017 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 2010-2017 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -198,16 +198,14 @@ public:
bool empty() const { return nickname.empty() && item_name.empty() && revision.empty(); }
/**
* Function Compare
*
* compares the contents of LIB_ID objects by performing a std::string comparison of the
* Compare the contents of LIB_ID objects by performing a std::string comparison of the
* library nickname, library entry name, and revision strings respectively.
*
* @param aLibId is the LIB_ID to compare against.
*
* @return -1 if less than \a aLibId, 1 if greater than \a aLibId, and 0 if equal to \a aLibId.
*/
int compare( const LIB_ID& aLIB_ID ) const;
int compare( const LIB_ID& aLibId ) const;
bool operator < ( const LIB_ID& aLibId ) const { return this->compare( aLibId ) < 0; }
bool operator > ( const LIB_ID& aLibId ) const { return this->compare( aLibId ) > 0; }

6
include/lib_table_base.h
View File

@ -300,12 +300,10 @@ public:
virtual void Parse( LIB_TABLE_LEXER* aLexer ) = 0;
/**
* Function Format
*
* Generates the table s-expression format to the \a aOutput with an indention level
* Generate the table in s-expression format to \a aOutput with an indention level
* of \a aIndentLevel.
*
* @param aOutput is the #OUTPUTFORMATER to format the table into.
* @param aOutput is the #OUTPUTFORMATTER to format the table into.
* @param aIndentLevel is the indentation level (2 spaces) to indent.
*
* @throw IO_ERROR if an I/O error occurs during output.

2
include/lockfile.h
View File

@ -23,7 +23,7 @@
/**
* File locking utilities
* @file lock_file.h
* @file lockfile.h
*/
#ifndef INCLUDE__LOCK_FILE_H_

2
include/plot_auxiliary_data.h
View File

@ -27,7 +27,7 @@
* used in Gerber plotter to generate auxiliary data during plot
* (for instance info associated to flashed pads)
*
* @file plot_extra_data.h
* @file plot_auxiliary_data.h
*/
#ifndef PLOT_EXTRA_DATA_H

3
include/plugins/kicad_plugin.h
View File

@ -2,6 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015 Cirilo Bernardo <cirilo.bernardo@gmail.com>
* Copyright (C) 2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -22,7 +23,7 @@
*/
/**
* @file kicad_plugin.h
* @file include/plugins/kicad_plugin.h
* defines the most basic functions which all kicad plugins must implement.
* In the implementation the definitions must make use of the KICAD_PLUGIN_EXPORT
* to ensure symbol visibility.

2
include/widgets/widget_hotkey_list.h
View File

@ -23,7 +23,7 @@
*/
/**
* @file widget_hotkey_list
* @file widget_hotkey_list.h
*/
#ifndef __widget_hotkey_list__

15
include/wxstruct.h
View File

@ -2,8 +2,8 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009-2015 Jean-Pierre Charras, jp.charras wanadoo.fr
* Copyright (C) 2011-2015 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2015 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 2011-2017 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -60,11 +60,12 @@
#define NO_BACKUP_FILE false
/**
* a prefix to create filenames for schematic files or other difile when auto-saved
* to retrieve a crash
* The auto-saved filenames are AUTOSAVE_PREFIX_FILENAME + <sourcefilename>
* where <sourcefilename> is the flename without path of the auto-saved file
* Warning: avoid any special char like / \ $ % which can create issues on Unix
* Prefix to create filenames for schematic files or other difile when auto-saved
* to retrieve a crash.
*
* The auto-saved filenames are AUTOSAVE_PREFIX_FILENAME + \<sourcefilename\>
* where \<sourcefilename\> is the flename without path of the auto-saved file
* Warning: avoid any special charactoer like / \\ \$ \% which can create issues on Unix
* or Window with filenames or env var expansion.
*/
#define AUTOSAVE_PREFIX_FILENAME wxT( "_saved_" )

2
pcbnew/board_item_container.h
View File

@ -2,6 +2,8 @@
* This program source code file is part of KICAD, a free EDA CAD application.
*
* Copyright (C) 2016 CERN
* Copyright (C) 2016-2017 KiCad Developers, see change_log.txt for contributors.
*
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
* This program is free software; you can redistribute it and/or

11
pcbnew/class_board.h
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -271,10 +271,8 @@ public:
void SetFileFormatVersionAtLoad( int aVersion ) { m_fileFormatVersionAtLoad = aVersion; }
int GetFileFormatVersionAtLoad() const { return m_fileFormatVersionAtLoad; }
///> @copydoc BOARD_ITEM_CONTAINER::Add()
void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_INSERT ) override;
///> @copydoc BOARD_ITEM_CONTAINER::Remove()
void Remove( BOARD_ITEM* aBoardItem ) override;
BOARD_ITEM* Duplicate( const BOARD_ITEM* aItem, bool aAddToBoard = false );
@ -929,6 +927,8 @@ public:
* @param aNetlist is the new netlist to revise the contents of the #BOARD with.
* @param aDeleteSinglePadNets if true, remove nets counting only one pad
* and set net code to 0 for these pads
* @param aNewFootprints is a pointer the to a list of new footprints used when updating
* the netlist.
* @param aReporter is a #REPORTER object to report the changes \a aNetlist makes to
* the #BOARD. If NULL, no change reporting occurs.
*/
@ -1187,10 +1187,11 @@ public:
* of the via.
* </p>
* @param aPosition The wxPoint to HitTest() against.
* @param aLayer The layer to search. Use -1 (<PCB_LAYER_ID>::UNDEFINED_LAYER) for a don't care.
* @param aLayer The layer to search. Use -1 (PCB_LAYER_ID::UNDEFINED_LAYER) for a don't care.
* @return VIA* A point a to the VIA object if found, else NULL.
*/
VIA* GetViaByPosition( const wxPoint& aPosition, PCB_LAYER_ID aLayer = PCB_LAYER_ID( -1 ) ) const;
VIA* GetViaByPosition( const wxPoint& aPosition,
PCB_LAYER_ID aLayer = PCB_LAYER_ID( -1 ) ) const;
/**
* Function GetPad

6
pcbnew/class_dimension.h
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 1992-2011 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -209,9 +209,6 @@ public:
bool HitTest( const wxPoint& aPosition ) const override;
/** @copydoc BOARD_ITEM::HitTest(const EDA_RECT& aRect,
* bool aContained = true, int aAccuracy ) const
*/
bool HitTest( const EDA_RECT& aRect, bool aContained = true, int aAccuracy = 0 ) const override;
wxString GetClass() const override
@ -228,7 +225,6 @@ public:
EDA_ITEM* Clone() const override;
/// @copydoc VIEW_ITEM::ViewBBox()
virtual const BOX2I ViewBBox() const override;
#if defined(DEBUG)

6
pcbnew/class_drawsegment.h
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 1992-2011 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -188,9 +188,6 @@ public:
virtual bool HitTest( const wxPoint& aPosition ) const override;
/** @copydoc BOARD_ITEM::HitTest(const EDA_RECT& aRect,
* bool aContained = true, int aAccuracy ) const
*/
bool HitTest( const EDA_RECT& aRect, bool aContained = true, int aAccuracy = 0 ) const override;
wxString GetClass() const override
@ -241,7 +238,6 @@ public:
virtual EDA_ITEM* Clone() const override;
/// @copydoc VIEW_ITEM::ViewBBox()
virtual const BOX2I ViewBBox() const override;
#if defined(DEBUG)

10
pcbnew/class_module.h
View File

@ -100,10 +100,10 @@ public:
MODULE* Back() const { return static_cast<MODULE*>( Pback ); }
///> @copydoc BOARD_ITEM_CONTAINER::Add()
void Add( BOARD_ITEM* aBoardItem, ADD_MODE aMode = ADD_INSERT ) override;
void Add( BOARD_ITEM* aItem, ADD_MODE aMode = ADD_INSERT ) override;
///> @copydoc BOARD_ITEM_CONTAINER::Remove()
void Remove( BOARD_ITEM* aBoardItem ) override;
void Remove( BOARD_ITEM* aItem ) override;
/**
* Function ClearAllNets
@ -399,9 +399,6 @@ public:
bool HitTest( const wxPoint& aPosition ) const override;
/** @copydoc BOARD_ITEM::HitTest(const EDA_RECT& aRect,
* bool aContained = true, int aAccuracy ) const
*/
bool HitTest( const EDA_RECT& aRect, bool aContained = true, int aAccuracy = 0 ) const override;
/**
@ -564,13 +561,10 @@ public:
void RunOnChildren( std::function<void (BOARD_ITEM*)> aFunction );
/// @copydoc VIEW_ITEM::ViewGetLayers()
virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
/// @copydoc VIEW_ITEM::ViewGetLOD()
virtual unsigned int ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
/// @copydoc VIEW_ITEM::ViewBBox()
virtual const BOX2I ViewBBox() const override;
/**

3
pcbnew/class_pad.h
View File

@ -550,13 +550,10 @@ public:
return (D_PAD*) Clone();
}
/// @copydoc VIEW_ITEM::ViewGetLayers()
virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
/// @copydoc VIEW_ITEM::ViewGetLOD()
virtual unsigned int ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
/// @copydoc VIEW_ITEM::ViewBBox()
virtual const BOX2I ViewBBox() const override;
/**

5
pcbnew/class_text_mod.h
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 1992-2016 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -211,13 +211,10 @@ public:
virtual wxString GetShownText() const override;
/// @copydoc VIEW_ITEM::ViewBBox()
virtual const BOX2I ViewBBox() const override;
/// @copydoc VIEW_ITEM::ViewGetLayers()
virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
/// @copydoc VIEW_ITEM::ViewGetLOD()
virtual unsigned int ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
#if defined(DEBUG)

9
pcbnew/class_track.h
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004 Jean-Pierre Charras, jaen-pierre.charras@gipsa-lab.inpg.com
* Copyright (C) 1992-2011 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 1992-2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -220,9 +220,6 @@ public:
virtual bool HitTest( const wxPoint& aPosition ) const override;
/** @copydoc BOARD_ITEM::HitTest(const EDA_RECT& aRect,
* bool aContained = true, int aAccuracy ) const
*/
virtual bool HitTest( const EDA_RECT& aRect, bool aContained = true, int aAccuracy = 0 ) const override;
/**
@ -299,10 +296,8 @@ public:
virtual EDA_ITEM* Clone() const override;
/// @copydoc VIEW_ITEM::ViewGetLayers()
virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
/// @copydoc VIEW_ITEM::ViewGetLOD()
virtual unsigned int ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
#if defined (DEBUG)
@ -431,10 +426,8 @@ public:
EDA_ITEM* Clone() const override;
/// @copydoc VIEW_ITEM::ViewGetLayers()
virtual void ViewGetLayers( int aLayers[], int& aCount ) const override;
/// @copydoc VIEW_ITEM::ViewGetLOD()
virtual unsigned int ViewGetLOD( int aLayer, KIGFX::VIEW* aView ) const override;
virtual void Flip( const wxPoint& aCentre ) override;

13
pcbnew/clean.cpp
View File

@ -2,8 +2,8 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004-2016 Jean-Pierre Charras, jean-pierre.charras@gpisa-lab.inpg.fr
* Copyright (C) 2011 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2016 KiCad Developers, see change_log.txt for contributors.
* Copyright (C) 2011-2017 Wayne Stambaugh <stambaughw@verizon.net>
* Copyright (C) 1992-2017 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -48,14 +48,13 @@ public:
TRACKS_CLEANER( BOARD* aPcb, BOARD_COMMIT& aCommit );
/**
* the cleanup function.
* return true if some item was modified
* @param aFrame = the PCB_EDIT_FRAME which handles the board
* The track cleanup function.
*
* @param aRemoveMisConnected = true to remove segments connecting 2 different nets
* @param aCleanVias = true to remove superimposed vias
* @param aMergeSegments = true to merge collinear segmenst and remove 0 len segm
* @param aDeleteUnconnected = true to remove dangling tracks
* (short circuits)
* @param aDeleteUnconnected = true to remove dangling tracks (short circuits)
* @return true if some item was modified
*/
bool CleanupBoard( bool aCleanVias, bool aRemoveMisConnected,
bool aMergeSegments, bool aDeleteUnconnected );

4
pcbnew/github/github_getliblist.h
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015 Jean-Pierre Charras jp.charras at wanadoo.fr
* Copyright (C) 2015 KiCad Developers, see CHANGELOG.TXT for contributors.
* Copyright (C) 2015-2017 KiCad Developers, see CHANGELOG.TXT for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -35,7 +35,7 @@
* To extract pretty footprints library list, this plugin simply reads in
* a zip file of the repo and unzips it from RAM as needed.
* Therefore this "Github" plugin is <b>read only for accessing remote
* at https://api.github.com/orgs/KiCad/repos</b>
* at https:////api.github.com//orgs//KiCad//repos
*
* To extract 3D shapes libraries list (.3dshapes folders) we cannot use api.github.com
* to read this list, becuse it is in a subdirectory of https://github.com/KiCad.

2
pcbnew/github/html_link_parser.cpp
View File

@ -1,5 +1,5 @@
/**
* @file html_link_parse.cpp
* @file html_link_parser.cpp
*/
/*

2
pcbnew/github/html_link_parser.h
View File

@ -1,5 +1,5 @@
/**
* @file html_link_parse.h
* @file html_link_parser.h
*/
/*

6
pcbnew/io_mgr.h
View File

@ -263,8 +263,7 @@ public:
//-----<Footprint Stuff>-----------------------------
/**
* Function FootprintEnumerate
* returns a list of footprint names contained within the library at @a aLibraryPath.
* Return a list of footprint names contained within the library at @a aLibraryPath.
*
* @param aLibraryPath is a locator for the "library", usually a directory, file,
* or URL containing several footprints.
@ -274,8 +273,7 @@ public:
* The caller continues to own this object (plugin may not delete it), and
* plugins should expect it to be optionally NULL.
*
* @return wxArrayString - is the array of available footprint names inside
* a library
* @param aFootprintNames is the array of available footprint names inside a library.
*
* @throw IO_ERROR if the library cannot be found, or footprint cannot be loaded.
*/

9
pcbnew/netlist_reader.h
View File

@ -9,8 +9,8 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2012 Jean-Pierre Charras.
* Copyright (C) 2013 Wayne Stambaugh <stambaughw@gmail.com>.
* Copyright (C) 2012-2015 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 2013-2017 Wayne Stambaugh <stambaughw@gmail.com>.
* Copyright (C) 2012-2017 KiCad Developers, see AUTHORS.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@ -127,8 +127,9 @@ public:
/**
* Constructor
* @param aLineReader ownership is taken of this LINE_READER.
* @param aFootprintLinkReader ownership is taken of this CMP_READER.
* @param aLineReader ownership is taken of this #LINE_READER.
* @param aNetlist the #NETLIST object to read into.
* @param aFootprintLinkReader ownership is taken of this #CMP_READER.
*/
NETLIST_READER( LINE_READER* aLineReader,
NETLIST* aNetlist,