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

Fix a few doxygen warnings

This commit is contained in:
jean-pierre charras 2017-06-26 09:11:21 +02:00
parent 5774fd284e
commit 3c3ee9b8c3
6 changed files with 18 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
eeschema/bom_table_model.cpp
View File

@ -321,7 +321,7 @@ bool BOM_TABLE_GROUP::TestField( BOM_COLUMN* aField, BOM_TABLE_COMPONENT* aCompo
/** /**
* Add a new component to the group. * Add a new component to the group.
* It is assumed at this stage that the component is a good match for the group. * It is assumed at this stage that the component is a good match for the group.
* @param aCmp is the new component to add * @param aComponent is the new component to add
*/ */
bool BOM_TABLE_GROUP::AddComponent( BOM_TABLE_COMPONENT* aComponent ) bool BOM_TABLE_GROUP::AddComponent( BOM_TABLE_COMPONENT* aComponent )
{ {

11
eeschema/dialogs/dialog_annotate.cpp
View File

@ -6,8 +6,8 @@
/* /*
* This program source code file is part of KiCad, a free EDA CAD application. * This program source code file is part of KiCad, a free EDA CAD application.
* *
* Copyright (C) 1992-2012 jean-pierre Charras <jean-pierre.charras@ujf-grenoble.fr> * Copyright (C) 1992-2017 jean-pierre Charras jp.charras at wanadoo.fr
* Copyright (C) 1992-2012 Kicad Developers, see change_log.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 * This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License * modify it under the terms of the GNU General Public License
@ -45,10 +45,9 @@
class wxConfigBase; class wxConfigBase;
namespace {
/** /**
* Class DIALOG_ANNOTATE * Class DIALOG_ANNOTATE: a dialog to set/clear reference designators,
* of a schematic hierarchy, with different options
*/ */
class DIALOG_ANNOTATE: public DIALOG_ANNOTATE_BASE class DIALOG_ANNOTATE: public DIALOG_ANNOTATE_BASE
{ {
@ -98,8 +97,6 @@ private:
} }
}; };
} // anonymous namespace
DIALOG_ANNOTATE::DIALOG_ANNOTATE( SCH_EDIT_FRAME* parent, wxString message ) DIALOG_ANNOTATE::DIALOG_ANNOTATE( SCH_EDIT_FRAME* parent, wxString message )
: DIALOG_ANNOTATE_BASE( parent ) : DIALOG_ANNOTATE_BASE( parent )

10
eeschema/dialogs/dialog_eeschema_options.cpp
View File

@ -85,13 +85,13 @@ SCH_EDIT_FRAME* DIALOG_EESCHEMA_OPTIONS::GetParent()
} }
void DIALOG_EESCHEMA_OPTIONS::SetUnits( const wxArrayString& units, int select ) void DIALOG_EESCHEMA_OPTIONS::SetUnits( const wxArrayString& aUnits, int aSelect )
{ {
wxASSERT( units.GetCount() > 0 wxASSERT( aUnits.GetCount() > 0
&& ( select >= 0 && (size_t) select < units.GetCount() ) ); && ( aSelect >= 0 && (size_t) aSelect < aUnits.GetCount() ) );
m_choiceUnits->Append( units ); m_choiceUnits->Append( aUnits );
m_choiceUnits->SetSelection( select ); m_choiceUnits->SetSelection( aSelect );
} }

6
eeschema/dialogs/dialog_eeschema_options.h
View File

@ -101,12 +101,12 @@ public:
* Function SetUnits * Function SetUnits
* Set the unit options * Set the unit options
* *
* @param units The array of strings representing the unit options * @param aUnits The array of strings representing the unit options
* @param select The unit to select from the unit options * @param aSelect The unit to select from the unit options
* *
* Appends the @a units options to the list of unit options and selects the @a aSelect option * Appends the @a units options to the list of unit options and selects the @a aSelect option
*/ */
void SetUnits( const wxArrayString& units, int aSelect = 0 ); void SetUnits( const wxArrayString& aUnits, int aSelect = 0 );
/** /**
* Function GetGridSelection * Function GetGridSelection

2
eeschema/dialogs/dialog_rescue_each.cpp
View File

@ -41,7 +41,7 @@ public:
* Constructor * Constructor
* This dialog asks the user which rescuable, cached parts he wants to rescue. * This dialog asks the user which rescuable, cached parts he wants to rescue.
* Any rejects will be pruned from aCandidates. * Any rejects will be pruned from aCandidates.
* @param aCaller - the SCH_EDIT_FRAME calling this * @param aParent - the SCH_EDIT_FRAME calling this
* @param aRescuer - the active RESCUER instance * @param aRescuer - the active RESCUER instance
* @param aAskShowAgain - if true, a "Never Show Again" button will be included * @param aAskShowAgain - if true, a "Never Show Again" button will be included
*/ */

8
pcbnew/github/github_getliblist.h
View File

@ -34,14 +34,14 @@
* *
* To extract pretty footprints library list, this plugin simply reads in * To extract pretty footprints library list, this plugin simply reads in
* a zip file of the repo and unzips it from RAM as needed. * a zip file of the repo and unzips it from RAM as needed.
* Therefore this "Github" plugin is <b>read only for accessing remote * Therefore this "Github" plugin is <b>read only</b> for accessing remote
* at https:////api.github.com//orgs//KiCad//repos * at "https://api.github.com/orgs/KiCad/repos"
* *
* To extract 3D shapes libraries list (.3dshapes folders) we cannot use api.github.com * 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. * to read this list, because it is in a subdirectory of "https://github.com/KiCad".
* The corresponding html page of the server is read, and URLs of all .3dshapes folders * The corresponding html page of the server is read, and URLs of all .3dshapes folders
* are extracted. * are extracted.
* files are then read from https://raw.githubusercontent.com/<lib path>, but not zipped * files are then read from "https://raw.githubusercontent.com/<lib path>", but not zipped
* because they are not accessible in zipped form. * because they are not accessible in zipped form.
*/ */
class GITHUB_GETLIBLIST class GITHUB_GETLIBLIST