diff --git a/pcbnew/class_action_plugin.h b/pcbnew/class_action_plugin.h index 717ae70d10..8853107528 100644 --- a/pcbnew/class_action_plugin.h +++ b/pcbnew/class_action_plugin.h @@ -132,7 +132,7 @@ public: /** * Function SetActionMenu * 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 */ static void SetActionMenu( int aIndex, int idMenu ); diff --git a/pcbnew/class_zone.h b/pcbnew/class_zone.h index 8993fd8f59..82ab6e9762 100644 --- a/pcbnew/class_zone.h +++ b/pcbnew/class_zone.h @@ -292,15 +292,14 @@ public: int aCircleToSegmentsCount, double aCorrectionFactor ) const; /** - * Function BuildFilledSolidAreasPolygons - * Build the filled solid areas data from real outlines (stored in m_Poly) + * Build the filled solid areas polygons from zone outlines (stored in m_Poly) * 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) - * 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 * @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 - * if NULL (default: + * @param aOutlineBuffer: A reference to a SHAPE_POLY_SET buffer to store polygons, or NULL. + * if NULL (default): * - m_FilledPolysList is used to store solid areas polygons. * - on copper layers, tracks and other items shapes of other nets are * removed from solid areas diff --git a/pcbnew/convert_drawsegment_list_to_polygon.cpp b/pcbnew/convert_drawsegment_list_to_polygon.cpp index a428fbc7e3..9b84a695fe 100644 --- a/pcbnew/convert_drawsegment_list_to_polygon.cpp +++ b/pcbnew/convert_drawsegment_list_to_polygon.cpp @@ -90,11 +90,10 @@ inline bool close_st( const wxPoint& aReference, const wxPoint& aFirst, const wx /** - * Function findPoint - * searches for a DRAWSEGMENT with an end point or start point of aPoint, and + * Searches for a DRAWSEGMENT matching a given end point or start point in a list, and * 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 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. * @return DRAWSEGMENT* - The first DRAWSEGMENT that has a start or end point matching * aPoint, otherwise NULL if none. diff --git a/pcbnew/dialogs/dialog_drc.h b/pcbnew/dialogs/dialog_drc.h index cd7682993e..09e3bde1d8 100644 --- a/pcbnew/dialogs/dialog_drc.h +++ b/pcbnew/dialogs/dialog_drc.h @@ -62,7 +62,7 @@ public: /** * 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 */ void SetRptSettings( bool aEnable, const wxString& aFileName ); diff --git a/pcbnew/dialogs/wizard_add_fplib.h b/pcbnew/dialogs/wizard_add_fplib.h index bc51b09a3c..520ea43e26 100644 --- a/pcbnew/dialogs/wizard_add_fplib.h +++ b/pcbnew/dialogs/wizard_add_fplib.h @@ -150,7 +150,7 @@ public: * Function GetAutoPath * Returns path that is either absolute or related to KISYSMOD/KIPRJMOD if the files * 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 * scope checks both KISYSMOD & KIPRJMOD). */ diff --git a/pcbnew/exporters/gendrill_Excellon_writer.h b/pcbnew/exporters/gendrill_Excellon_writer.h index e5deef2f37..90a3257412 100644 --- a/pcbnew/exporters/gendrill_Excellon_writer.h +++ b/pcbnew/exporters/gendrill_Excellon_writer.h @@ -82,6 +82,8 @@ public: * @param aMirror = true to create mirrored coordinates (Y coordinates negated) * @param aMinimalHeader = true to use a minimal header (no comments, no info) * @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 ) { diff --git a/pcbnew/exporters/gendrill_file_writer_base.h b/pcbnew/exporters/gendrill_file_writer_base.h index 209e8274d9..745ba7d65f 100644 --- a/pcbnew/exporters/gendrill_file_writer_base.h +++ b/pcbnew/exporters/gendrill_file_writer_base.h @@ -189,9 +189,8 @@ public: void SetPageInfo( const PAGE_INFO* aPageInfo ) { m_pageInfo = aPageInfo; } /** - * Function SetMapFileFormat * 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_DXF, PLOT_FORMAT_SVG, PLOT_FORMAT_PDF * the most useful are PLOT_FORMAT_PDF and PLOT_FORMAT_POST diff --git a/pcbnew/pcbplot.h b/pcbnew/pcbplot.h index 64413c7ee0..22a4baf933 100644 --- a/pcbnew/pcbplot.h +++ b/pcbnew/pcbplot.h @@ -269,7 +269,6 @@ const wxString GetGerberProtelExtension( LAYER_NUM aLayer ); const wxString GetGerberFileFunctionAttribute( const BOARD *aBoard, LAYER_NUM aLayer ); /** - * Function AddGerberX2Header * Calculates some X2 attributes, as defined in the * Gerber file format specification J4 (chapter 5) and add them * the to the gerber file header: @@ -277,7 +276,7 @@ const wxString GetGerberFileFunctionAttribute( const BOARD *aBoard, LAYER_NUM aL * TF.CreationDate * TF.ProjectId * 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 aUseX1CompatibilityMode = false to generate X2 attributes, true to * use X1 compatibility (X2 attributes added as structured comments, @@ -287,17 +286,15 @@ void AddGerberX2Header( PLOTTER * aPlotter, const BOARD *aBoard, bool aUseX1CompatibilityMode = false ); /** - * Function AddGerberX2Attribute - * Calculates some X2 attributes, as defined in the - * Gerber file format specification J4 (chapter 5) and add them - * the to the gerber file header + * Calculates some X2 attributes, as defined in the Gerber file format + * specification and add them to the gerber file header: * TF.GenerationSoftware * TF.CreationDate * TF.ProjectId * TF.FileFunction * TF.FilePolarity * - * @param aPlotter, the current plotter. + * @param aPlotter = the current plotter. * @param aBoard = the board, needed to extract some info * @param aLayer = the layer number to create the attribute for * @param aUseX1CompatibilityMode = false to generate X2 attributes, true to