From 70226ecdebf5057f1dd0379f4987f0f8806b1403 Mon Sep 17 00:00:00 2001
From: jean-pierre charras <jp.charras@wanadoo.fr>
Date: Tue, 20 Jun 2017 08:10:30 +0200
Subject: [PATCH] Fix a few doxygen warnings
---
3d-viewer/3d_cache/sg/scenegraph.h | 2 +-
include/config_map.h | 5 ++---
include/gal/graphics_abstraction_layer.h | 1 +
include/gal/stroke_font.h | 10 ++++++----
include/ki_exception.h | 2 +-
include/kiface_i.h | 2 ++
include/painter.h | 1 +
include/plugins/3d/3d_plugin.h | 12 ++++--------
pcbnew/dialogs/dialog_fp_lib_table.cpp | 4 ++--
pcbnew/dialogs/wizard_3DShape_Libs_downloader.cpp | 4 ++--
pcbnew/footprint_wizard_frame.h | 2 +-
pcbnew/invoke_pcb_dialog.h | 4 ++--
pcbnew/module_editor_frame.h | 2 +-
pcbnew/pcb_base_edit_frame.h | 2 +-
pcbnew/ratsnest_data.h | 8 ++++----
pcbnew/zone_filling_algorithm.cpp | 2 +-
16 files changed, 32 insertions(+), 31 deletions(-)
diff --git a/3d-viewer/3d_cache/sg/scenegraph.h b/3d-viewer/3d_cache/sg/scenegraph.h
index c50e5c9473..8160886603 100644
--- a/3d-viewer/3d_cache/sg/scenegraph.h
+++ b/3d-viewer/3d_cache/sg/scenegraph.h
@@ -25,7 +25,7 @@
* @file scenegraph.h
* defines the basic data set required to represent a 3D model;
* this model must remain compatible with VRML2.0 in order to
- * facilitate VRML export of scene graph data created by avaiable
+ * facilitate VRML export of scene graph data created by available
* 3D plugins.
*/
diff --git a/include/config_map.h b/include/config_map.h
index 1e0646b273..bf586b1d07 100644
--- a/include/config_map.h
+++ b/include/config_map.h
@@ -90,11 +90,10 @@ static long GetConfigForVal( const MAP& aMap, CFG_NATIVE_VAL<MAP> aVal )
* The default item is returned if the mapping fails.
*
* @param aMap the value-config mapping table
- * @param aVal the config value to look up
+ * @param aConf the config value to look up
*/
template<typename MAP>
-static CFG_NATIVE_VAL<MAP> GetValFromConfig(
- const MAP& aMap, long aConf )
+static CFG_NATIVE_VAL<MAP> GetValFromConfig( const MAP& aMap, long aConf )
{
// default is first entry
CFG_NATIVE_VAL<MAP> aVal = aMap[0].first;
diff --git a/include/gal/graphics_abstraction_layer.h b/include/gal/graphics_abstraction_layer.h
index 00e5bc94ec..1cac4e9288 100644
--- a/include/gal/graphics_abstraction_layer.h
+++ b/include/gal/graphics_abstraction_layer.h
@@ -145,6 +145,7 @@ public:
* @param aRadius is the arc radius.
* @param aStartAngle is the start angle of the arc.
* @param aEndAngle is the end angle of the arc.
+ * @param aWidth is the thickness of the arc (pen size).
*/
virtual void
DrawArcSegment( const VECTOR2D& aCenterPoint, double aRadius, double aStartAngle,
diff --git a/include/gal/stroke_font.h b/include/gal/stroke_font.h
index 4d7dc17240..b84e570fff 100644
--- a/include/gal/stroke_font.h
+++ b/include/gal/stroke_font.h
@@ -107,16 +107,18 @@ public:
/**
* Compute the vertical position of an overbar, sometimes used in texts.
* This is the distance between the text base line and the overbar.
+ * @param aGlyphHeight is the height (vertical size) of the text.
+ * @param aGlyphThickness is the thickness of the lines used to draw the text.
* @return the relative position of the overbar axis.
*/
double ComputeOverbarVerticalPosition( double aGlyphHeight, double aGlyphThickness ) const;
/**
- * @brief Compute the X and Y size of a given text. The text is expected to be
- * a only one line text.
+ * @brief Compute the distance (interline) between 2 lines of text (for multiline texts).
*
- * @param aText is the text string (one line).
- * @return the text size.
+ * @param aGlyphHeight is the height (vertical size) of the text.
+ * @param aGlyphThickness is the thickness of the lines used to draw the text.
+ * @return the interline.
*/
static double GetInterline( double aGlyphHeight, double aGlyphThickness );
diff --git a/include/ki_exception.h b/include/ki_exception.h
index ec1556571b..099aeb406f 100644
--- a/include/ki_exception.h
+++ b/include/ki_exception.h
@@ -56,7 +56,7 @@ public:
* at the source file of thrower.
*
* @param aThrowersFunction is the function name at the throw site.
- * @param aThrowersLineNumber, is the source code line number of the throw.
+ * @param aThrowersLineNumber is the source code line number of the throw.
*
* Use macro THROW_IO_ERROR() to wrap a call to this constructor at the call site.
*/
diff --git a/include/kiface_i.h b/include/kiface_i.h
index 6a4134f7a7..cb2b436ef1 100644
--- a/include/kiface_i.h
+++ b/include/kiface_i.h
@@ -72,6 +72,8 @@ public:
* which contains the name of the DSO. Examples: "eeschema", "pcbnew", etc.
* This controls the name of the wxConfigBase established in m_bm,
* so it should be lowercase.
+ * @param aId is the type of DSO ( FACE_SCH, FACE_PCB, FACE_CVPCB,
+ * FACE_GERBVIEW, FACE_PL_EDITOR, FACE_PCB_CALCULATOR, FACE_BMP2CMP)
*/
KIFACE_I( const char* aKifaceName, KIWAY::FACE_T aId ) :
m_id( aId ),
diff --git a/include/painter.h b/include/painter.h
index 4f0df3d72e..d408389b93 100644
--- a/include/painter.h
+++ b/include/painter.h
@@ -71,6 +71,7 @@ public:
* Sets the specified layer as active - it means that it can be drawn in a specific mode
* (eg. highlighted, so it differs from other layers).
* @param aLayerId is a layer number that should be displayed in a specific mode.
+ * @param aEnabled is the new layer state ( true = active or false = not active).
*/
inline void SetActiveLayer( int aLayerId, bool aEnabled = true )
{
diff --git a/include/plugins/3d/3d_plugin.h b/include/plugins/3d/3d_plugin.h
index 935dc79a33..be976ac122 100644
--- a/include/plugins/3d/3d_plugin.h
+++ b/include/plugins/3d/3d_plugin.h
@@ -122,16 +122,12 @@ KICAD_PLUGIN_EXPORT char const* GetFileFilter( int aIndex );
KICAD_PLUGIN_EXPORT bool CanRender( void );
/**
- * Function Load
- * reads the model file and creates a generic display structure
+ * reads a model file and creates a generic display structure
*
* @param aFileName is the full path of the model file
- * @param aModel is a handle to a null pointer; on successful
- * reading of the model data aModel will point to a representation
- * for rendering
- * @param returns true if the model was successfully loaded and false
- * if there is no rendering support for the model or there were
- * problems reading the model
+ * @return a SCENEGRAPH pointer to the display structure if the model
+ * was successfully loaded and NULL if there is no rendering support
+ * for the model or there were problems reading the model
*/
KICAD_PLUGIN_EXPORT SCENEGRAPH* Load( char const* aFileName );
diff --git a/pcbnew/dialogs/dialog_fp_lib_table.cpp b/pcbnew/dialogs/dialog_fp_lib_table.cpp
index d2dc2eaac6..9b1c65066a 100644
--- a/pcbnew/dialogs/dialog_fp_lib_table.cpp
+++ b/pcbnew/dialogs/dialog_fp_lib_table.cpp
@@ -751,10 +751,10 @@ void DIALOG_FP_LIB_TABLE::OnClickLibraryWizard( wxCommandEvent& event )
}
-int InvokePcbLibTableEditor( wxTopLevelWindow* aParent, FP_LIB_TABLE* aGlobal,
+int InvokePcbLibTableEditor( wxTopLevelWindow* aCaller, FP_LIB_TABLE* aGlobal,
FP_LIB_TABLE* aProject )
{
- DIALOG_FP_LIB_TABLE dlg( aParent, aGlobal, aProject );
+ DIALOG_FP_LIB_TABLE dlg( aCaller, aGlobal, aProject );
int dialogRet = dlg.ShowModal(); // returns value passed to EndModal() above
diff --git a/pcbnew/dialogs/wizard_3DShape_Libs_downloader.cpp b/pcbnew/dialogs/wizard_3DShape_Libs_downloader.cpp
index 00049a5ae2..69ed72cb36 100644
--- a/pcbnew/dialogs/wizard_3DShape_Libs_downloader.cpp
+++ b/pcbnew/dialogs/wizard_3DShape_Libs_downloader.cpp
@@ -54,9 +54,9 @@
#define DEFAULT_GITHUB_3DSHAPES_LIBS_URL \
wxT( "https://github.com/KiCad/kicad-library/tree/master/modules/packages3d" )
-void Invoke3DShapeLibsDownloaderWizard( wxTopLevelWindow* aParent )
+void Invoke3DShapeLibsDownloaderWizard( wxTopLevelWindow* aCaller )
{
- WIZARD_3DSHAPE_LIBS_DOWNLOADER wizard( aParent );
+ WIZARD_3DSHAPE_LIBS_DOWNLOADER wizard( aCaller );
wizard.RunWizard( wizard.GetFirstPage() );
}
diff --git a/pcbnew/footprint_wizard_frame.h b/pcbnew/footprint_wizard_frame.h
index 8e6a263fb8..206e190c5a 100644
--- a/pcbnew/footprint_wizard_frame.h
+++ b/pcbnew/footprint_wizard_frame.h
@@ -173,7 +173,7 @@ private:
void SaveSettings( wxConfigBase* aCfg ) override;
///> @copydoc EDA_DRAW_FRAME::GetHotKeyDescription()
- EDA_HOTKEY* GetHotKeyDescription( int ) const override { return NULL; }
+ EDA_HOTKEY* GetHotKeyDescription( int aCommand ) const override { return NULL; }
/**
* Function OnActivate
diff --git a/pcbnew/invoke_pcb_dialog.h b/pcbnew/invoke_pcb_dialog.h
index e74e8a2325..91247da54f 100644
--- a/pcbnew/invoke_pcb_dialog.h
+++ b/pcbnew/invoke_pcb_dialog.h
@@ -89,7 +89,7 @@ int InvokePcbLibTableEditor( wxTopLevelWindow* aCaller, FP_LIB_TABLE* aGlobal,
* 2 - changes in the project table
* 3 - changes in both tables
*/
-int InvokeFootprintWizard( wxTopLevelWindow* aParent, FP_LIB_TABLE* aGlobal,
+int InvokeFootprintWizard( wxTopLevelWindow* aCaller, FP_LIB_TABLE* aGlobal,
FP_LIB_TABLE* aProject );
/**
@@ -99,7 +99,7 @@ int InvokeFootprintWizard( wxTopLevelWindow* aParent, FP_LIB_TABLE* aGlobal,
*
* @param aCaller is the wxTopLevelWindow which is invoking the dialog.
*/
-void Invoke3DShapeLibsDownloaderWizard( wxTopLevelWindow* aParent );
+void Invoke3DShapeLibsDownloaderWizard( wxTopLevelWindow* aCaller );
/**
diff --git a/pcbnew/module_editor_frame.h b/pcbnew/module_editor_frame.h
index c860352ed6..67badbf136 100644
--- a/pcbnew/module_editor_frame.h
+++ b/pcbnew/module_editor_frame.h
@@ -56,7 +56,7 @@ public:
*/
static const wxChar* GetFootprintEditorFrameName();
- ///> @copydoc PCB_BASE_FRAME::GetModel()
+ ///> @copydoc PCB_BASE_EDIT_FRAME::GetModel()
BOARD_ITEM_CONTAINER* GetModel() const override;
BOARD_DESIGN_SETTINGS& GetDesignSettings() const override;
diff --git a/pcbnew/pcb_base_edit_frame.h b/pcbnew/pcb_base_edit_frame.h
index ef68feebdf..83427f005a 100644
--- a/pcbnew/pcb_base_edit_frame.h
+++ b/pcbnew/pcb_base_edit_frame.h
@@ -46,7 +46,7 @@ public:
/**
* Function GetModel()
- * returns the primary data model.
+ * @return the primary data model.
*/
virtual BOARD_ITEM_CONTAINER* GetModel() const = 0;
diff --git a/pcbnew/ratsnest_data.h b/pcbnew/ratsnest_data.h
index 5497c23c68..94d97c4263 100644
--- a/pcbnew/ratsnest_data.h
+++ b/pcbnew/ratsnest_data.h
@@ -484,7 +484,7 @@ public:
/**
* Function GetClosestNode()
* Returns a single node that lies in the shortest distance from a specific node and meets
- * selected filter criterion..
+ * selected filter criterion.
* @param aNode is the node for which the closest node is searched.
* @param aFilter is a functor that filters nodes.
*/
@@ -516,7 +516,7 @@ public:
/**
* Function AddSimple()
* Changes drawing mode for an item to simple (i.e. one ratsnest line per node).
- * @param aNode is a node that changes its drawing mode.
+ * @param aItem is the item that changes its drawing mode.
*/
void AddSimple( const BOARD_CONNECTED_ITEM* aItem );
@@ -769,9 +769,9 @@ public:
/**
* Function AreConnected()
* Checks if two items are connected with copper.
- * @param aThis is the first item.
+ * @param aItem is the first item.
* @param aOther is the second item.
- * @return True if they are connected, false otherwise.
+ * @return true if they are connected, false otherwise.
*/
bool AreConnected( const BOARD_CONNECTED_ITEM* aItem, const BOARD_CONNECTED_ITEM* aOther );
diff --git a/pcbnew/zone_filling_algorithm.cpp b/pcbnew/zone_filling_algorithm.cpp
index c3c5b9802d..5b971a42eb 100644
--- a/pcbnew/zone_filling_algorithm.cpp
+++ b/pcbnew/zone_filling_algorithm.cpp
@@ -142,7 +142,7 @@ bool ZONE_CONTAINER::BuildFilledSolidAreasPolygons( BOARD* aPcb, SHAPE_POLY_SET*
* It can be used for any angle, if the zone outline to fill is rotated by this angle
* and the result is rotated by -angle
* @param aPolygon = a SHAPE_LINE_CHAIN polygon to fill
- * @param aFillSegmList = a std::vector <SEGMENT> which will be populated by filling segments
+ * @param aFillSegmList = a std::vector\<SEGMENT\> which will be populated by filling segments
* @param aStep = the horizontal grid size
*/
bool fillPolygonWithHorizontalSegments( const SHAPE_LINE_CHAIN& aPolygon,