Fix a few doxygen warnings

This commit is contained in:
jean-pierre charras 2017-06-30 09:50:49 +02:00
parent 805bfb048b
commit 22a8df69c4
6 changed files with 16 additions and 16 deletions

View File

@ -292,10 +292,7 @@ public:
/** /**
* Constructor. * Constructor.
* NETLIST_OBJECT_LIST handle a list of connected items. * NETLIST_OBJECT_LIST handle a list of connected items.
* the instance can be owner of items or not. * these NETLIST_OBJECT items are freeed by the destructor
* If it is the owner, the items are freeed by the destructor
* @param aIsOwner true if the instance is the owner of item list
* (default = false)
*/ */
NETLIST_OBJECT_LIST() NETLIST_OBJECT_LIST()
{ {

View File

@ -128,6 +128,7 @@ public:
/** /**
* Display pin info (given by GetMsgPanelInfo) and add some info related to aComponent * Display pin info (given by GetMsgPanelInfo) and add some info related to aComponent
* (schematic pin position, and sheet path) * (schematic pin position, and sheet path)
* @param aList is the message list to fill
* @param aComponent is the component which "owns" the pin * @param aComponent is the component which "owns" the pin
*/ */
void GetMsgPanelInfo( std::vector< MSG_PANEL_ITEM >& aList, SCH_COMPONENT* aComponent ); void GetMsgPanelInfo( std::vector< MSG_PANEL_ITEM >& aList, SCH_COMPONENT* aComponent );

View File

@ -206,6 +206,8 @@ protected:
* @param aLibrary = a reference to the library to explore * @param aLibrary = a reference to the library to explore
* If NULL the user will be prompted tp chose a library * If NULL the user will be prompted tp chose a library
* @param aBuffer = a wxString to put the selected component name * @param aBuffer = a wxString to put the selected component name
* @param aPreviousChoice = the previously selected component name.
* it will be added to the selection list. Can be empty.
* *
* @return true if a component is selected * @return true if a component is selected
* false on cancel * false on cancel

View File

@ -393,7 +393,7 @@ public:
* Autoplace fields only if correct to do so automatically. * Autoplace fields only if correct to do so automatically.
* *
* Fields that have been moved by hand are not automatically placed. * Fields that have been moved by hand are not automatically placed.
*. *
* @param aScreen is the SCH_SCREEN associated with the current instance of the * @param aScreen is the SCH_SCREEN associated with the current instance of the
* component. * component.
*/ */
@ -431,7 +431,7 @@ public:
/** /**
* Draw a component with or without pin text * Draw a component with or without pin text
*. *
* @param aPanel is the panel to use (can be null) mainly used for clipping purposes. * @param aPanel is the panel to use (can be null) mainly used for clipping purposes.
* @param aDC is the device context (can be null) * @param aDC is the device context (can be null)
* @param aOffset is the drawing offset (usually wxPoint(0,0), * @param aOffset is the drawing offset (usually wxPoint(0,0),
@ -528,9 +528,9 @@ public:
/** /**
* Test if the symbol's dangling state has changed for one given pin index. * Test if the symbol's dangling state has changed for one given pin index.
* *
* As a side effect, the actually updates the dangling status for that pin. * As a side effect, it actually updates the dangling status for that pin.
* *
* @param aItemList is list of all #DANGLING_END_ITEMs to be tested. * @param aItemList is list of all #DANGLING_END_ITEM items to be tested.
* @param aLibPins is list of all the #LIB_PIN items in this symbol * @param aLibPins is list of all the #LIB_PIN items in this symbol
* @param aPin is the index into \a aLibPins that identifies the pin to test * @param aPin is the index into \a aLibPins that identifies the pin to test
* @return true if the pin's state has changed. * @return true if the pin's state has changed.
@ -545,7 +545,7 @@ public:
* *
* @note This does not test for short circuits. * @note This does not test for short circuits.
* *
* @param aItemList is list of all #DANGLING_END_ITEMs to be tested. * @param aItemList is list of all #DANGLING_END_ITEM items to be tested.
* *
* @return true if any pin's state has changed. * @return true if any pin's state has changed.
*/ */

View File

@ -44,19 +44,19 @@ public:
NONCACHED_CONTAINER( unsigned int aSize = defaultInitSize ); NONCACHED_CONTAINER( unsigned int aSize = defaultInitSize );
virtual ~NONCACHED_CONTAINER(); virtual ~NONCACHED_CONTAINER();
///< @copydoc VERTEX_CONTAINER::SetItem( VERTEX_ITEM* aItem ) /// @copydoc VERTEX_CONTAINER::SetItem( VERTEX_ITEM* aItem )
virtual void SetItem( VERTEX_ITEM* aItem ) override; virtual void SetItem( VERTEX_ITEM* aItem ) override;
///< @copydoc VERTEX_CONTAINER::Allocate( unsigned int aSize ) /// @copydoc VERTEX_CONTAINER::Allocate( unsigned int aSize )
virtual VERTEX* Allocate( unsigned int aSize ) override; virtual VERTEX* Allocate( unsigned int aSize ) override;
///< @copydoc VERTEX_CONTAINER::Delete( VERTEX_ITEM* aItem ) /// @copydoc VERTEX_CONTAINER::Delete( VERTEX_ITEM* aItem )
void Delete( VERTEX_ITEM* aItem ) override {} void Delete( VERTEX_ITEM* aItem ) override {}
///< @copydoc VERTEX_CONTAINER::Clear() /// @copydoc VERTEX_CONTAINER::Clear()
virtual void Clear() override; virtual void Clear() override;
///< @copydoc VERTEX_CONTAINER::GetSize() /// @copydoc VERTEX_CONTAINER::GetSize()
virtual inline unsigned int GetSize() const override virtual inline unsigned int GetSize() const override
{ {
// As the m_freePtr points to the first free space, we can safely assume // As the m_freePtr points to the first free space, we can safely assume

View File

@ -370,7 +370,7 @@ private:
void drawStrokedSemiCircle( const VECTOR2D& aCenterPoint, double aRadius, double aAngle ); void drawStrokedSemiCircle( const VECTOR2D& aCenterPoint, double aRadius, double aAngle );
/** /**
* @param Generic way of drawing a polyline stored in different containers. * @brief Generic way of drawing a polyline stored in different containers.
* @param aPointGetter is a function to obtain coordinates of n-th vertex. * @param aPointGetter is a function to obtain coordinates of n-th vertex.
* @param aPointCount is the number of points to be drawn. * @param aPointCount is the number of points to be drawn.
*/ */
@ -388,7 +388,7 @@ private:
* @brief Draws a single character using bitmap font. * @brief Draws a single character using bitmap font.
* Its main purpose is to be used in BitmapText() function. * Its main purpose is to be used in BitmapText() function.
* *
* @param aCharacter is the character to be drawn. * @param aChar is the character to be drawn.
* @return Width of the drawn glyph. * @return Width of the drawn glyph.
*/ */
int drawBitmapChar( unsigned long aChar ); int drawBitmapChar( unsigned long aChar );