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

Fix Doxygen commenting issues.

This commit is contained in:
Wayne Stambaugh 2023-03-24 11:57:52 -04:00
parent 2e2cbb0594
commit 244c37298f
7 changed files with 29 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
eeschema/sim/sim_plot_colors.h
View File

@ -2,7 +2,7 @@
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2021 Sylwester Kocjan <s.kocjan@o2.pl>
* Copyright (C) 2016-2021 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 2016-2023 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
@ -75,7 +75,7 @@ public:
static void FillDefaultColorList( bool aWhiteBg );
private:
///> The color list to draw traces, bg, fg, axis...
///< The color list to draw traces, bg, fg, axis...
static std::vector<wxColour> m_colorList;
/**

4
eeschema/sim/sim_plot_panel.h
View File

@ -305,7 +305,7 @@ public:
///< Update trace line style
void UpdateTraceStyle( TRACE* trace );
///> Update plot colors
///< Update plot colors
void UpdatePlotColors();
void OnLanguageChanged() override;
@ -329,7 +329,7 @@ private:
///< @brief Construct the plot axes for DC simulation plot.
void prepareDCAxes( int aNewTraceType );
///> Create/Ensure axes are available for plotting
///< Create/Ensure axes are available for plotting
void updateAxes( int aNewTraceType = SIM_TRACE_TYPE::SPT_UNKNOWN );
private:

23
include/properties/pg_properties.h
View File

@ -2,6 +2,8 @@
* This program source code file is part of KICAD, a free EDA CAD application.
*
* Copyright (C) 2020 CERN
* Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors.
*
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
* This program is free software; you can redistribute it and/or
@ -33,7 +35,7 @@ class EDA_DRAW_FRAME;
wxPGProperty* PGPropertyFactory( const PROPERTY_BASE* aProperty, EDA_DRAW_FRAME* aFrame );
///> Customized abstract wxPGProperty class to handle coordinate/size units
///< Customized abstract wxPGProperty class to handle coordinate/size units
class PGPROPERTY_DISTANCE
{
public:
@ -57,9 +59,10 @@ class PGPROPERTY_SIZE : public wxUIntProperty, public PGPROPERTY_DISTANCE
{
public:
PGPROPERTY_SIZE( const wxString& aLabel = wxPG_LABEL, const wxString& aName = wxPG_LABEL,
long aValue = 0 );
long aValue = 0 );
bool StringToValue( wxVariant& aVariant, const wxString& aText, int aArgFlags = 0 ) const override
bool StringToValue( wxVariant& aVariant, const wxString& aText,
int aArgFlags = 0 ) const override
{
return StringToDistance( aVariant, aText, aArgFlags );
}
@ -80,7 +83,8 @@ public:
long aValue = 0,
ORIGIN_TRANSFORMS::COORD_TYPES_T aCoordType = ORIGIN_TRANSFORMS::NOT_A_COORD );
bool StringToValue( wxVariant& aVariant, const wxString& aText, int aArgFlags = 0 ) const override
bool StringToValue( wxVariant& aVariant, const wxString& aText,
int aArgFlags = 0 ) const override
{
return StringToDistance( aVariant, aText, aArgFlags );
}
@ -94,7 +98,7 @@ public:
};
///> Customized wxPGProperty class to handle angles
///< Customized wxPGProperty class to handle angles
class PGPROPERTY_ANGLE : public wxFloatProperty
{
public:
@ -104,7 +108,8 @@ public:
{
}
bool StringToValue( wxVariant& aVariant, const wxString& aText, int aArgFlags = 0 ) const override;
bool StringToValue( wxVariant& aVariant, const wxString& aText,
int aArgFlags = 0 ) const override;
wxString ValueToString( wxVariant& aVariant, int aArgFlags = 0 ) const override;
void SetScale( double aScale )
@ -114,16 +119,16 @@ public:
wxValidator* DoGetValidator() const override;
///> Do not perform PG validation; the UX is not what we want.
///< Do not perform PG validation; the UX is not what we want.
bool ValidateValue( wxVariant&, wxPGValidationInfo& ) const override { return true; }
protected:
///> Scale factor to convert between raw and displayed value
///< Scale factor to convert between raw and displayed value
double m_scale;
};
///> A wxEnumProperty that displays a color next to the enum value
///< A wxEnumProperty that displays a color next to the enum value
class PGPROPERTY_COLORENUM : public wxEnumProperty
{
public:

6
kicad/widgets/legacyfiledlg_new_project.h
View File

@ -1,7 +1,7 @@
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2022 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 2022-2023 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 as published by the
@ -24,7 +24,7 @@
#include <wx/panel.h>
#include <wx/sizer.h>
///> Helper widget to select whether a new directory should be created for a project.
///< Helper widget to select whether a new directory should be created for a project.
class LEGACYFILEDLG_NEW_PROJECT : public wxPanel
{
public:
@ -51,4 +51,4 @@ protected:
wxCheckBox* m_cbCreateDir;
};
#endif
#endif

4
pcbnew/widgets/pcb_properties_panel.h
View File

@ -2,6 +2,8 @@
* This program source code file is part of KICAD, a free EDA CAD application.
*
* Copyright (C) 2020 CERN
* Copyright (C) 2023 KiCad Developers, see AUTHORS.txt for contributors.
*
* @author Maciej Suminski <maciej.suminski@cern.ch>
*
* This program is free software; you can redistribute it and/or
@ -49,7 +51,7 @@ protected:
void valueChanging( wxPropertyGridEvent& aEvent ) override;
void valueChanged( wxPropertyGridEvent& aEvent ) override;
///> Regenerates caches storing layer and net names
///< Regenerates caches storing layer and net names
void updateLists( const BOARD* aBoard );
PCB_BASE_EDIT_FRAME* m_frame;

4
qa/unittests/eeschema/test_lib_part.cpp
View File

@ -1,7 +1,7 @@
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.txt for contributors.
* Copyright (C) 2019-2023 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
@ -42,7 +42,7 @@ public:
{
}
///> Part with no extra data set
///< Part with no extra data set
LIB_SYMBOL m_part_no_data;
};

6
qa/unittests/eeschema/test_sch_sheet.cpp
View File

@ -1,7 +1,7 @@
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2019-2021 KiCad Developers, see AUTHORS.TXT for contributors.
* Copyright (C) 2019-2023 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
@ -47,12 +47,12 @@ public:
{
}
///> Dummy schematic to attach the test sheet to
///< Dummy schematic to attach the test sheet to
SCHEMATIC m_schematic;
SCH_SHEET m_sheet;
///> Can use when you need a const ref (lots of places need fixing here)
///< Can use when you need a const ref (lots of places need fixing here)
const SCH_SHEET& m_csheet;
};