Fix a few more doxygen errors (no actual code change)
This commit is contained in:
parent
a20f757d8c
commit
d4cf063e40
|
@ -186,7 +186,7 @@ public:
|
|||
/**
|
||||
* Populate \a aList of #MSG_PANEL_ITEM objects with it's internal state for display
|
||||
* purposes.
|
||||
*
|
||||
* @param aFrame is the EDA_DRAW_FRAME that displays the message panel
|
||||
* @param aList is the list to populate.
|
||||
*/
|
||||
virtual void GetMsgPanelInfo( EDA_DRAW_FRAME* aFrame, std::vector<MSG_PANEL_ITEM>& aList )
|
||||
|
|
|
@ -62,6 +62,8 @@ public:
|
|||
*
|
||||
* @param aValue = value in internal units
|
||||
* @param aAddUnitLabel = true to add symbol unit to the string value
|
||||
* @param aType is the type of this value, and controls the way the value is converted
|
||||
* to a string, and the suitable unit
|
||||
* @return A wxString object containing value and optionally the symbol unit (like 2.000 mm)
|
||||
*/
|
||||
wxString StringFromValue( double aValue, bool aAddUnitLabel = false,
|
||||
|
@ -101,6 +103,8 @@ public:
|
|||
/**
|
||||
* Converts \a aTextValue in \a aUnits to internal units used by the frame.
|
||||
* @warning This utilizes the current locale and will break if decimal formats differ
|
||||
* @param aType is the type of this value, and controls the way the string is converted
|
||||
* to a value
|
||||
*
|
||||
* @param aTextValue A reference to a wxString object containing the string to convert.
|
||||
* @return internal units value
|
||||
|
|
|
@ -69,7 +69,7 @@ public:
|
|||
|
||||
/**
|
||||
* Represent a DRC "provider" which runs some DRC functions over a #BOARD and spits out
|
||||
* #DRC_ITEMs and positions as needed.
|
||||
* #DRC_ITEM and positions as needed.
|
||||
*/
|
||||
class DRC_TEST_PROVIDER : public UNITS_PROVIDER
|
||||
{
|
||||
|
|
|
@ -55,7 +55,7 @@ namespace TOOL_EVT_UTILS
|
|||
* direction indicated by a rotation action event
|
||||
*
|
||||
* @param aFrame the PCB edit frame to use to get the base rotation step value from
|
||||
* @param aEvt the tool event - should be a rotation action event and should have a rotation
|
||||
* @param aEvent the tool event - should be a rotation action event and should have a rotation
|
||||
* multiplier parameter
|
||||
*
|
||||
* @return the clockwise rotation angle
|
||||
|
|
Loading…
Reference in New Issue