Fix a few doxygen warnings
This commit is contained in:
parent
2018d48946
commit
cf5bae7fbf
|
@ -132,7 +132,7 @@ public:
|
||||||
/**
|
/**
|
||||||
* Function SetActionMenu
|
* Function SetActionMenu
|
||||||
* Associate a menu id to an action plugin
|
* Associate a menu id to an action plugin
|
||||||
* @param aInded is the action index
|
* @param aIndex is the action index
|
||||||
* @param idMenu is the associated menuitem id
|
* @param idMenu is the associated menuitem id
|
||||||
*/
|
*/
|
||||||
static void SetActionMenu( int aIndex, int idMenu );
|
static void SetActionMenu( int aIndex, int idMenu );
|
||||||
|
|
|
@ -292,15 +292,14 @@ public:
|
||||||
int aCircleToSegmentsCount,
|
int aCircleToSegmentsCount,
|
||||||
double aCorrectionFactor ) const;
|
double aCorrectionFactor ) const;
|
||||||
/**
|
/**
|
||||||
* Function BuildFilledSolidAreasPolygons
|
* Build the filled solid areas polygons from zone outlines (stored in m_Poly)
|
||||||
* Build the filled solid areas data from real outlines (stored in m_Poly)
|
|
||||||
* The solid areas can be more than one on copper layers, and do not have holes
|
* The solid areas can be more than one on copper layers, and do not have holes
|
||||||
( holes are linked by overlapping segments to the main outline)
|
( holes are linked by overlapping segments to the main outline)
|
||||||
* in order to have drawable (and plottable) filled polygons
|
* in order to have drawable (and plottable) filled polygons.
|
||||||
* @return true if OK, false if the solid polygons cannot be built
|
* @return true if OK, false if the solid polygons cannot be built
|
||||||
* @param aPcb: the current board (can be NULL for non copper zones)
|
* @param aPcb: the current board (can be NULL for non copper zones)
|
||||||
* @param aCornerBuffer: A reference to a buffer to store polygon corners, or NULL
|
* @param aOutlineBuffer: A reference to a SHAPE_POLY_SET buffer to store polygons, or NULL.
|
||||||
* if NULL (default:
|
* if NULL (default):
|
||||||
* - m_FilledPolysList is used to store solid areas polygons.
|
* - m_FilledPolysList is used to store solid areas polygons.
|
||||||
* - on copper layers, tracks and other items shapes of other nets are
|
* - on copper layers, tracks and other items shapes of other nets are
|
||||||
* removed from solid areas
|
* removed from solid areas
|
||||||
|
|
|
@ -90,11 +90,10 @@ inline bool close_st( const wxPoint& aReference, const wxPoint& aFirst, const wx
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Function findPoint
|
* Searches for a DRAWSEGMENT matching a given end point or start point in a list, and
|
||||||
* searches for a DRAWSEGMENT with an end point or start point of aPoint, and
|
|
||||||
* if found, removes it from the TYPE_COLLECTOR and returns it, else returns NULL.
|
* if found, removes it from the TYPE_COLLECTOR and returns it, else returns NULL.
|
||||||
* @param aPoint The starting or ending point to search for.
|
* @param aPoint The starting or ending point to search for.
|
||||||
* @param items The list to remove from.
|
* @param aList The list to remove from.
|
||||||
* @param aLimit is the distance from \a aPoint that still constitutes a valid find.
|
* @param aLimit is the distance from \a aPoint that still constitutes a valid find.
|
||||||
* @return DRAWSEGMENT* - The first DRAWSEGMENT that has a start or end point matching
|
* @return DRAWSEGMENT* - The first DRAWSEGMENT that has a start or end point matching
|
||||||
* aPoint, otherwise NULL if none.
|
* aPoint, otherwise NULL if none.
|
||||||
|
|
|
@ -62,7 +62,7 @@ public:
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Enable/disable the report file creation
|
* Enable/disable the report file creation
|
||||||
* @param aEnbale = true to ask for creation
|
* @param aEnable = true to ask for creation
|
||||||
* @param aFileName = the filename or the report file
|
* @param aFileName = the filename or the report file
|
||||||
*/
|
*/
|
||||||
void SetRptSettings( bool aEnable, const wxString& aFileName );
|
void SetRptSettings( bool aEnable, const wxString& aFileName );
|
||||||
|
|
|
@ -150,7 +150,7 @@ public:
|
||||||
* Function GetAutoPath
|
* Function GetAutoPath
|
||||||
* Returns path that is either absolute or related to KISYSMOD/KIPRJMOD if the files
|
* Returns path that is either absolute or related to KISYSMOD/KIPRJMOD if the files
|
||||||
* are stored within one of the mentioned paths.
|
* are stored within one of the mentioned paths.
|
||||||
* @param aScoep is the scope for the library. It determines the environmental variables
|
* @param aScope is the scope for the library. It determines the environmental variables
|
||||||
* that are used to check the path (GLOBAL scope checks only KISYSMOD, while PROJECT
|
* that are used to check the path (GLOBAL scope checks only KISYSMOD, while PROJECT
|
||||||
* scope checks both KISYSMOD & KIPRJMOD).
|
* scope checks both KISYSMOD & KIPRJMOD).
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -82,6 +82,8 @@ public:
|
||||||
* @param aMirror = true to create mirrored coordinates (Y coordinates negated)
|
* @param aMirror = true to create mirrored coordinates (Y coordinates negated)
|
||||||
* @param aMinimalHeader = true to use a minimal header (no comments, no info)
|
* @param aMinimalHeader = true to use a minimal header (no comments, no info)
|
||||||
* @param aOffset = drill coordinates offset
|
* @param aOffset = drill coordinates offset
|
||||||
|
* @param aMerge_PTH_NPTH = true to create only one file containing PTH and NPTH
|
||||||
|
* false to create 2 separate files : one for PTH and one for NPTH
|
||||||
*/
|
*/
|
||||||
void SetOptions( bool aMirror, bool aMinimalHeader, wxPoint aOffset, bool aMerge_PTH_NPTH )
|
void SetOptions( bool aMirror, bool aMinimalHeader, wxPoint aOffset, bool aMerge_PTH_NPTH )
|
||||||
{
|
{
|
||||||
|
|
|
@ -189,9 +189,8 @@ public:
|
||||||
void SetPageInfo( const PAGE_INFO* aPageInfo ) { m_pageInfo = aPageInfo; }
|
void SetPageInfo( const PAGE_INFO* aPageInfo ) { m_pageInfo = aPageInfo; }
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Function SetMapFileFormat
|
|
||||||
* Initialize the format for the drill map file
|
* Initialize the format for the drill map file
|
||||||
* @param SetMapFileFormat = a PlotFormat value (one of
|
* @param aMapFmt = a PlotFormat value (one of
|
||||||
* PLOT_FORMAT_HPGL, PLOT_FORMAT_POST, PLOT_FORMAT_GERBER,
|
* PLOT_FORMAT_HPGL, PLOT_FORMAT_POST, PLOT_FORMAT_GERBER,
|
||||||
* PLOT_FORMAT_DXF, PLOT_FORMAT_SVG, PLOT_FORMAT_PDF
|
* PLOT_FORMAT_DXF, PLOT_FORMAT_SVG, PLOT_FORMAT_PDF
|
||||||
* the most useful are PLOT_FORMAT_PDF and PLOT_FORMAT_POST
|
* the most useful are PLOT_FORMAT_PDF and PLOT_FORMAT_POST
|
||||||
|
|
|
@ -269,7 +269,6 @@ const wxString GetGerberProtelExtension( LAYER_NUM aLayer );
|
||||||
const wxString GetGerberFileFunctionAttribute( const BOARD *aBoard, LAYER_NUM aLayer );
|
const wxString GetGerberFileFunctionAttribute( const BOARD *aBoard, LAYER_NUM aLayer );
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Function AddGerberX2Header
|
|
||||||
* Calculates some X2 attributes, as defined in the
|
* Calculates some X2 attributes, as defined in the
|
||||||
* Gerber file format specification J4 (chapter 5) and add them
|
* Gerber file format specification J4 (chapter 5) and add them
|
||||||
* the to the gerber file header:
|
* the to the gerber file header:
|
||||||
|
@ -277,7 +276,7 @@ const wxString GetGerberFileFunctionAttribute( const BOARD *aBoard, LAYER_NUM aL
|
||||||
* TF.CreationDate
|
* TF.CreationDate
|
||||||
* TF.ProjectId
|
* TF.ProjectId
|
||||||
* file format attribute is not added
|
* file format attribute is not added
|
||||||
* @param aPlotter, the current plotter.
|
* @param aPlotter = the current plotter.
|
||||||
* @param aBoard = the board, needed to extract some info
|
* @param aBoard = the board, needed to extract some info
|
||||||
* @param aUseX1CompatibilityMode = false to generate X2 attributes, true to
|
* @param aUseX1CompatibilityMode = false to generate X2 attributes, true to
|
||||||
* use X1 compatibility (X2 attributes added as structured comments,
|
* use X1 compatibility (X2 attributes added as structured comments,
|
||||||
|
@ -287,17 +286,15 @@ void AddGerberX2Header( PLOTTER * aPlotter,
|
||||||
const BOARD *aBoard, bool aUseX1CompatibilityMode = false );
|
const BOARD *aBoard, bool aUseX1CompatibilityMode = false );
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Function AddGerberX2Attribute
|
* Calculates some X2 attributes, as defined in the Gerber file format
|
||||||
* Calculates some X2 attributes, as defined in the
|
* specification and add them to the gerber file header:
|
||||||
* Gerber file format specification J4 (chapter 5) and add them
|
|
||||||
* the to the gerber file header
|
|
||||||
* TF.GenerationSoftware
|
* TF.GenerationSoftware
|
||||||
* TF.CreationDate
|
* TF.CreationDate
|
||||||
* TF.ProjectId
|
* TF.ProjectId
|
||||||
* TF.FileFunction
|
* TF.FileFunction
|
||||||
* TF.FilePolarity
|
* TF.FilePolarity
|
||||||
*
|
*
|
||||||
* @param aPlotter, the current plotter.
|
* @param aPlotter = the current plotter.
|
||||||
* @param aBoard = the board, needed to extract some info
|
* @param aBoard = the board, needed to extract some info
|
||||||
* @param aLayer = the layer number to create the attribute for
|
* @param aLayer = the layer number to create the attribute for
|
||||||
* @param aUseX1CompatibilityMode = false to generate X2 attributes, true to
|
* @param aUseX1CompatibilityMode = false to generate X2 attributes, true to
|
||||||
|
|
Loading…
Reference in New Issue