Doxygen warning fixes.
This commit is contained in:
parent
87e5b6b874
commit
63b884558a
|
@ -84,7 +84,6 @@ public:
|
||||||
* Function SetCvsFormOn
|
* Function SetCvsFormOn
|
||||||
* prepare parameters to create a BOM list in comma separated value (cvs)
|
* prepare parameters to create a BOM list in comma separated value (cvs)
|
||||||
* @param aSeparator = the character used as "csv" separator
|
* @param aSeparator = the character used as "csv" separator
|
||||||
* @param aFile = the file to write to (will be closed)
|
|
||||||
*/
|
*/
|
||||||
void SetCvsFormOn( char aSeparator )
|
void SetCvsFormOn( char aSeparator )
|
||||||
{
|
{
|
||||||
|
|
|
@ -24,7 +24,7 @@
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @file netlist_control.cpp
|
* @file eeschema/dialogs/dialog_netlist.cpp
|
||||||
* @brief Dialog box for creating netlists.
|
* @brief Dialog box for creating netlists.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
@ -530,8 +530,8 @@ void NETLIST_DIALOG::GenNetlist( wxCommandEvent& event )
|
||||||
* returns the filename extension and the wildcard string for this curr
|
* returns the filename extension and the wildcard string for this curr
|
||||||
* or a void name if there is no default name
|
* or a void name if there is no default name
|
||||||
* @param aNetTypeId = the netlist type ( NET_TYPE_PCBNEW ... )
|
* @param aNetTypeId = the netlist type ( NET_TYPE_PCBNEW ... )
|
||||||
* @param aExt = a reference to a wxString to return the defaut file ext.
|
* @param aExt = a reference to a wxString to return the default file ext.
|
||||||
* @param aWildCard = reference to a wxString to return the defaut wildcard.
|
* @param aWildCard = reference to a wxString to return the default wildcard.
|
||||||
* @return true for known netlist type, false for custom formats
|
* @return true for known netlist type, false for custom formats
|
||||||
*/
|
*/
|
||||||
bool NETLIST_DIALOG::ReturnFilenamePrms( NETLIST_TYPE_ID aNetTypeId,
|
bool NETLIST_DIALOG::ReturnFilenamePrms( NETLIST_TYPE_ID aNetTypeId,
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/**
|
/**
|
||||||
* @file dialog_netlist.h
|
* @file eeschema/dialogs/dialog_netlist.h
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|
@ -59,7 +59,7 @@ enum panel_netlist_index {
|
||||||
* others use PANELCUSTOMBASE+1, PANELCUSTOMBASE+2.. */
|
* others use PANELCUSTOMBASE+1, PANELCUSTOMBASE+2.. */
|
||||||
};
|
};
|
||||||
|
|
||||||
// Values returned when the netlist dialog is demiss
|
// Values returned when the netlist dialog is dismissed
|
||||||
#define NET_PLUGIN_CHANGE 1
|
#define NET_PLUGIN_CHANGE 1
|
||||||
// other values in use are wxID_OK and wxID_CANCEL
|
// other values in use are wxID_OK and wxID_CANCEL
|
||||||
|
|
||||||
|
@ -172,8 +172,8 @@ private:
|
||||||
* returns the filename extension and the wildcard string for this curr
|
* returns the filename extension and the wildcard string for this curr
|
||||||
* or a void name if there is no default name
|
* or a void name if there is no default name
|
||||||
* @param aNetTypeId = the netlist type ( NET_TYPE_PCBNEW ... )
|
* @param aNetTypeId = the netlist type ( NET_TYPE_PCBNEW ... )
|
||||||
* @param aExt = a reference to a wxString to return the defaut file ext.
|
* @param aExt = a reference to a wxString to return the default file ext.
|
||||||
* @param aWildCard = reference to a wxString to return the defaut wildcard.
|
* @param aWildCard = reference to a wxString to return the default wildcard.
|
||||||
* @return true for known netlist type, false for custom formats
|
* @return true for known netlist type, false for custom formats
|
||||||
*/
|
*/
|
||||||
bool ReturnFilenamePrms( NETLIST_TYPE_ID aNetTypeId,
|
bool ReturnFilenamePrms( NETLIST_TYPE_ID aNetTypeId,
|
||||||
|
|
|
@ -1,4 +1,4 @@
|
||||||
/** @file dialog_plot_schematic_PDF.cpp
|
/** @file dialog_plot_schematic.cpp
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/**
|
/**
|
||||||
* @file select_pcb_layer.cpp
|
* @file dialog_select_one_pcb_layer.cpp
|
||||||
* @brief Set up a dialog to choose a PCB Layer.
|
* @brief Set up a dialog to choose a PCB Layer.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
@ -222,5 +222,3 @@ const wxString GetPCBDefaultLayerName( int aLayerNumber )
|
||||||
|
|
||||||
return wxString( txt );
|
return wxString( txt );
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/**
|
/**
|
||||||
* @file gerbview/select_layers_to_pcb.cpp
|
* @file select_layers_to_pcb.cpp
|
||||||
* @brief Dialog to choose equivalence between gerber layers and pcb layers
|
* @brief Dialog to choose equivalence between gerber layers and pcb layers
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
@ -43,19 +43,22 @@ enum swap_layer_id {
|
||||||
ID_TEXT_0 = ID_BUTTON_0 + GERBVIEW_LAYER_COUNT
|
ID_TEXT_0 = ID_BUTTON_0 + GERBVIEW_LAYER_COUNT
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* This dialog shows the gerber files loaded, and allows user to choose:
|
* This dialog shows the gerber files loaded, and allows user to choose:
|
||||||
* what gerber file and what board layer are used
|
* what gerber file and what board layer are used
|
||||||
* the number of copper layers
|
* the number of copper layers
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
int LAYERS_MAP_DIALOG::m_exportBoardCopperLayersCount = 2;
|
||||||
|
|
||||||
|
|
||||||
BEGIN_EVENT_TABLE( LAYERS_MAP_DIALOG, LAYERS_MAP_DIALOG_BASE )
|
BEGIN_EVENT_TABLE( LAYERS_MAP_DIALOG, LAYERS_MAP_DIALOG_BASE )
|
||||||
EVT_COMMAND_RANGE( ID_BUTTON_0, ID_BUTTON_0 + GERBVIEW_LAYER_COUNT-1,
|
EVT_COMMAND_RANGE( ID_BUTTON_0, ID_BUTTON_0 + GERBVIEW_LAYER_COUNT-1,
|
||||||
wxEVT_COMMAND_BUTTON_CLICKED,
|
wxEVT_COMMAND_BUTTON_CLICKED,
|
||||||
LAYERS_MAP_DIALOG::OnSelectLayer )
|
LAYERS_MAP_DIALOG::OnSelectLayer )
|
||||||
END_EVENT_TABLE()
|
END_EVENT_TABLE()
|
||||||
|
|
||||||
int LAYERS_MAP_DIALOG::m_exportBoardCopperLayersCount = 2;
|
|
||||||
|
|
||||||
LAYERS_MAP_DIALOG::LAYERS_MAP_DIALOG( GERBVIEW_FRAME* parent ) :
|
LAYERS_MAP_DIALOG::LAYERS_MAP_DIALOG( GERBVIEW_FRAME* parent ) :
|
||||||
LAYERS_MAP_DIALOG_BASE( parent )
|
LAYERS_MAP_DIALOG_BASE( parent )
|
||||||
|
|
|
@ -357,7 +357,7 @@ public:
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Function FindRow
|
* Function FindRow
|
||||||
* returns a #ROW* if aNickName is found in this table or in any chained
|
* returns a #ROW if aNickName is found in this table or in any chained
|
||||||
* fallBack table fragment, else NULL.
|
* fallBack table fragment, else NULL.
|
||||||
*/
|
*/
|
||||||
const ROW* FindRow( const wxString& aNickName ) throw( IO_ERROR );
|
const ROW* FindRow( const wxString& aNickName ) throw( IO_ERROR );
|
||||||
|
@ -367,7 +367,7 @@ protected:
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Function findRow
|
* Function findRow
|
||||||
* returns a #ROW* if aNickName is found in this table or in any chained
|
* returns a #ROW if aNickName is found in this table or in any chained
|
||||||
* fallBack table fragment, else NULL.
|
* fallBack table fragment, else NULL.
|
||||||
*/
|
*/
|
||||||
const ROW* findRow( const wxString& aNickName );
|
const ROW* findRow( const wxString& aNickName );
|
||||||
|
|
|
@ -616,7 +616,7 @@ public:
|
||||||
* @param aFileName is the full filename to open and save to as a text file.
|
* @param aFileName is the full filename to open and save to as a text file.
|
||||||
* @param aMode is what you would pass to wxFopen()'s mode, defaults to wxT( "wt" )
|
* @param aMode is what you would pass to wxFopen()'s mode, defaults to wxT( "wt" )
|
||||||
* for text files that are to be created here and now.
|
* for text files that are to be created here and now.
|
||||||
* @param qQuoteChar is a char used for quoting problematic strings
|
* @param aQuoteChar is a char used for quoting problematic strings
|
||||||
(with whitespace or special characters in them).
|
(with whitespace or special characters in them).
|
||||||
* @throw IO_ERROR if the file cannot be opened.
|
* @throw IO_ERROR if the file cannot be opened.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -64,7 +64,6 @@ protected:
|
||||||
public:
|
public:
|
||||||
/**
|
/**
|
||||||
* @param aParent The window creating the dialog
|
* @param aParent The window creating the dialog
|
||||||
* @param aDialogParent
|
|
||||||
*/
|
*/
|
||||||
TEMPLATE_SELECTION_PANEL( wxWindow* aParent );
|
TEMPLATE_SELECTION_PANEL( wxWindow* aParent );
|
||||||
~TEMPLATE_SELECTION_PANEL();
|
~TEMPLATE_SELECTION_PANEL();
|
||||||
|
|
|
@ -374,8 +374,8 @@ public:
|
||||||
* static function ReturnStringLibNameInvalidChars
|
* static function ReturnStringLibNameInvalidChars
|
||||||
* Test for validity of the name in a library of the footprint
|
* Test for validity of the name in a library of the footprint
|
||||||
* ( no spaces, dir separators ... )
|
* ( no spaces, dir separators ... )
|
||||||
* @param bool aUserReadable = false to get the list of invalid chars
|
* @param aUserReadable = false to get the list of invalid chars
|
||||||
* true to get a readable form (i.e ' ' = 'space' '\t'= 'tab')
|
* true to get a readable form (i.e ' ' = 'space' '\\t'= 'tab')
|
||||||
* @return a constant std::string giving the list of invalid chars in lib name
|
* @return a constant std::string giving the list of invalid chars in lib name
|
||||||
*/
|
*/
|
||||||
static const wxChar* ReturnStringLibNameInvalidChars( bool aUserReadable );
|
static const wxChar* ReturnStringLibNameInvalidChars( bool aUserReadable );
|
||||||
|
|
|
@ -21,7 +21,7 @@
|
||||||
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
|
||||||
*/
|
*/
|
||||||
/**
|
/**
|
||||||
* @file dialog_freeroute.cpp
|
* @file dialog_freeroute_exchange.cpp
|
||||||
* Dialog to access to FreeRoute, the web bases free router, export/import files
|
* Dialog to access to FreeRoute, the web bases free router, export/import files
|
||||||
* to/from FreeRoute
|
* to/from FreeRoute
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/**
|
/**
|
||||||
* @file pcbnew/dialog_plot.cpp
|
* @file dialog_plot.cpp
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
/**
|
/**
|
||||||
* @file pcbnew/dialog_plot.h
|
* @file dialog_plot.h
|
||||||
*/
|
*/
|
||||||
|
|
||||||
/*
|
/*
|
||||||
|
|
|
@ -248,7 +248,7 @@ private:
|
||||||
* these other values share the same mark shape
|
* these other values share the same mark shape
|
||||||
* @param aPlotter = a PLOTTER instance (HPGL, POSTSCRIPT ... plotter).
|
* @param aPlotter = a PLOTTER instance (HPGL, POSTSCRIPT ... plotter).
|
||||||
*/
|
*/
|
||||||
bool PlotDrillMarks( PLOTTER* plotter );
|
bool PlotDrillMarks( PLOTTER* aPlotter );
|
||||||
};
|
};
|
||||||
|
|
||||||
|
|
||||||
|
|
|
@ -145,7 +145,7 @@ protected:
|
||||||
LINE_READER* m_reader; ///< no ownership here.
|
LINE_READER* m_reader; ///< no ownership here.
|
||||||
wxString m_filename; ///< for saves only, name is in m_reader for loads
|
wxString m_filename; ///< for saves only, name is in m_reader for loads
|
||||||
|
|
||||||
int m_loading_format_version; ///< which #BOARD_FORMAT_VERSION should be Load()ed?
|
int m_loading_format_version; ///< which #SEXPR_BOARD_FILE_VERSION should be Load()ed?
|
||||||
|
|
||||||
STRING_FORMATTER m_sf;
|
STRING_FORMATTER m_sf;
|
||||||
OUTPUTFORMATTER* m_out; ///< output any Format()s to this, no ownership
|
OUTPUTFORMATTER* m_out; ///< output any Format()s to this, no ownership
|
||||||
|
|
Loading…
Reference in New Issue