Formatting and commenting.

This commit is contained in:
Jeff Young 2022-10-05 17:21:47 +01:00
parent 6f2b2d7e19
commit b52106aa37
2 changed files with 15 additions and 14 deletions

View File

@ -1,7 +1,7 @@
/* /*
* 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-2020 KiCad Developers, see AUTHORS.txt for contributors. * Copyright (C) 1992-2022 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
@ -37,8 +37,6 @@ bool EDA_UNIT_UTILS::IsImperialUnit( EDA_UNITS aUnit )
default: default:
return false; return false;
} }
return false;
} }
@ -52,8 +50,6 @@ bool EDA_UNIT_UTILS::IsMetricUnit( EDA_UNITS aUnit )
default: default:
return false; return false;
} }
return false;
} }
@ -293,8 +289,8 @@ wxString EDA_UNIT_UTILS::UI::StringFromValue( const EDA_IU_SCALE& aIuScale, EDA_
// A lower-precision (for readability) version of StringFromValue() // A lower-precision (for readability) version of StringFromValue()
wxString EDA_UNIT_UTILS::UI::MessageTextFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits, wxString EDA_UNIT_UTILS::UI::MessageTextFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
int aValue, int aValue,
bool aAddUnitLabel, bool aAddUnitLabel,
EDA_DATA_TYPE aType ) EDA_DATA_TYPE aType )
{ {
return MessageTextFromValue( aIuScale, aUnits, double( aValue ), aAddUnitLabel, aType ); return MessageTextFromValue( aIuScale, aUnits, double( aValue ), aAddUnitLabel, aType );
} }
@ -303,8 +299,8 @@ wxString EDA_UNIT_UTILS::UI::MessageTextFromValue( const EDA_IU_SCALE& aIuScale,
// A lower-precision (for readability) version of StringFromValue() // A lower-precision (for readability) version of StringFromValue()
wxString EDA_UNIT_UTILS::UI::MessageTextFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits, wxString EDA_UNIT_UTILS::UI::MessageTextFromValue( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
long long int aValue, long long int aValue,
bool aAddUnitLabel, bool aAddUnitLabel,
EDA_DATA_TYPE aType ) EDA_DATA_TYPE aType )
{ {
return MessageTextFromValue( aIuScale, aUnits, double( aValue ), aAddUnitLabel, aType ); return MessageTextFromValue( aIuScale, aUnits, double( aValue ), aAddUnitLabel, aType );
} }
@ -436,7 +432,9 @@ double EDA_UNIT_UTILS::UI::DoubleValueFromString( const wxString& aTextValue )
if( !( ( ch >= '0' && ch <= '9' ) || ( ch == decimal_point ) || ( ch == '-' ) if( !( ( ch >= '0' && ch <= '9' ) || ( ch == decimal_point ) || ( ch == '-' )
|| ( ch == '+' ) ) ) || ( ch == '+' ) ) )
{
break; break;
}
++brk_point; ++brk_point;
} }
@ -449,7 +447,7 @@ double EDA_UNIT_UTILS::UI::DoubleValueFromString( const wxString& aTextValue )
double EDA_UNIT_UTILS::UI::DoubleValueFromString( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits, double EDA_UNIT_UTILS::UI::DoubleValueFromString( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
const wxString& aTextValue, EDA_DATA_TYPE aType ) const wxString& aTextValue, EDA_DATA_TYPE aType )
{ {
double dtmp = 0; double dtmp = 0;
@ -482,8 +480,9 @@ double EDA_UNIT_UTILS::UI::DoubleValueFromString( const EDA_IU_SCALE& aIuScale,
// Check the optional unit designator (2 ch significant) // Check the optional unit designator (2 ch significant)
wxString unit( buf.Mid( brk_point ).Strip( wxString::leading ).Left( 2 ).Lower() ); wxString unit( buf.Mid( brk_point ).Strip( wxString::leading ).Left( 2 ).Lower() );
if( aUnits == EDA_UNITS::MILLIMETRES || aUnits == EDA_UNITS::MILS if( aUnits == EDA_UNITS::MILLIMETRES
|| aUnits == EDA_UNITS::INCHES ) || aUnits == EDA_UNITS::MILS
|| aUnits == EDA_UNITS::INCHES )
{ {
if( unit == wxT( "mm" ) ) if( unit == wxT( "mm" ) )
{ {
@ -528,7 +527,7 @@ double EDA_UNIT_UTILS::UI::DoubleValueFromString( const EDA_IU_SCALE& aIuScale,
long long int EDA_UNIT_UTILS::UI::ValueFromString( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits, long long int EDA_UNIT_UTILS::UI::ValueFromString( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
const wxString& aTextValue, EDA_DATA_TYPE aType ) const wxString& aTextValue, EDA_DATA_TYPE aType )
{ {
double value = DoubleValueFromString( aIuScale, aUnits, aTextValue, aType ); double value = DoubleValueFromString( aIuScale, aUnits, aTextValue, aType );

View File

@ -195,6 +195,7 @@ namespace EDA_UNIT_UTILS
* converts \a aTextValue to a double * converts \a aTextValue to a double
* @warning This utilizes the current locale and will break if decimal formats differ * @warning This utilizes the current locale and will break if decimal formats differ
* *
* @param aIuScale The internal units scale for the current frame/app.
* @param aUnits The units of \a aTextValue. * @param aUnits The units of \a aTextValue.
* @param aTextValue A reference to a wxString object containing the string to convert. * @param aTextValue A reference to a wxString object containing the string to convert.
* @return A double representing that value in internal units * @return A double representing that value in internal units
@ -210,9 +211,10 @@ namespace EDA_UNIT_UTILS
* converts \a aTextValue in \a aUnits to internal units used by the application. * converts \a aTextValue in \a aUnits to internal units used by the application.
* @warning This utilizes the current locale and will break if decimal formats differ * @warning This utilizes the current locale and will break if decimal formats differ
* *
* @param aIuScale The internal units scale for the current frame/app.
* @param aUnits The units of \a aTextValue. * @param aUnits The units of \a aTextValue.
* @param aTextValue A reference to a wxString object containing the string to convert. * @param aTextValue A reference to a wxString object containing the string to convert.
* @return The string from Value, according to units (inch, mm ...) for display, * @return A long long int representing that value in internal units
*/ */
long long int ValueFromString( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits, long long int ValueFromString( const EDA_IU_SCALE& aIuScale, EDA_UNITS aUnits,
const wxString& aTextValue, const wxString& aTextValue,