From 2476e88c9d42c3001766c50cf86f7ce0e3e124db Mon Sep 17 00:00:00 2001 From: jean-pierre charras Date: Thu, 15 Jun 2017 11:28:36 +0200 Subject: [PATCH] Fix a few doxygen warnings --- common/convert_basic_shapes_to_polygon.cpp | 2 +- common/drawtxt.cpp | 4 +++- common/geometry/shape_poly_set.cpp | 2 +- cvpcb/cvpcb_mainframe.cpp | 2 +- cvpcb/cvpcb_mainframe.h | 16 ++++++++++++---- cvpcb/readwrite_dlgs.cpp | 2 +- gerbview/class_gbr_layout.h | 9 ++++++--- gerbview/rs274d.cpp | 6 +----- include/layers_id_colors_and_visibility.h | 2 +- include/plot_auxiliary_data.h | 2 ++ include/plot_common.h | 15 +++++---------- 11 files changed, 34 insertions(+), 28 deletions(-) diff --git a/common/convert_basic_shapes_to_polygon.cpp b/common/convert_basic_shapes_to_polygon.cpp index 6ac6beaffb..f2efe03c08 100644 --- a/common/convert_basic_shapes_to_polygon.cpp +++ b/common/convert_basic_shapes_to_polygon.cpp @@ -112,7 +112,7 @@ void GetRoundRectCornerCenters( wxPoint aCenters[4], int aRadius, * @param aCornerBuffer = a buffer to store the polygon * @param aPosition = the coordinate of the center of the rectangle * @param aSize = the size of the rectangle - * @param aRadius = radius of rounded corners + * @param aCornerRadius = radius of rounded corners * @param aRotation = rotation in 0.1 degrees of the rectangle * @param aCircleToSegmentsCount = the number of segments to approximate a circle */ diff --git a/common/drawtxt.cpp b/common/drawtxt.cpp index ff5e012eea..a09dbb7ef9 100644 --- a/common/drawtxt.cpp +++ b/common/drawtxt.cpp @@ -209,7 +209,7 @@ void DrawGraphicHaloText( EDA_RECT* aClipBox, wxDC * aDC, /** * Function PLOTTER::Text - * same as DrawGraphicText, but plot graphic text insteed of draw it + * same as DrawGraphicText, but plot graphic text insteed of draw it * @param aPos = text position (according to aH_justify, aV_justify) * @param aColor (COLOR4D) = text color * @param aText = text to draw @@ -223,6 +223,8 @@ void DrawGraphicHaloText( EDA_RECT* aClipBox, wxDC * aDC, * @param aItalic = true to simulate an italic font * @param aBold = true to use a bold font Useful only with default width value (aWidth = 0) * @param aMultilineAllowed = true to plot text as multiline, otherwise single line + * @param aData = a parameter used by some plotters in SetCurrentLineWidth(), + * not directly used here. */ void PLOTTER::Text( const wxPoint& aPos, const COLOR4D aColor, diff --git a/common/geometry/shape_poly_set.cpp b/common/geometry/shape_poly_set.cpp index cc3f4aacb2..63ed4ee4b2 100644 --- a/common/geometry/shape_poly_set.cpp +++ b/common/geometry/shape_poly_set.cpp @@ -475,7 +475,7 @@ const SHAPE_LINE_CHAIN SHAPE_POLY_SET::convertFromClipper( const Path& aPath ) } -void SHAPE_POLY_SET::booleanOp( ClipType aType, const SHAPE_POLY_SET& aOtherShape, +void SHAPE_POLY_SET::booleanOp( ClipperLib::ClipType aType, const SHAPE_POLY_SET& aOtherShape, POLYGON_MODE aFastMode ) { Clipper c; diff --git a/cvpcb/cvpcb_mainframe.cpp b/cvpcb/cvpcb_mainframe.cpp index a44a00ba31..0d41232164 100644 --- a/cvpcb/cvpcb_mainframe.cpp +++ b/cvpcb/cvpcb_mainframe.cpp @@ -979,7 +979,7 @@ void CVPCB_MAINFRAME::KiwayMailIn( KIWAY_EXPRESS& mail ) switch( mail.Command() ) { case MAIL_EESCHEMA_NETLIST: - ReadNetListAndLinkFiles( payload ); + ReadNetListAndFpFiles( payload ); /* @todo Go into SCH_EDIT_FRAME::OnOpenCvpcb( wxCommandEvent& event ) and trim GNL_ALL down. */ diff --git a/cvpcb/cvpcb_mainframe.h b/cvpcb/cvpcb_mainframe.h index 677563356c..87d4ba1e7c 100644 --- a/cvpcb/cvpcb_mainframe.h +++ b/cvpcb/cvpcb_mainframe.h @@ -201,13 +201,21 @@ public: void SaveFootprintAssociation(); /** - * Function ReadNetList - * reads the netlist (.net) file defined by #m_NetlistFileName. - * and the corresponding cmp to footprint (.cmp) link file + * Function ReadNetListAndFpFiles + * loads the netlist file built on the fly by Eeschema and loads + * footprint libraries from fp lib tables. * @param aNetlist is the netlist from eeschema in kicad s-expr format. + * (see CVPCB_MAINFRAME::KiwayMailIn() to know how to get this netlist) */ - bool ReadNetListAndLinkFiles( const std::string& aNetlist ); + bool ReadNetListAndFpFiles( const std::string& aNetlist ); + /** + * Function ReadSchematicNetlist + * read the netlist (.net) file built on the fly by Eeschema. + * @param aNetlist is the netlist buffer filled by eeschema, in kicad s-expr format. + * It is the same netlist as the .net file created by Eeschema. + * (This method is called by ReadNetListAndFpFiles) + */ int ReadSchematicNetlist( const std::string& aNetlist ); /** diff --git a/cvpcb/readwrite_dlgs.cpp b/cvpcb/readwrite_dlgs.cpp index 3a369857c6..2c40b49c42 100644 --- a/cvpcb/readwrite_dlgs.cpp +++ b/cvpcb/readwrite_dlgs.cpp @@ -176,7 +176,7 @@ static int guessNickname( FP_LIB_TABLE* aTbl, LIB_ID* aFootprintId ) } -bool CVPCB_MAINFRAME::ReadNetListAndLinkFiles( const std::string& aNetlist ) +bool CVPCB_MAINFRAME::ReadNetListAndFpFiles( const std::string& aNetlist ) { wxString msg; bool hasMissingNicks = false; diff --git a/gerbview/class_gbr_layout.h b/gerbview/class_gbr_layout.h index 13c66345ad..8f0ae598f0 100644 --- a/gerbview/class_gbr_layout.h +++ b/gerbview/class_gbr_layout.h @@ -131,8 +131,8 @@ public: /** * Function SetPrintableLayers - * changes the list of printable layers - * @param aLayerMask = The new bit-mask of printable layers + * Set the list of printable graphic layers + * @param aLayerList = the new list (std::vector) of printable layer id */ void SetPrintableLayers( const std::vector& aLayerList ) { @@ -141,7 +141,7 @@ public: /** * Function GetPrintableLayers - * @return the bit-mask of printable layers + * @return the list of printable layers */ std::vector GetPrintableLayers() { @@ -150,6 +150,7 @@ public: /** * Function ClearPrintableLayers + * Clear the list of graphic layers to print */ void ClearPrintableLayers() { @@ -158,6 +159,8 @@ public: /** * Function AddLayerToPrintableList + * Add a layer to the list of graphic layers to print + * @param aLayer = the id of the graphic layer. */ void AddLayerToPrintableList( int aLayer) { diff --git a/gerbview/rs274d.cpp b/gerbview/rs274d.cpp index 1fb2148260..45831d7ee6 100644 --- a/gerbview/rs274d.cpp +++ b/gerbview/rs274d.cpp @@ -100,7 +100,6 @@ * @param aGbrItem The GBRITEM to fill in. * @param aAperture the associated type of aperture * @param Dcode_index The DCODE value, like D14 - * @param aLayer The layer index to set into the GBRITEM * @param aPos The center point of the flash * @param aSize The diameter of the round flash * @param aLayerNegative = true if the current layer is negative @@ -152,7 +151,6 @@ void fillFlashedGBRITEM( GERBER_DRAW_ITEM* aGbrItem, * * @param aGbrItem The GERBER_DRAW_ITEM to fill in. * @param Dcode_index The DCODE value, like D14 - * @param aLayer The layer index to set into the GBRITEM * @param aStart The starting point of the line * @param aEnd The ending point of the line * @param aPenSize The size of the flash. Note rectangular shapes are legal. @@ -196,13 +194,11 @@ void fillLineGBRITEM( GERBER_DRAW_ITEM* aGbrItem, *

* @param aGbrItem is the GBRITEM to fill in. * @param Dcode_index is the DCODE value, like D14 - * @param aLayer is the layer index to set into the GBRITEM * @param aStart is the starting point * @param aEnd is the ending point * @param aRelCenter is the center coordinate relative to start point, * given in ABSOLUTE VALUE and the sign of values x et y de rel_center - * must be calculated from the previously given constraint: arc only in the - * same quadrant. + * must be calculated from the previously given constraint: arc only in the same quadrant. * @param aClockwise true if arc must be created clockwise * @param aPenSize The size of the flash. Note rectangular shapes are legal. * @param aMultiquadrant = true to create arcs upto 360 deg, diff --git a/include/layers_id_colors_and_visibility.h b/include/layers_id_colors_and_visibility.h index 8c0a2af1bf..5782bcb16d 100644 --- a/include/layers_id_colors_and_visibility.h +++ b/include/layers_id_colors_and_visibility.h @@ -720,7 +720,7 @@ inline bool IsBackLayer( PCB_LAYER_ID aLayerId ) * some (not all) layers: external copper, and paired layers( Mask, Paste, solder ... ) * are swapped between front and back sides * internal layers are flipped only if the copper layers count is known - * @param aLayer = the PCB_LAYER_ID to flip + * @param aLayerId = the PCB_LAYER_ID to flip * @param aCopperLayersCount = the number of copper layers. if 0 (in fact if < 4 ) * internal layers will be not flipped because the layer count is not known */ diff --git a/include/plot_auxiliary_data.h b/include/plot_auxiliary_data.h index 8c9b21f0b5..b909d7e27f 100644 --- a/include/plot_auxiliary_data.h +++ b/include/plot_auxiliary_data.h @@ -166,6 +166,8 @@ std::string formatStringToGerber( const wxString& aString ); * for a graphic object. * @param aPrintedText is the string to print * @param aLastNetAttributes is the current full set of attributes. + * @param aData is the GBR_NETLIST_METADATA associated to the graphic object (can be NULL + * if no associated metadata, and aClearPreviousAttributes will be set to false) * @param aClearPreviousAttributes returns true if the full set of attributes * must be deleted from file before adding new attribute (happens when a previous * attribute does not exist no more). diff --git a/include/plot_common.h b/include/plot_common.h index 4fc54a5378..0ac6f3c1f0 100644 --- a/include/plot_common.h +++ b/include/plot_common.h @@ -289,9 +289,7 @@ public: /** * virtual function FlashPadCircle * @param aPadPos Position of the shape (center of the rectangle - * @param aSize = size of rounded rect - * @param cornerRadius Radius of the rounded corners - * @param aOrient The rotation of the shape + * @param aDiameter diameter of round pad * @param aTraceMode FILLED or SKETCH * @param aData an auxiliary info (mainly for gerber format) */ @@ -301,9 +299,8 @@ public: /** * virtual function FlashPadOval * @param aPadPos Position of the shape (center of the rectangle - * @param aSize = size of rounded rect - * @param cornerRadius Radius of the rounded corners - * @param aOrient The rotation of the shape + * @param aSize = size of oblong shape + * @param aPadOrient The rotation of the shape * @param aTraceMode FILLED or SKETCH * @param aData an auxiliary info (mainly for gerber format) */ @@ -314,8 +311,7 @@ public: * virtual function FlashPadRect * @param aPadPos Position of the shape (center of the rectangle * @param aSize = size of rounded rect - * @param cornerRadius Radius of the rounded corners - * @param aOrient The rotation of the shape + * @param aPadOrient The rotation of the shape * @param aTraceMode FILLED or SKETCH * @param aData an auxuliary info (mainly for gerber format) */ @@ -382,8 +378,7 @@ public: static const unsigned MARKER_COUNT = 58; /** - * Draw a pattern shape number aShapeId, to coord x0, y0. - * x0, y0 = coordinates tables + * Draw a pattern shape number aShapeId, to coord position. * Diameter diameter = (coord table) hole * AShapeId = index (used to generate forms characters) */