Gerbview: fix most of Doxygen warnings. (2e2ecdd4) · Commits · Elphel / kicad-source-mirror

common/edaappl.cpp

+8 −10

Original line number	Diff line number	Diff line
		@@ -872,7 +872,7 @@ wxString WinEDA_App::FindFileInSearchPaths( const wxString& filename,
		}


		/**
		/* GetHelpFile
		* Get the help file path.
		*
		* Return the Kicad help file with path. The base paths defined in
		@@ -880,8 +880,8 @@ wxString WinEDA_App::FindFileInSearchPaths( const wxString& filename,
		* be relative depending on the paths added to m_searchPaths. See the
		* documentation for wxPathList for more information. If the help file
		* for the current locale is not found, an attempt to find the English
		* version of the help file is made. wxEmptyString is returned if the
		* help file is not found.
		* version of the help file is made.
		* wxEmptyString is returned if help file not found.
		* Help file is searched in directories in this order:
		* help/<canonical name> like help/en_GB
		* help/<short name> like help/en
		@@ -1070,13 +1070,12 @@ wxString WinEDA_App::ReturnFilenameWithRelativePathInLibPath( const wxString& aF
		}


		/** FindLibraryPath
		/* FindLibraryPath
		* Kicad saves user defined library files that are not in the standard
		* library search path list with the full file path. Calling the library
		* search path list with a user library file will fail. This helper method
		* solves that problem.
		* @param fileName
		* @return a wxEmptyString if library file is not found.
		* return a wxEmptyString if library file is not found.
		*/
		wxString WinEDA_App::FindLibraryPath( const wxString& aFileName )
		{
		@@ -1087,10 +1086,9 @@ wxString WinEDA_App::FindLibraryPath( const wxString& aFileName )
		}


		/**
		* Function RemoveLibraryPath
		/* Function RemoveLibraryPath
		* Removes the given path(s) from the library path list
		* @param aPaths = path or path list to remove. paths must be separated by ";"
		* aPaths = path or path list to remove. paths must be separated by ";"
		*/
		void WinEDA_App::RemoveLibraryPath( const wxString& aPaths )
		{

gerbview/class_aperture_macro.h

+1 −0

Original line number	Diff line number	Diff line
		@@ -189,6 +189,7 @@ struct APERTURE_MACRO
		* But some parameters are defined outside the aperture primitive
		* and are local to the aperture macro
		* @return the value of a defered parameter defined inside the aperture macro
		* @param aDcode = the D_CODE that uses this apertur macro and define defered parameters
		* @param aParamId = the param id (defined by $3 or $5 ..) to evaluate
		*/
		double GetLocalParam( const D_CODE* aDcode, unsigned aParamId ) const;

gerbview/class_gerber_draw_item.cpp

+9 −9

Original line number	Diff line number	Diff line
		@@ -271,7 +271,7 @@ EDA_Rect GERBER_DRAW_ITEM::GetBoundingBox() const
		/**
		* Function MoveAB
		* move this object.
		* @param const wxPoint& aMoveVector - the move vector for this object, in AB plotter axis.
		* @param aMoveVector - the move vector for this object, in AB plotter axis.
		*/
		void GERBER_DRAW_ITEM::MoveAB( const wxPoint& aMoveVector )
		{
		@@ -288,7 +288,7 @@ void GERBER_DRAW_ITEM::MoveAB( const wxPoint& aMoveVector )
		/**
		* Function MoveXY
		* move this object.
		* @param const wxPoint& aMoveVector - the move vector for this object, in XY gerber axis.
		* @param aMoveVector - the move vector for this object, in XY gerber axis.
		*/
		void GERBER_DRAW_ITEM::MoveXY( const wxPoint& aMoveVector )
		{
		@@ -552,7 +552,7 @@ void GERBER_DRAW_ITEM::ConvertSegmentToPolygon( )
		}


		/**
		/*
		* Function DrawGbrPoly
		* a helper function used id ::Draw to draw the polygon stored in m_PolyCorners
		* Draw filled polygons
		@@ -661,17 +661,17 @@ bool GERBER_DRAW_ITEM::HitTest( const wxPoint& aRefPos )
		* Function HitTest (overlayed)
		* tests if the given EDA_Rect intersect this object.
		* For now, an ending point must be inside this rect.
		* @param refArea : the given EDA_Rect in AB plotter axis
		* @param aRefArea : the given EDA_Rect in AB plotter axis
		* @return bool - true if a hit, else false
		*/
		bool GERBER_DRAW_ITEM::HitTest( EDA_Rect& refArea )
		bool GERBER_DRAW_ITEM::HitTest( EDA_Rect& aRefArea )
		{
		wxPoint pos = GetABPosition( m_Start );

		if( refArea.Inside( pos ) )
		if( aRefArea.Inside( pos ) )
		return true;
		pos = GetABPosition( m_End );
		if( refArea.Inside( pos ) )
		if( aRefArea.Inside( pos ) )
		return true;
		return false;
		}

gerbview/class_gerber_draw_item.h

+5 −5

Original line number	Diff line number	Diff line
		@@ -147,14 +147,14 @@ public:
		/**
		* Function MoveAB
		* move this object.
		* @param const wxPoint& aMoveVector - the move vector for this object.
		* @param aMoveVector - the move vector for this object.
		*/
		void MoveAB( const wxPoint& aMoveVector );

		/**
		* Function MoveXY
		* move this object.
		* @param const wxPoint& aMoveVector - the move vector for this object, in XY gerber axis.
		* @param aMoveVector - the move vector for this object, in XY gerber axis.
		*/
		void MoveXY( const wxPoint& aMoveVector );

		@@ -238,7 +238,7 @@ public:
		/**
		* Function HitTest
		* tests if the given wxPoint is within the bounds of this object.
		* @param aRefPos A wxPoint to test
		* @param aRefPos a wxPoint to test
		* @return bool - true if a hit, else false
		*/
		bool HitTest( const wxPoint& aRefPos );
		@@ -247,7 +247,7 @@ public:
		* Function HitTest (overlayed)
		* tests if the given wxRect intersect this object.
		* For now, an ending point must be inside this rect.
		* @param aRefPos A wxPoint to test
		* @param aRefArea a wxPoint to test
		* @return bool - true if a hit, else false
		*/
		bool HitTest( EDA_Rect& aRefArea );

gerbview/class_gerbview_layer_widget.cpp

+1 −1

Original line number	Diff line number	Diff line
		@@ -38,7 +38,7 @@
		#include "class_gerbview_layer_widget.h"


		/**
		/*
		* Class GERBER_LAYER_WIDGET
		* is here to implement the abtract functions of LAYER_WIDGET so they
		* may be tied into the WinEDA_GerberFrame's data and so we can add a popup

Admin message