From 22a8df69c47c70cba15012b0325d172f5595ffd1 Mon Sep 17 00:00:00 2001 From: jean-pierre charras Date: Fri, 30 Jun 2017 09:50:49 +0200 Subject: [PATCH] Fix a few doxygen warnings --- eeschema/class_netlist_object.h | 5 +---- eeschema/lib_pin.h | 1 + eeschema/sch_base_frame.h | 2 ++ eeschema/sch_component.h | 10 +++++----- include/gal/opengl/noncached_container.h | 10 +++++----- include/gal/opengl/opengl_gal.h | 4 ++-- 6 files changed, 16 insertions(+), 16 deletions(-) diff --git a/eeschema/class_netlist_object.h b/eeschema/class_netlist_object.h index 81c3d93a78..772b5fdff8 100644 --- a/eeschema/class_netlist_object.h +++ b/eeschema/class_netlist_object.h @@ -292,10 +292,7 @@ public: /** * Constructor. * NETLIST_OBJECT_LIST handle a list of connected items. - * the instance can be owner of items or not. - * 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) + * these NETLIST_OBJECT items are freeed by the destructor */ NETLIST_OBJECT_LIST() { diff --git a/eeschema/lib_pin.h b/eeschema/lib_pin.h index 1d9ffe60fc..5134e34d97 100644 --- a/eeschema/lib_pin.h +++ b/eeschema/lib_pin.h @@ -128,6 +128,7 @@ public: /** * Display pin info (given by GetMsgPanelInfo) and add some info related to aComponent * (schematic pin position, and sheet path) + * @param aList is the message list to fill * @param aComponent is the component which "owns" the pin */ void GetMsgPanelInfo( std::vector< MSG_PANEL_ITEM >& aList, SCH_COMPONENT* aComponent ); diff --git a/eeschema/sch_base_frame.h b/eeschema/sch_base_frame.h index 7757f48f78..41ae0e46c7 100644 --- a/eeschema/sch_base_frame.h +++ b/eeschema/sch_base_frame.h @@ -206,6 +206,8 @@ protected: * @param aLibrary = a reference to the library to explore * If NULL the user will be prompted tp chose a library * @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 * false on cancel diff --git a/eeschema/sch_component.h b/eeschema/sch_component.h index 6c16b0a092..2d6d047f69 100644 --- a/eeschema/sch_component.h +++ b/eeschema/sch_component.h @@ -393,7 +393,7 @@ public: * Autoplace fields only if correct to do so automatically. * * Fields that have been moved by hand are not automatically placed. - *. + * * @param aScreen is the SCH_SCREEN associated with the current instance of the * component. */ @@ -431,7 +431,7 @@ public: /** * Draw a component with or without pin text - *. + * * @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 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. * - * 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 aPin is the index into \a aLibPins that identifies the pin to test * @return true if the pin's state has changed. @@ -545,7 +545,7 @@ public: * * @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. */ diff --git a/include/gal/opengl/noncached_container.h b/include/gal/opengl/noncached_container.h index dd45d6d917..f8dfa91977 100644 --- a/include/gal/opengl/noncached_container.h +++ b/include/gal/opengl/noncached_container.h @@ -44,19 +44,19 @@ public: NONCACHED_CONTAINER( unsigned int aSize = defaultInitSize ); virtual ~NONCACHED_CONTAINER(); - ///< @copydoc VERTEX_CONTAINER::SetItem( VERTEX_ITEM* aItem ) + /// @copydoc VERTEX_CONTAINER::SetItem( VERTEX_ITEM* aItem ) 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; - ///< @copydoc VERTEX_CONTAINER::Delete( VERTEX_ITEM* aItem ) + /// @copydoc VERTEX_CONTAINER::Delete( VERTEX_ITEM* aItem ) void Delete( VERTEX_ITEM* aItem ) override {} - ///< @copydoc VERTEX_CONTAINER::Clear() + /// @copydoc VERTEX_CONTAINER::Clear() virtual void Clear() override; - ///< @copydoc VERTEX_CONTAINER::GetSize() + /// @copydoc VERTEX_CONTAINER::GetSize() virtual inline unsigned int GetSize() const override { // As the m_freePtr points to the first free space, we can safely assume diff --git a/include/gal/opengl/opengl_gal.h b/include/gal/opengl/opengl_gal.h index f5c979df7e..6aa7e67382 100644 --- a/include/gal/opengl/opengl_gal.h +++ b/include/gal/opengl/opengl_gal.h @@ -370,7 +370,7 @@ private: 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 aPointCount is the number of points to be drawn. */ @@ -388,7 +388,7 @@ private: * @brief Draws a single character using bitmap font. * 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. */ int drawBitmapChar( unsigned long aChar );