From e5137f4eb4b982bfa624498fe5c911e79fc79731 Mon Sep 17 00:00:00 2001 From: jean-pierre charras Date: Wed, 21 Jun 2017 09:32:19 +0200 Subject: [PATCH] Fix a few doxygen warnings --- eeschema/bom_table_model.cpp | 6 +++--- eeschema/cmp_tree_model_adapter.h | 8 ++++---- eeschema/dialog_erc_listbox.h | 2 +- eeschema/project_rescue.cpp | 12 ++++++------ eeschema/sch_component.h | 7 +++++-- eeschema/sch_io_mgr.h | 2 +- eeschema/symbol_lib_table.h | 2 +- include/preview_items/polygon_geom_manager.h | 2 +- include/preview_items/polygon_item.h | 4 ++-- include/view/view.h | 2 +- include/view/view_controls.h | 8 ++++---- include/view/view_group.h | 2 +- include/view/view_item.h | 2 +- include/view/wx_view_controls.h | 7 ------- 14 files changed, 31 insertions(+), 35 deletions(-) diff --git a/eeschema/bom_table_model.cpp b/eeschema/bom_table_model.cpp index e2150d409c..65419a7db1 100644 --- a/eeschema/bom_table_model.cpp +++ b/eeschema/bom_table_model.cpp @@ -281,8 +281,8 @@ bool BOM_TABLE_GROUP::SetFieldValue( unsigned int aFieldId, const wxString aValu * - Tests each field in turn; all fields must match * - Some fields require special checking * - * @aFieldId - The ID of the field - * @aCmp - The component being tested + * @param aField - The field to test + * @param aComponent - The component being tested */ bool BOM_TABLE_GROUP::TestField( BOM_COLUMN* aField, BOM_TABLE_COMPONENT* aComponent ) const { @@ -413,7 +413,7 @@ bool BOM_TABLE_GROUP::HasValueChanged( BOM_COLUMN* aField ) const * Return a list of (ordered) references * for all the components in this group * - * @aSort - Sort the references + * @param aSort - Sort the references */ wxArrayString BOM_TABLE_GROUP::GetReferences( bool aSort ) const { diff --git a/eeschema/cmp_tree_model_adapter.h b/eeschema/cmp_tree_model_adapter.h index 1cf1f8fc40..a4cc5ec1b2 100644 --- a/eeschema/cmp_tree_model_adapter.h +++ b/eeschema/cmp_tree_model_adapter.h @@ -172,9 +172,9 @@ public: * Add the given list of components by alias. To be called in the setup * phase. * - * @param aNodeName the parent node the components will appear under - * @param aAliasNameList list of aliases - * @param aOptionalLib library to look up names in (null = global) + * @param aNodeName the parent node the components will appear under + * @param aAliasList list of aliases + * @param aOptionalLib library to look up names in (null = global) */ void AddAliasList( wxString const& aNodeName, @@ -323,7 +323,7 @@ private: * Compute the width required for the given column of a node and its * children. * - * @param aNode - root node of the tree + * @param aTree - root node of the tree * @param aCol - column number * @param aHeading - heading text, to set the minimum width */ diff --git a/eeschema/dialog_erc_listbox.h b/eeschema/dialog_erc_listbox.h index 65bde96c05..1b18d001c3 100644 --- a/eeschema/dialog_erc_listbox.h +++ b/eeschema/dialog_erc_listbox.h @@ -56,7 +56,7 @@ public: /** * Function AppendToList - * @param aItem The SCH_MARKER* to add to the current list which will be + * @param aMarker is the SCH_MARKER* to add to the current list which will be * later displayed in the wxHtmlWindow */ void AppendToList( SCH_MARKER* aMarker ) diff --git a/eeschema/project_rescue.cpp b/eeschema/project_rescue.cpp index 4607947896..4b7617fafe 100644 --- a/eeschema/project_rescue.cpp +++ b/eeschema/project_rescue.cpp @@ -141,6 +141,12 @@ static bool insert_library( PROJECT *aProject, PART_LIB *aLibrary, size_t aIndex } +// Helper sort function, used in get_components, to sort a component list by lib_id +static bool sort_by_libid( const SCH_COMPONENT* ref, SCH_COMPONENT* cmp ) +{ + return ref->GetLibId() < cmp->GetLibId(); +} + /** * Function get_components * Fills a vector with all of the project's components, to ease iterating over them. @@ -150,12 +156,6 @@ static bool insert_library( PROJECT *aProject, PART_LIB *aLibrary, size_t aIndex * * @param aComponents - a vector that will take the components */ -// Helper sort function, used in get_components, to sort a component list by lib_id -static bool sort_by_libid( const SCH_COMPONENT* ref, SCH_COMPONENT* cmp ) -{ - return ref->GetLibId() < cmp->GetLibId(); -} - static void get_components( std::vector& aComponents ) { SCH_SCREENS screens; diff --git a/eeschema/sch_component.h b/eeschema/sch_component.h index 45db94e6db..5091c0d332 100644 --- a/eeschema/sch_component.h +++ b/eeschema/sch_component.h @@ -299,8 +299,11 @@ public: SCH_FIELD* GetField( int aFieldNdx ) const; /** - * Returns text associated with a given field (if such a field exists) - * @aFieldName is the name of the field + * Search for a field named aFieldName and returns text associated with this field + * (if such a field exists) + * @param aFieldName is the name of the field + * @param aIncludeDefaultFields = true (default) to include default fields in search + * (default fields are the mandatory fields ref, value, fooprint and doc) */ wxString GetFieldText( wxString aFieldName, bool aIncludeDefaultFields = true ) const; diff --git a/eeschema/sch_io_mgr.h b/eeschema/sch_io_mgr.h index 2fb399ef42..9734762e43 100644 --- a/eeschema/sch_io_mgr.h +++ b/eeschema/sch_io_mgr.h @@ -142,7 +142,7 @@ public: * * @param aFileName is the name of a file to save to on disk. * - * @param aSchematic is the #SCH_SCREN document (data tree) to save or export to disk. + * @param aSchematic is the #SCH_SCREEN document (data tree) to save or export to disk. * * @param aKiway is the #KIWAY object used to access the component libraries loaded * by the project. diff --git a/eeschema/symbol_lib_table.h b/eeschema/symbol_lib_table.h index 59410067a9..4d1a4bf57a 100644 --- a/eeschema/symbol_lib_table.h +++ b/eeschema/symbol_lib_table.h @@ -206,7 +206,7 @@ public: * * @throw IO_ERROR if there is a problem finding the footprint or the library, or deleting it. */ - void DeleteSymbol( const wxString& aNickname, const wxString& aSymboltName ); + void DeleteSymbol( const wxString& aNickname, const wxString& aSymbolName ); /** * Function DeleteAlias diff --git a/include/preview_items/polygon_geom_manager.h b/include/preview_items/polygon_geom_manager.h index a6b665c1da..aaeda2b869 100644 --- a/include/preview_items/polygon_geom_manager.h +++ b/include/preview_items/polygon_geom_manager.h @@ -71,7 +71,7 @@ public: }; /** - * @param the client to pass the results onto + * @param aClient is the client to pass the results onto */ POLYGON_GEOM_MANAGER( CLIENT& aClient ); diff --git a/include/preview_items/polygon_item.h b/include/preview_items/polygon_item.h index 6d489f6f7a..00560e4add 100644 --- a/include/preview_items/polygon_item.h +++ b/include/preview_items/polygon_item.h @@ -57,8 +57,8 @@ public: /** * Set the polygon points * - * @param locked in points - the "fixed point" of the outline - * @param leader line points - the lines from the last fixed point to + * @param aLockedInPts - the "fixed points" of the outline + * @param aLeaderPts - the lines from the last fixed point to * another point, eg the cursor. */ void SetPoints( const std::vector& aLockedInPts, diff --git a/include/view/view.h b/include/view/view.h index e812665fb9..c484acde54 100644 --- a/include/view/view.h +++ b/include/view/view.h @@ -136,8 +136,8 @@ public: * @param aItem: the item to update. * @param aUpdateFlags: how much the object has changed. */ - void Update( VIEW_ITEM* aItem ); void Update( VIEW_ITEM* aItem, int aUpdateFlags ); + void Update( VIEW_ITEM* aItem ); /** * Function SetRequired() diff --git a/include/view/view_controls.h b/include/view/view_controls.h index 992dbacc93..21e78f1b7a 100644 --- a/include/view/view_controls.h +++ b/include/view/view_controls.h @@ -247,7 +247,7 @@ public: /** * Function EnableCursorWarping() * Enables or disables warping the cursor. - * @param aEnabled is true if the cursor is allowed to be warped. + * @param aEnable is true if the cursor is allowed to be warped. */ void EnableCursorWarping( bool aEnable ) { @@ -256,7 +256,7 @@ public: /** * Function IsCursorWarpingEnabled() - * Returns the current setting for cursor warping. + * @return the current setting for cursor warping. */ bool IsCursorWarpingEnabled() const { @@ -266,7 +266,7 @@ public: /** * Function EnableMousewheelPan() * Enables or disables mousewheel panning. - * @param aEnabled is true if mouse-wheel panning is enabled. + * @param aEnable is true if mouse-wheel panning is enabled. */ virtual void EnableMousewheelPan( bool aEnable ) { @@ -275,7 +275,7 @@ public: /** * Function IsMousewheelPanEnabled() - * Returns the current setting for mousewheel panning + * @return the current setting for mousewheel panning */ virtual bool IsMousewheelPanEnabled() const { diff --git a/include/view/view_group.h b/include/view/view_group.h index ebc88aba58..2485ca8c97 100644 --- a/include/view/view_group.h +++ b/include/view/view_group.h @@ -93,7 +93,7 @@ public: * Draws all the stored items in the group on the given layer. * * @param aLayer is the layer which should be drawn. - * @param aGal is the GAL that should be used for drawing. + * @param aView is the VIEW that should be used for drawing. */ virtual void ViewDraw( int aLayer, VIEW* aView ) const override; diff --git a/include/view/view_item.h b/include/view/view_item.h index 35e7617208..bec8016bfe 100644 --- a/include/view/view_item.h +++ b/include/view/view_item.h @@ -109,7 +109,7 @@ public: * for quick hacks and debugging purposes. * * @param aLayer: current drawing layer - * @param aGal: pointer to the GAL device we are drawing on + * @param aView: pointer to the VIEW device we are drawing on */ virtual void ViewDraw( int aLayer, VIEW* aView ) const {} diff --git a/include/view/wx_view_controls.h b/include/view/wx_view_controls.h index 41e80b3bd2..66ea86a3d8 100644 --- a/include/view/wx_view_controls.h +++ b/include/view/wx_view_controls.h @@ -70,13 +70,6 @@ public: */ void SetGrabMouse( bool aEnabled ) override; - /** - * Function SetAutoPan() - * Enables/disables autopanning (panning when mouse cursor reaches the panel border). - * - * @param aEnabled says whether the option should enabled or disabled. - */ - /// @copydoc VIEW_CONTROLS::GetMousePosition() VECTOR2D GetMousePosition( bool aWorldCoordinates = true ) const override;