Comment-only changes
Makes class comments conform to coding standards
This commit is contained in:
parent
2a780dba0e
commit
7c28c3838a
|
@ -32,7 +32,7 @@
|
||||||
#include "3d_cache/sg/sg_index.h"
|
#include "3d_cache/sg/sg_index.h"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SGCOORDINDEX
|
* SGCOORDINDEX
|
||||||
* is a class which maintains a coordinate index list. Users
|
* is a class which maintains a coordinate index list. Users
|
||||||
* must ensure that coordinate indices are specified as
|
* must ensure that coordinate indices are specified as
|
||||||
* triplets (triangular faces) since no checking is performed.
|
* triplets (triangular faces) since no checking is performed.
|
||||||
|
|
|
@ -70,7 +70,7 @@ namespace S3D
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SGNODE
|
* SGNODE
|
||||||
* represents the base class of all Scene Graph nodes
|
* represents the base class of all Scene Graph nodes
|
||||||
*/
|
*/
|
||||||
class SGNODE
|
class SGNODE
|
||||||
|
|
|
@ -32,7 +32,7 @@
|
||||||
#include <reporter.h>
|
#include <reporter.h>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class STATUS_TEXT_REPORTER
|
* STATUS_TEXT_REPORTER
|
||||||
* is a wrapper for reporting to a wxString in a wxFrame status text.
|
* is a wrapper for reporting to a wxString in a wxFrame status text.
|
||||||
*/
|
*/
|
||||||
class STATUS_TEXT_REPORTER : public REPORTER
|
class STATUS_TEXT_REPORTER : public REPORTER
|
||||||
|
|
|
@ -34,7 +34,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class CBBOX
|
* CBBOX
|
||||||
* manages a bounding box defined by two SFVEC2F min max points.
|
* manages a bounding box defined by two SFVEC2F min max points.
|
||||||
*/
|
*/
|
||||||
struct CBBOX2D
|
struct CBBOX2D
|
||||||
|
|
|
@ -34,7 +34,7 @@
|
||||||
#include <fctsys.h> // For the DBG(
|
#include <fctsys.h> // For the DBG(
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class CBBOX
|
* CBBOX
|
||||||
* manages a bounding box defined by two SFVEC3F min max points.
|
* manages a bounding box defined by two SFVEC3F min max points.
|
||||||
*/
|
*/
|
||||||
struct CBBOX
|
struct CBBOX
|
||||||
|
|
|
@ -83,7 +83,7 @@ typedef struct {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class CIMAGE
|
* CIMAGE
|
||||||
* manages a 8-bit channel image
|
* manages a 8-bit channel image
|
||||||
*/
|
*/
|
||||||
class CIMAGE
|
class CIMAGE
|
||||||
|
|
|
@ -34,7 +34,7 @@ class TOOL_EVENT;
|
||||||
class TOOL_MANAGER;
|
class TOOL_MANAGER;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class EDA_3D_ACTIONS
|
* EDA_3D_ACTIONS
|
||||||
*
|
*
|
||||||
* Note: these aren't "real" actions; we just use them to see the hotkeys display.
|
* Note: these aren't "real" actions; we just use them to see the hotkeys display.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -62,7 +62,7 @@ extern std::string GetCurlLibVersion();
|
||||||
|
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Class DIALOG_ABOUT methods
|
* DIALOG_ABOUT methods
|
||||||
*/
|
*/
|
||||||
|
|
||||||
DIALOG_ABOUT::DIALOG_ABOUT( EDA_BASE_FRAME *aParent, ABOUT_APP_INFO& aAppInfo )
|
DIALOG_ABOUT::DIALOG_ABOUT( EDA_BASE_FRAME *aParent, ABOUT_APP_INFO& aAppInfo )
|
||||||
|
|
|
@ -30,7 +30,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class WX_HTML_REPORT_PANEL
|
* WX_HTML_REPORT_PANEL
|
||||||
*
|
*
|
||||||
* A widget for browsing a rich text error/status report. Used in numerous
|
* A widget for browsing a rich text error/status report. Used in numerous
|
||||||
* dialogs in eeschema and pcbnew. Provides error filtering functionality
|
* dialogs in eeschema and pcbnew. Provides error filtering functionality
|
||||||
|
|
|
@ -43,7 +43,7 @@
|
||||||
using namespace TB_READER_T;
|
using namespace TB_READER_T;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class PAGE_LAYOUT_READER_PARSER
|
* PAGE_LAYOUT_READER_PARSER
|
||||||
* holds data and functions pertinent to parsing a S-expression file
|
* holds data and functions pertinent to parsing a S-expression file
|
||||||
* for a WS_DATA_MODEL.
|
* for a WS_DATA_MODEL.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -49,7 +49,7 @@ enum ID_WHKL_MENU_IDS
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class WIDGET_HOTKEY_CLIENT_DATA
|
* WIDGET_HOTKEY_CLIENT_DATA
|
||||||
* Stores the hotkey change data associated with each row. To change a
|
* Stores the hotkey change data associated with each row. To change a
|
||||||
* hotkey, edit it via GetCurrentValue() in the row's client data, then call
|
* hotkey, edit it via GetCurrentValue() in the row's client data, then call
|
||||||
* WIDGET_HOTKEY_LIST::UpdateFromClientData().
|
* WIDGET_HOTKEY_LIST::UpdateFromClientData().
|
||||||
|
@ -68,7 +68,7 @@ public:
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class HK_PROMPT_DIALOG
|
* HK_PROMPT_DIALOG
|
||||||
* Dialog to prompt the user to enter a key.
|
* Dialog to prompt the user to enter a key.
|
||||||
*/
|
*/
|
||||||
class HK_PROMPT_DIALOG : public DIALOG_SHIM
|
class HK_PROMPT_DIALOG : public DIALOG_SHIM
|
||||||
|
@ -216,7 +216,7 @@ public:
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class HOTKEY_FILTER
|
* HOTKEY_FILTER
|
||||||
*
|
*
|
||||||
* Class to manage logic for filtering hotkeys based on user input
|
* Class to manage logic for filtering hotkeys based on user input
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -35,7 +35,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class DISPLAY_FOOTPRINTS_FRAME
|
* DISPLAY_FOOTPRINTS_FRAME
|
||||||
* is used to display footprints.
|
* is used to display footprints.
|
||||||
*/
|
*/
|
||||||
class DISPLAY_FOOTPRINTS_FRAME : public PCB_BASE_FRAME
|
class DISPLAY_FOOTPRINTS_FRAME : public PCB_BASE_FRAME
|
||||||
|
|
|
@ -32,7 +32,7 @@
|
||||||
class TOOL_ACTION;
|
class TOOL_ACTION;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class CVPCB_ACTIONS
|
* CVPCB_ACTIONS
|
||||||
*
|
*
|
||||||
* Gathers all the actions that are shared by tools. The instance of CVPCB_ACTIONS is created
|
* Gathers all the actions that are shared by tools. The instance of CVPCB_ACTIONS is created
|
||||||
* inside of ACTION_MANAGER object that registers the actions.
|
* inside of ACTION_MANAGER object that registers the actions.
|
||||||
|
|
|
@ -27,7 +27,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class CVPCB_CONTROL
|
* CVPCB_CONTROL
|
||||||
*
|
*
|
||||||
* Handles actions in main cvpcb window.
|
* Handles actions in main cvpcb window.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -27,7 +27,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class CVPCB_CONTROL
|
* CVPCB_CONTROL
|
||||||
*
|
*
|
||||||
* Handles actions in main cvpcb window.
|
* Handles actions in main cvpcb window.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -31,7 +31,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class CVPCB_FOOTPRINT_VIEWER_CONTROL
|
* CVPCB_FOOTPRINT_VIEWER_CONTROL
|
||||||
*
|
*
|
||||||
* Handles control actions for the cvpcb footprint display frame.
|
* Handles control actions for the cvpcb footprint display frame.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -29,7 +29,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL
|
* CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL
|
||||||
*
|
*
|
||||||
* Selection tool for the footprint viewer in cvpcb.
|
* Selection tool for the footprint viewer in cvpcb.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -32,7 +32,7 @@
|
||||||
#include <wx/html/htmlwin.h>
|
#include <wx/html/htmlwin.h>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class ERC_HTML_LISTFRAME
|
* ERC_HTML_LISTFRAME
|
||||||
* is used to display a DRC_ITEM_LIST.
|
* is used to display a DRC_ITEM_LIST.
|
||||||
*/
|
*/
|
||||||
class ERC_HTML_LISTFRAME : public wxHtmlWindow
|
class ERC_HTML_LISTFRAME : public wxHtmlWindow
|
||||||
|
|
|
@ -50,7 +50,7 @@
|
||||||
class wxConfigBase;
|
class wxConfigBase;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class DIALOG_ANNOTATE: a dialog to set/clear reference designators,
|
* DIALOG_ANNOTATE: a dialog to set/clear reference designators,
|
||||||
* of a schematic hierarchy, with different options
|
* of a schematic hierarchy, with different options
|
||||||
*/
|
*/
|
||||||
class DIALOG_ANNOTATE: public DIALOG_ANNOTATE_BASE
|
class DIALOG_ANNOTATE: public DIALOG_ANNOTATE_BASE
|
||||||
|
|
|
@ -39,7 +39,7 @@ class EDA_TEXT;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class DIALOG_EDIT_ONE_FIELD
|
* DIALOG_EDIT_ONE_FIELD
|
||||||
* is a base class to edit schematic and component library fields.
|
* is a base class to edit schematic and component library fields.
|
||||||
* <p>
|
* <p>
|
||||||
* This class is setup in expectation of its children
|
* This class is setup in expectation of its children
|
||||||
|
@ -105,7 +105,7 @@ protected:
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class DIALOG_LIB_EDIT_ONE_FIELD
|
* DIALOG_LIB_EDIT_ONE_FIELD
|
||||||
* is a the class to handle editing a single component field in the library editor.
|
* is a the class to handle editing a single component field in the library editor.
|
||||||
* <p>
|
* <p>
|
||||||
* @note Use ShowQuasiModal when calling this class!
|
* @note Use ShowQuasiModal when calling this class!
|
||||||
|
@ -133,7 +133,7 @@ public:
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class DIALOG_SCH_EDIT_ONE_FIELD
|
* DIALOG_SCH_EDIT_ONE_FIELD
|
||||||
* is a the class to handle editing a single component field in the schematic editor.
|
* is a the class to handle editing a single component field in the schematic editor.
|
||||||
* <p>
|
* <p>
|
||||||
* @note Use ShowQuasiModal when calling this class!
|
* @note Use ShowQuasiModal when calling this class!
|
||||||
|
|
|
@ -34,7 +34,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class EE_COLLECTOR
|
* EE_COLLECTOR
|
||||||
*/
|
*/
|
||||||
class EE_COLLECTOR : public COLLECTOR
|
class EE_COLLECTOR : public COLLECTOR
|
||||||
{
|
{
|
||||||
|
|
|
@ -29,7 +29,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class LIB_BEZIER
|
* LIB_BEZIER
|
||||||
* defines bezier curve graphic body item.
|
* defines bezier curve graphic body item.
|
||||||
*/
|
*/
|
||||||
class LIB_BEZIER : public LIB_ITEM
|
class LIB_BEZIER : public LIB_ITEM
|
||||||
|
|
|
@ -36,7 +36,7 @@
|
||||||
#include <sch_sheet.h>
|
#include <sch_sheet.h>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class UNIQUE_STRINGS
|
* UNIQUE_STRINGS
|
||||||
* tracks unique wxStrings and is useful in telling if a string
|
* tracks unique wxStrings and is useful in telling if a string
|
||||||
* has been seen before.
|
* has been seen before.
|
||||||
*/
|
*/
|
||||||
|
@ -81,7 +81,7 @@ struct LIB_PART_LESS_THAN
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class NETLIST_EXPORTER
|
* NETLIST_EXPORTER
|
||||||
* is a abstract class used for the netlist exporters that eeschema supports.
|
* is a abstract class used for the netlist exporters that eeschema supports.
|
||||||
*/
|
*/
|
||||||
class NETLIST_EXPORTER
|
class NETLIST_EXPORTER
|
||||||
|
|
|
@ -30,7 +30,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class NETLIST_EXPORTER_CADSTAR
|
* NETLIST_EXPORTER_CADSTAR
|
||||||
* generates a netlist compatible with CADSTAR
|
* generates a netlist compatible with CADSTAR
|
||||||
*/
|
*/
|
||||||
class NETLIST_EXPORTER_CADSTAR : public NETLIST_EXPORTER
|
class NETLIST_EXPORTER_CADSTAR : public NETLIST_EXPORTER
|
||||||
|
|
|
@ -53,7 +53,7 @@ enum GNL_T
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class NETLIST_EXPORTER_GENERIC
|
* NETLIST_EXPORTER_GENERIC
|
||||||
* generates a generic XML based netlist file. This allows using XSLT or other methods to
|
* generates a generic XML based netlist file. This allows using XSLT or other methods to
|
||||||
* transform the XML to other netlist formats outside of the C++ codebase.
|
* transform the XML to other netlist formats outside of the C++ codebase.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -31,7 +31,7 @@
|
||||||
class OUTPUTFORMATTER;
|
class OUTPUTFORMATTER;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class NETLIST_EXPORTER_KICAD
|
* NETLIST_EXPORTER_KICAD
|
||||||
* generates the kicad netlist format supported by pcbnew. It is basically
|
* generates the kicad netlist format supported by pcbnew. It is basically
|
||||||
* the generic netlist format just formatted slightly different.
|
* the generic netlist format just formatted slightly different.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -29,7 +29,7 @@
|
||||||
#include "netlist_exporter.h"
|
#include "netlist_exporter.h"
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class NETLIST_EXPORTER_ORCADPCB2
|
* NETLIST_EXPORTER_ORCADPCB2
|
||||||
* generates a netlist compatible with OrCAD
|
* generates a netlist compatible with OrCAD
|
||||||
*/
|
*/
|
||||||
class NETLIST_EXPORTER_ORCADPCB2 : public NETLIST_EXPORTER
|
class NETLIST_EXPORTER_ORCADPCB2 : public NETLIST_EXPORTER
|
||||||
|
|
|
@ -95,7 +95,7 @@ struct SPICE_ITEM
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class NETLIST_EXPORTER_PSPICE
|
* NETLIST_EXPORTER_PSPICE
|
||||||
* generates a PSPICE compatible netlist
|
* generates a PSPICE compatible netlist
|
||||||
*/
|
*/
|
||||||
class NETLIST_EXPORTER_PSPICE : public NETLIST_EXPORTER
|
class NETLIST_EXPORTER_PSPICE : public NETLIST_EXPORTER
|
||||||
|
|
|
@ -296,7 +296,7 @@ typedef std::vector<NETLIST_OBJECT*> NETLIST_OBJECTS;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class NETLIST_OBJECT_LIST
|
* NETLIST_OBJECT_LIST
|
||||||
* is a container holding and _owning_ NETLIST_OBJECTs, which are connected items
|
* is a container holding and _owning_ NETLIST_OBJECTs, which are connected items
|
||||||
* in a full schematic hierarchy. It is helpful for netlist and ERC calculations.
|
* in a full schematic hierarchy. It is helpful for netlist and ERC calculations.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -83,7 +83,7 @@ extern std::string toUTFTildaText( const wxString& txt );
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SCH_COMPONENT
|
* SCH_COMPONENT
|
||||||
* describes a real schematic component
|
* describes a real schematic component
|
||||||
*/
|
*/
|
||||||
class SCH_COMPONENT : public SCH_ITEM
|
class SCH_COMPONENT : public SCH_ITEM
|
||||||
|
|
|
@ -72,7 +72,7 @@ typedef boost::ptr_map<wxString, EPART> EPART_LIST;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SCH_EAGLE_PLUGIN
|
* SCH_EAGLE_PLUGIN
|
||||||
* is a #SCH_PLUGIN derivation for loading 6.x+ Eagle schematic files.
|
* is a #SCH_PLUGIN derivation for loading 6.x+ Eagle schematic files.
|
||||||
*
|
*
|
||||||
* As with all SCH_PLUGINs there is no UI dependencies i.e. windowing calls allowed.
|
* As with all SCH_PLUGINs there is no UI dependencies i.e. windowing calls allowed.
|
||||||
|
|
|
@ -38,7 +38,7 @@ class LIB_FIELD;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SCH_FIELD
|
* SCH_FIELD
|
||||||
* instances are attached to a component and provide a place for the component's value,
|
* instances are attached to a component and provide a place for the component's value,
|
||||||
* reference designator, footprint, and user definable name-value pairs of arbitrary purpose.
|
* reference designator, footprint, and user definable name-value pairs of arbitrary purpose.
|
||||||
*
|
*
|
||||||
|
|
|
@ -39,7 +39,7 @@ class PROPERTIES;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SCH_IO_MGR
|
* SCH_IO_MGR
|
||||||
* is a factory which returns an instance of a #SCH_PLUGIN.
|
* is a factory which returns an instance of a #SCH_PLUGIN.
|
||||||
*/
|
*/
|
||||||
class SCH_IO_MGR
|
class SCH_IO_MGR
|
||||||
|
|
|
@ -60,7 +60,7 @@ enum DANGLING_END_T {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class DANGLING_END_ITEM
|
* DANGLING_END_ITEM
|
||||||
* is a helper class used to store the state of schematic items that can be connected to
|
* is a helper class used to store the state of schematic items that can be connected to
|
||||||
* other schematic items.
|
* other schematic items.
|
||||||
*/
|
*/
|
||||||
|
@ -127,7 +127,7 @@ public:
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SCH_ITEM
|
* SCH_ITEM
|
||||||
* is a base class for any item which can be embedded within the SCHEMATIC
|
* is a base class for any item which can be embedded within the SCHEMATIC
|
||||||
* container class, and therefore instances of derived classes should only be
|
* container class, and therefore instances of derived classes should only be
|
||||||
* found in EESCHEMA or other programs that use class SCHEMATIC and its contents.
|
* found in EESCHEMA or other programs that use class SCHEMATIC and its contents.
|
||||||
|
|
|
@ -62,7 +62,7 @@ class SCH_PAINTER;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SCH_RENDER_SETTINGS
|
* SCH_RENDER_SETTINGS
|
||||||
* Stores schematic-specific render settings.
|
* Stores schematic-specific render settings.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
@ -112,7 +112,7 @@ public:
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SCH_PAINTER
|
* SCH_PAINTER
|
||||||
* Contains methods for drawing schematic-specific items.
|
* Contains methods for drawing schematic-specific items.
|
||||||
*/
|
*/
|
||||||
class SCH_PAINTER : public PAINTER
|
class SCH_PAINTER : public PAINTER
|
||||||
|
|
|
@ -45,7 +45,7 @@ class SCH_REFERENCE;
|
||||||
class SCH_REFERENCE_LIST;
|
class SCH_REFERENCE_LIST;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SCH_REFERENCE
|
* SCH_REFERENCE
|
||||||
* is used as a helper to define a component's reference designator in a schematic. This
|
* is used as a helper to define a component's reference designator in a schematic. This
|
||||||
* helper is required in a complex hierarchy because a component can be used more than
|
* helper is required in a complex hierarchy because a component can be used more than
|
||||||
* once and its reference depends on the sheet path. This class is used to flatten the
|
* once and its reference depends on the sheet path. This class is used to flatten the
|
||||||
|
@ -195,7 +195,7 @@ public:
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SCH_REFERENCE_LIST
|
* SCH_REFERENCE_LIST
|
||||||
* is used to create a flattened list of components because in a complex hierarchy, a component
|
* is used to create a flattened list of components because in a complex hierarchy, a component
|
||||||
* can be used more than once and its reference designator is dependent on the sheet path for
|
* can be used more than once and its reference designator is dependent on the sheet path for
|
||||||
* the same component. This flattened list is used for netlist generation, BOM generation,
|
* the same component. This flattened list is used for netlist generation, BOM generation,
|
||||||
|
|
|
@ -97,7 +97,7 @@ class SCH_REFERENCE_LIST;
|
||||||
typedef std::map<wxString, SCH_REFERENCE_LIST> SCH_MULTI_UNIT_REFERENCE_MAP;
|
typedef std::map<wxString, SCH_REFERENCE_LIST> SCH_MULTI_UNIT_REFERENCE_MAP;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SCH_SHEET_PATH
|
* SCH_SHEET_PATH
|
||||||
*
|
*
|
||||||
* handles access to a stack of flattened #SCH_SHEET objects by way of a path for
|
* handles access to a stack of flattened #SCH_SHEET objects by way of a path for
|
||||||
* creating a flattened schematic hierarchy.
|
* creating a flattened schematic hierarchy.
|
||||||
|
@ -334,7 +334,7 @@ typedef SCH_SHEET_PATHS::const_reverse_iterator SCH_SHEET_PATHS_CRITER;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SCH_SHEET_LIST
|
* SCH_SHEET_LIST
|
||||||
*
|
*
|
||||||
* handles a list of #SCH_SHEET_PATH objects in a flattened hierarchy.
|
* handles a list of #SCH_SHEET_PATH objects in a flattened hierarchy.
|
||||||
*
|
*
|
||||||
|
|
|
@ -35,7 +35,7 @@ class TOOL_MANAGER;
|
||||||
extern char g_lastBusEntryShape;
|
extern char g_lastBusEntryShape;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class EESCHEMA_ACTIONS
|
* EESCHEMA_ACTIONS
|
||||||
*
|
*
|
||||||
* Gathers all the actions that are shared by tools. The instance of SCH_ACTIONS is created
|
* Gathers all the actions that are shared by tools. The instance of SCH_ACTIONS is created
|
||||||
* inside of ACTION_MANAGER object that registers the actions.
|
* inside of ACTION_MANAGER object that registers the actions.
|
||||||
|
|
|
@ -33,7 +33,7 @@ class EE_SELECTION_TOOL;
|
||||||
class SCH_BASE_FRAME;
|
class SCH_BASE_FRAME;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class EE_POINT_EDITOR
|
* EE_POINT_EDITOR
|
||||||
*
|
*
|
||||||
* Tool that displays edit points allowing to modify items by dragging the points.
|
* Tool that displays edit points allowing to modify items by dragging the points.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -40,7 +40,7 @@
|
||||||
class EE_SELECTION;
|
class EE_SELECTION;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class EE_TOOL_BASE
|
* EE_TOOL_BASE
|
||||||
*
|
*
|
||||||
* A foundation class for a tool operating on a schematic or symbol
|
* A foundation class for a tool operating on a schematic or symbol
|
||||||
**/
|
**/
|
||||||
|
|
|
@ -32,7 +32,7 @@
|
||||||
class LIB_EDIT_FRAME;
|
class LIB_EDIT_FRAME;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class LIB_CONTROL
|
* LIB_CONTROL
|
||||||
*
|
*
|
||||||
* Handles actions for the various symbol editor and viewers.
|
* Handles actions for the various symbol editor and viewers.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -32,7 +32,7 @@ class LIB_EDIT_FRAME;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class LIB_DRAWING_TOOLS
|
* LIB_DRAWING_TOOLS
|
||||||
*
|
*
|
||||||
* Tool responsible for drawing/placing items (body outlines, pins, etc.)
|
* Tool responsible for drawing/placing items (body outlines, pins, etc.)
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -38,7 +38,7 @@ class EE_SELECTION_TOOL;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SCH_DRAWING_TOOLS
|
* SCH_DRAWING_TOOLS
|
||||||
*
|
*
|
||||||
* Tool responsible for drawing/placing items (symbols, wires, busses, labels, etc.)
|
* Tool responsible for drawing/placing items (symbols, wires, busses, labels, etc.)
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -33,7 +33,7 @@
|
||||||
class SCH_EDIT_FRAME;
|
class SCH_EDIT_FRAME;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SCH_EDITOR_CONTROL
|
* SCH_EDITOR_CONTROL
|
||||||
*
|
*
|
||||||
* Handles actions specific to the schematic editor in eeschema.
|
* Handles actions specific to the schematic editor in eeschema.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -60,7 +60,7 @@ struct BUS_UNFOLDING_T
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class SCH_LINE_DRAWING_TOOL
|
* SCH_LINE_DRAWING_TOOL
|
||||||
*
|
*
|
||||||
* Tool responsible for drawing/placing items (symbols, wires, busses, labels, etc.)
|
* Tool responsible for drawing/placing items (symbols, wires, busses, labels, etc.)
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -35,7 +35,7 @@
|
||||||
class EDA_RECT;
|
class EDA_RECT;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class for transforming drawing coordinates for a wxDC device context.
|
* for transforming drawing coordinates for a wxDC device context.
|
||||||
*
|
*
|
||||||
* This probably should be a base class with all pure virtual methods and a WXDC_TRANSFORM
|
* This probably should be a base class with all pure virtual methods and a WXDC_TRANSFORM
|
||||||
* derived class. Then in the future if some new device context is used, a new transform could
|
* derived class. Then in the future if some new device context is used, a new transform could
|
||||||
|
|
|
@ -46,7 +46,7 @@
|
||||||
#include <macros.h>
|
#include <macros.h>
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* class X2_ATTRIBUTE
|
* X2_ATTRIBUTE
|
||||||
* The attribute value consists of a number of substrings separated by a comma
|
* The attribute value consists of a number of substrings separated by a comma
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
@ -154,7 +154,7 @@ bool X2_ATTRIBUTE::ParseAttribCmd( FILE* aFile, char *aBuffer, int aBuffSize, ch
|
||||||
}
|
}
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* class X2_ATTRIBUTE_FILEFUNCTION ( from %TF.FileFunction in Gerber file)
|
* X2_ATTRIBUTE_FILEFUNCTION ( from %TF.FileFunction in Gerber file)
|
||||||
* Example file function:
|
* Example file function:
|
||||||
* %TF.FileFunction,Copper,L1,Top*%
|
* %TF.FileFunction,Copper,L1,Top*%
|
||||||
* - Type. Such as copper, solder mask etc.
|
* - Type. Such as copper, solder mask etc.
|
||||||
|
|
|
@ -47,7 +47,7 @@
|
||||||
#include <wx/arrstr.h>
|
#include <wx/arrstr.h>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class X2_ATTRIBUTE
|
* X2_ATTRIBUTE
|
||||||
* The attribute value consists of a number of substrings separated by a comma
|
* The attribute value consists of a number of substrings separated by a comma
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
@ -132,7 +132,7 @@ public:
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class X2_ATTRIBUTE_FILEFUNCTION ( from %TF.FileFunction in Gerber file)
|
* X2_ATTRIBUTE_FILEFUNCTION ( from %TF.FileFunction in Gerber file)
|
||||||
* Example file function:
|
* Example file function:
|
||||||
* %TF.FileFunction,Copper,L1,Top*%
|
* %TF.FileFunction,Copper,L1,Top*%
|
||||||
* - Type. Such as copper, solder mask etc.
|
* - Type. Such as copper, solder mask etc.
|
||||||
|
|
|
@ -210,7 +210,7 @@ private:
|
||||||
typedef std::vector<AM_PARAM_EVAL> AM_PARAM_EVAL_STACK;
|
typedef std::vector<AM_PARAM_EVAL> AM_PARAM_EVAL_STACK;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class AM_PARAM
|
* AM_PARAM
|
||||||
* holds an operand for an AM_PARAM as defined within
|
* holds an operand for an AM_PARAM as defined within
|
||||||
* standard RS274X. The \a value field can be a constant, i.e. "immediate"
|
* standard RS274X. The \a value field can be a constant, i.e. "immediate"
|
||||||
* parameter or it may not be used if this param is going to defer to the
|
* parameter or it may not be used if this param is going to defer to the
|
||||||
|
@ -275,7 +275,7 @@ public:
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class AM_PARAM
|
* AM_PARAM
|
||||||
* holds a parameter value for an "aperture macro" as defined within
|
* holds a parameter value for an "aperture macro" as defined within
|
||||||
* standard RS274X. The parameter can be a constant, i.e. "immediate" parameter,
|
* standard RS274X. The parameter can be a constant, i.e. "immediate" parameter,
|
||||||
* or depend on some defered values, defined in a D_CODE, by the ADD command.
|
* or depend on some defered values, defined in a D_CODE, by the ADD command.
|
||||||
|
|
|
@ -76,7 +76,7 @@ struct APERTURE_MACRO;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class D_CODE
|
* D_CODE
|
||||||
* holds a gerber DCODE (also called Aperture) definition.
|
* holds a gerber DCODE (also called Aperture) definition.
|
||||||
*/
|
*/
|
||||||
class D_CODE
|
class D_CODE
|
||||||
|
|
|
@ -42,7 +42,7 @@
|
||||||
class GERBER_FILE_IMAGE_LIST;
|
class GERBER_FILE_IMAGE_LIST;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class GBR_LAYOUT
|
* GBR_LAYOUT
|
||||||
* holds list of GERBER_DRAW_ITEM currently loaded.
|
* holds list of GERBER_DRAW_ITEM currently loaded.
|
||||||
*/
|
*/
|
||||||
class GBR_LAYOUT : public EDA_ITEM
|
class GBR_LAYOUT : public EDA_ITEM
|
||||||
|
|
|
@ -23,7 +23,7 @@
|
||||||
#include <collector.h>
|
#include <collector.h>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class GERBER_COLLECTOR
|
* GERBER_COLLECTOR
|
||||||
* is intended for use when the right click button is pressed, or when the
|
* is intended for use when the right click button is pressed, or when the
|
||||||
* plain "arrow" tool is in effect.
|
* plain "arrow" tool is in effect.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -102,7 +102,7 @@ private:
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class GERBER_FILE_IMAGE
|
* GERBER_FILE_IMAGE
|
||||||
* holds the Image data and parameters for one gerber file
|
* holds the Image data and parameters for one gerber file
|
||||||
* and layer parameters (TODO: move them in GERBER_LAYER class
|
* and layer parameters (TODO: move them in GERBER_LAYER class
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -49,7 +49,7 @@ class REPORTER;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class GERBVIEW_FRAME
|
* GERBVIEW_FRAME
|
||||||
* is the main window used in GerbView.
|
* is the main window used in GerbView.
|
||||||
*/
|
*/
|
||||||
|
|
||||||
|
|
|
@ -39,7 +39,7 @@
|
||||||
|
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* Class GERBER_LAYER_WIDGET
|
* GERBER_LAYER_WIDGET
|
||||||
* is here to implement the abtract functions of LAYER_WIDGET so they
|
* is here to implement the abtract functions of LAYER_WIDGET so they
|
||||||
* may be tied into the GERBVIEW_FRAME's data and so we can add a popup
|
* may be tied into the GERBVIEW_FRAME's data and so we can add a popup
|
||||||
* menu which is specific to Pcbnew's needs.
|
* menu which is specific to Pcbnew's needs.
|
||||||
|
|
|
@ -34,7 +34,7 @@
|
||||||
#include <layer_widget.h>
|
#include <layer_widget.h>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class GERBER_LAYER_WIDGET
|
* GERBER_LAYER_WIDGET
|
||||||
* is here to implement the abtract functions of LAYER_WIDGET so they
|
* is here to implement the abtract functions of LAYER_WIDGET so they
|
||||||
* may be tied into the GERBVIEW_FRAME's data and so we can add a popup
|
* may be tied into the GERBVIEW_FRAME's data and so we can add a popup
|
||||||
* menu which is specific to Pcbnew's needs.
|
* menu which is specific to Pcbnew's needs.
|
||||||
|
|
|
@ -43,7 +43,7 @@ namespace KIGFX
|
||||||
class GAL;
|
class GAL;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class GERBVIEW_RENDER_SETTINGS
|
* GERBVIEW_RENDER_SETTINGS
|
||||||
* Stores GerbView specific render settings.
|
* Stores GerbView specific render settings.
|
||||||
*/
|
*/
|
||||||
class GERBVIEW_RENDER_SETTINGS : public RENDER_SETTINGS
|
class GERBVIEW_RENDER_SETTINGS : public RENDER_SETTINGS
|
||||||
|
@ -164,7 +164,7 @@ protected:
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class GERBVIEW_PAINTER
|
* GERBVIEW_PAINTER
|
||||||
* Contains methods for drawing GerbView-specific items.
|
* Contains methods for drawing GerbView-specific items.
|
||||||
*/
|
*/
|
||||||
class GERBVIEW_PAINTER : public PAINTER
|
class GERBVIEW_PAINTER : public PAINTER
|
||||||
|
|
|
@ -64,7 +64,7 @@
|
||||||
* X and Y are followed by + or - and m + n digits (not separated)
|
* X and Y are followed by + or - and m + n digits (not separated)
|
||||||
* m = integer part
|
* m = integer part
|
||||||
* n = part after the comma
|
* n = part after the comma
|
||||||
* Classic formats: m = 2, n = 3 (size 2.3)
|
*ic formats: m = 2, n = 3 (size 2.3)
|
||||||
* m = 3, n = 4 (size 3.4)
|
* m = 3, n = 4 (size 3.4)
|
||||||
* eg
|
* eg
|
||||||
* GxxX00345Y-06123*
|
* GxxX00345Y-06123*
|
||||||
|
|
|
@ -29,7 +29,7 @@ class TOOL_EVENT;
|
||||||
class TOOL_MANAGER;
|
class TOOL_MANAGER;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class GERBVIEW_ACTIONS
|
* GERBVIEW_ACTIONS
|
||||||
*
|
*
|
||||||
* Gathers all the actions that are shared by tools. The instance of GERBVIEW_ACTIONS is created
|
* Gathers all the actions that are shared by tools. The instance of GERBVIEW_ACTIONS is created
|
||||||
* inside of ACTION_MANAGER object that registers the actions.
|
* inside of ACTION_MANAGER object that registers the actions.
|
||||||
|
|
|
@ -25,7 +25,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class PCBNEW_CONTROL
|
* PCBNEW_CONTROL
|
||||||
*
|
*
|
||||||
* Handles actions that are shared between different frames in pcbnew.
|
* Handles actions that are shared between different frames in pcbnew.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -40,7 +40,7 @@ namespace KIGFX
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class GERBVIEW_SELECTION_TOOL
|
* GERBVIEW_SELECTION_TOOL
|
||||||
*
|
*
|
||||||
* Selection tool for GerbView, based on the one in PcbNew
|
* Selection tool for GerbView, based on the one in PcbNew
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -37,7 +37,7 @@
|
||||||
#include <common.h>
|
#include <common.h>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class GRID_TYPE
|
* GRID_TYPE
|
||||||
* is for grid arrays.
|
* is for grid arrays.
|
||||||
*/
|
*/
|
||||||
class GRID_TYPE
|
class GRID_TYPE
|
||||||
|
@ -68,7 +68,7 @@ typedef std::vector<GRID_TYPE> GRIDS;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class BASE_SCREEN
|
* BASE_SCREEN
|
||||||
* handles how to draw a screen (a board, a schematic ...)
|
* handles how to draw a screen (a board, a schematic ...)
|
||||||
*/
|
*/
|
||||||
class BASE_SCREEN : public EDA_ITEM
|
class BASE_SCREEN : public EDA_ITEM
|
||||||
|
|
|
@ -156,7 +156,7 @@ typedef const INSPECTOR_FUNC& INSPECTOR; /// std::function passed to nested u
|
||||||
typedef unsigned STATUS_FLAGS;
|
typedef unsigned STATUS_FLAGS;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class EDA_ITEM
|
* EDA_ITEM
|
||||||
* is a base class for most all the KiCad significant classes, used in
|
* is a base class for most all the KiCad significant classes, used in
|
||||||
* schematics and boards.
|
* schematics and boards.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -35,7 +35,7 @@ class PLOTTER;
|
||||||
|
|
||||||
|
|
||||||
/*
|
/*
|
||||||
* class BASIC_GAL is a minimal GAL implementation to draw, plot and convert
|
* BASIC_GAL is a minimal GAL implementation to draw, plot and convert
|
||||||
* stroke texts to a set of segments for DRC tests, and to calculate text sizes.
|
* stroke texts to a set of segments for DRC tests, and to calculate text sizes.
|
||||||
*
|
*
|
||||||
* Currently it allows one to use GAL and STROKE_FONT methods in legacy draw mode
|
* Currently it allows one to use GAL and STROKE_FONT methods in legacy draw mode
|
||||||
|
|
|
@ -169,7 +169,7 @@ enum
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class BOARD_DESIGN_SETTINGS
|
* BOARD_DESIGN_SETTINGS
|
||||||
* contains design settings for a BOARD object.
|
* contains design settings for a BOARD object.
|
||||||
*/
|
*/
|
||||||
class BOARD_DESIGN_SETTINGS
|
class BOARD_DESIGN_SETTINGS
|
||||||
|
|
|
@ -57,7 +57,7 @@ struct BOARD_PRINTOUT_SETTINGS : public PRINTOUT_SETTINGS
|
||||||
};
|
};
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class BOARD_PRINTOUT
|
* BOARD_PRINTOUT
|
||||||
* is a class derived from wxPrintout to handle the necessary information to control a printer
|
* is a class derived from wxPrintout to handle the necessary information to control a printer
|
||||||
* when printing a board
|
* when printing a board
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -61,7 +61,7 @@ enum STROKE_T
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class BOARD_ITEM
|
* BOARD_ITEM
|
||||||
* is a base class for any item which can be embedded within the BOARD
|
* is a base class for any item which can be embedded within the BOARD
|
||||||
* container class, and therefore instances of derived classes should only be
|
* container class, and therefore instances of derived classes should only be
|
||||||
* found in Pcbnew or other programs that use class BOARD and its contents.
|
* found in Pcbnew or other programs that use class BOARD and its contents.
|
||||||
|
|
|
@ -41,7 +41,7 @@ class EDA_ITEM;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class COLLECTOR
|
* COLLECTOR
|
||||||
* is an abstract class that will find and hold all the objects according to
|
* is an abstract class that will find and hold all the objects according to
|
||||||
* an inspection done by the Inspect() function which must be implemented by
|
* an inspection done by the Inspect() function which must be implemented by
|
||||||
* any derived class. When Inspect() finds an object that it wants to collect,
|
* any derived class. When Inspect() finds an object that it wants to collect,
|
||||||
|
|
|
@ -42,7 +42,7 @@ class wxString;
|
||||||
class PARAM_CFG_ARRAY;
|
class PARAM_CFG_ARRAY;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class COLORS_DESIGN_SETTINGS
|
* COLORS_DESIGN_SETTINGS
|
||||||
* is a list of color settings for designs in Pcbnew
|
* is a list of color settings for designs in Pcbnew
|
||||||
*/
|
*/
|
||||||
class COLORS_DESIGN_SETTINGS : public SETTINGS
|
class COLORS_DESIGN_SETTINGS : public SETTINGS
|
||||||
|
|
|
@ -60,7 +60,7 @@ CHANGE_TYPE operator&( CHANGE_TYPE aTypeA, T aTypeB )
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class COMMIT
|
* COMMIT
|
||||||
*
|
*
|
||||||
* Represents a set of changes (additions, deletions or modifications)
|
* Represents a set of changes (additions, deletions or modifications)
|
||||||
* of a data model (e.g. the BOARD) class.
|
* of a data model (e.g. the BOARD) class.
|
||||||
|
|
|
@ -88,7 +88,7 @@ enum paramcfg_id {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class PARAM_CFG_BASE
|
* PARAM_CFG_BASE
|
||||||
* is a base class which establishes the interface functions ReadParam and SaveParam,
|
* is a base class which establishes the interface functions ReadParam and SaveParam,
|
||||||
* which are implemented by a number of derived classes, and these function's
|
* which are implemented by a number of derived classes, and these function's
|
||||||
* doxygen comments are inherited also.
|
* doxygen comments are inherited also.
|
||||||
|
|
|
@ -31,7 +31,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class TOOL_SETTINGS
|
* TOOL_SETTINGS
|
||||||
*
|
*
|
||||||
* Manages persistent settings for a tool (just a simple wrapper to wxConfigBase)
|
* Manages persistent settings for a tool (just a simple wrapper to wxConfigBase)
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -40,7 +40,7 @@ void ConvertMarkdown2Html( const wxString& aMarkdownInput, wxString& aHtmlOutput
|
||||||
class EDA_DRAW_FRAME;
|
class EDA_DRAW_FRAME;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class EDA_LIST_DIALOG
|
* EDA_LIST_DIALOG
|
||||||
*
|
*
|
||||||
* A dialog which shows:
|
* A dialog which shows:
|
||||||
* a list of elements for selection,
|
* a list of elements for selection,
|
||||||
|
|
|
@ -34,7 +34,7 @@ class BOARD_ITEM;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class DRC_ITEM
|
* DRC_ITEM
|
||||||
* is a holder for a DRC (in Pcbnew) or ERC (in Eeschema) error item.
|
* is a holder for a DRC (in Pcbnew) or ERC (in Eeschema) error item.
|
||||||
* It is generated when two objects are too close (DRC)
|
* It is generated when two objects are too close (DRC)
|
||||||
* or two connected objects (pins) have incompatible electrical types (ERC).
|
* or two connected objects (pins) have incompatible electrical types (ERC).
|
||||||
|
|
|
@ -71,7 +71,7 @@ enum DSN_SYNTAX_T {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class DSNLEXER
|
* DSNLEXER
|
||||||
* implements a lexical analyzer for the SPECCTRA DSN file format. It
|
* implements a lexical analyzer for the SPECCTRA DSN file format. It
|
||||||
* reads lexical tokens from the current LINE_READER through the NextTok()
|
* reads lexical tokens from the current LINE_READER through the NextTok()
|
||||||
* function.
|
* function.
|
||||||
|
|
|
@ -63,7 +63,7 @@ static inline wxXmlNode* getChildrenNodes( NODE_MAP& aMap, const wxString& aName
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class XML_PARSER_ERROR
|
* XML_PARSER_ERROR
|
||||||
* implements a simple wrapper around runtime_error to isolate the errors thrown by the
|
* implements a simple wrapper around runtime_error to isolate the errors thrown by the
|
||||||
* Eagle XML parser.
|
* Eagle XML parser.
|
||||||
*/
|
*/
|
||||||
|
@ -97,7 +97,7 @@ struct TRIPLET
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class XPATH
|
* XPATH
|
||||||
* keeps track of what we are working on within a PTREE.
|
* keeps track of what we are working on within a PTREE.
|
||||||
* Then if an exception is thrown, the place within the tree that gave us
|
* Then if an exception is thrown, the place within the tree that gave us
|
||||||
* grief can be reported almost accurately. To minimally impact
|
* grief can be reported almost accurately. To minimally impact
|
||||||
|
@ -181,7 +181,7 @@ template <>
|
||||||
wxString Convert<wxString>( const wxString& aValue );
|
wxString Convert<wxString>( const wxString& aValue );
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class OPTIONAL_XML_ATTRIBUTE
|
* OPTIONAL_XML_ATTRIBUTE
|
||||||
* models an optional XML attribute.
|
* models an optional XML attribute.
|
||||||
* This was implemented as an alternative to OPT. This class should be replaced with a
|
* This was implemented as an alternative to OPT. This class should be replaced with a
|
||||||
* simple typedef per type using std::optional when C++17 is published.
|
* simple typedef per type using std::optional when C++17 is published.
|
||||||
|
@ -600,7 +600,7 @@ struct ERECT
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class EATTR
|
* EATTR
|
||||||
* parses an Eagle "attribute" XML element. Note that an attribute element
|
* parses an Eagle "attribute" XML element. Note that an attribute element
|
||||||
* is different than an XML element attribute. The attribute element is a
|
* is different than an XML element attribute. The attribute element is a
|
||||||
* full XML node in and of itself, and has attributes of its own. Blame Eagle.
|
* full XML node in and of itself, and has attributes of its own. Blame Eagle.
|
||||||
|
|
|
@ -34,7 +34,7 @@
|
||||||
#include <math/box2.h>
|
#include <math/box2.h>
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class EDA_RECT
|
* EDA_RECT
|
||||||
* handles the component boundary box.
|
* handles the component boundary box.
|
||||||
* This class is similar to wxRect, but some wxRect functions are very curious,
|
* This class is similar to wxRect, but some wxRect functions are very curious,
|
||||||
* and are working only if dimensions are >= 0 (not always the case in KiCad)
|
* and are working only if dimensions are >= 0 (not always the case in KiCad)
|
||||||
|
|
|
@ -25,7 +25,7 @@
|
||||||
*
|
*
|
||||||
* Usage:
|
* Usage:
|
||||||
* [header]
|
* [header]
|
||||||
* class A {
|
* A {
|
||||||
* DEFINE_ENUM_VECTOR( COLORS, { RED, GREEN, BLUE } );
|
* DEFINE_ENUM_VECTOR( COLORS, { RED, GREEN, BLUE } );
|
||||||
* };
|
* };
|
||||||
*
|
*
|
||||||
|
|
|
@ -30,7 +30,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class FILTER_READER
|
* FILTER_READER
|
||||||
* reads lines of text from another LINE_READER, but only returns non-comment
|
* reads lines of text from another LINE_READER, but only returns non-comment
|
||||||
* lines and non-blank lines from its ReadLine() function.
|
* lines and non-blank lines from its ReadLine() function.
|
||||||
*/
|
*/
|
||||||
|
@ -63,7 +63,7 @@ public:
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class WHITESPACE_FILTER_READER
|
* WHITESPACE_FILTER_READER
|
||||||
* reads lines of text from another LINE_READER, but only returns non-comment
|
* reads lines of text from another LINE_READER, but only returns non-comment
|
||||||
* lines and non-blank lines with leading whitespace characters (space and tab)
|
* lines and non-blank lines with leading whitespace characters (space and tab)
|
||||||
* removed from its ReadLine() function.
|
* removed from its ReadLine() function.
|
||||||
|
|
|
@ -34,7 +34,7 @@ class FP_LIB_TABLE_GRID;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class FP_LIB_TABLE_ROW
|
* FP_LIB_TABLE_ROW
|
||||||
*
|
*
|
||||||
* holds a record identifying a library accessed by the appropriate footprint library #PLUGIN
|
* holds a record identifying a library accessed by the appropriate footprint library #PLUGIN
|
||||||
* object in the #FP_LIB_TABLE.
|
* object in the #FP_LIB_TABLE.
|
||||||
|
|
|
@ -33,7 +33,7 @@
|
||||||
namespace KIGFX
|
namespace KIGFX
|
||||||
{
|
{
|
||||||
/**
|
/**
|
||||||
* Class COLOR4D
|
* COLOR4D
|
||||||
* is the color representation with 4 components: red, green, blue, alpha.
|
* is the color representation with 4 components: red, green, blue, alpha.
|
||||||
*/
|
*/
|
||||||
class COLOR4D
|
class COLOR4D
|
||||||
|
|
|
@ -45,7 +45,7 @@ enum
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class GRID_TRICKS
|
* GRID_TRICKS
|
||||||
* is used to add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
|
* is used to add mouse and command handling (such as cut, copy, and paste) to a WX_GRID instance.
|
||||||
*/
|
*/
|
||||||
class GRID_TRICKS : public wxEvtHandler
|
class GRID_TRICKS : public wxEvtHandler
|
||||||
|
|
|
@ -36,7 +36,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class HTML_MESSAGE_BOX
|
* HTML_MESSAGE_BOX
|
||||||
*/
|
*/
|
||||||
class HTML_MESSAGE_BOX : public DIALOG_DISPLAY_HTML_TEXT_BASE
|
class HTML_MESSAGE_BOX : public DIALOG_DISPLAY_HTML_TEXT_BASE
|
||||||
{
|
{
|
||||||
|
|
|
@ -38,7 +38,7 @@
|
||||||
#define THROW_IO_ERROR( msg ) throw IO_ERROR( msg, __FILE__, __FUNCTION__, __LINE__ )
|
#define THROW_IO_ERROR( msg ) throw IO_ERROR( msg, __FILE__, __FUNCTION__, __LINE__ )
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class KI_PARAM_ERROR
|
* KI_PARAM_ERROR
|
||||||
* is a class used to hold a translatable error message and may be used when throwing exceptions
|
* is a class used to hold a translatable error message and may be used when throwing exceptions
|
||||||
* containing a translated error message.
|
* containing a translated error message.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -58,7 +58,7 @@ struct DYN_LOOKUP;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class KICAD_CURL
|
* KICAD_CURL
|
||||||
* simple wrapper class to call curl_global_init and curl_global_cleanup for KiCad.
|
* simple wrapper class to call curl_global_init and curl_global_cleanup for KiCad.
|
||||||
*/
|
*/
|
||||||
class KICAD_CURL
|
class KICAD_CURL
|
||||||
|
|
|
@ -38,7 +38,7 @@ typedef void CURL;
|
||||||
struct curl_slist;
|
struct curl_slist;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class KICAD_CURL_EASY
|
* KICAD_CURL_EASY
|
||||||
* wrapper interface around the curl_easy API
|
* wrapper interface around the curl_easy API
|
||||||
*
|
*
|
||||||
* Handling of using the curl_easy API to make a request and save the response to
|
* Handling of using the curl_easy API to make a request and save the response to
|
||||||
|
|
|
@ -29,7 +29,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class KIFACE_I
|
* KIFACE_I
|
||||||
* is a KIFACE (I)mplementation,
|
* is a KIFACE (I)mplementation,
|
||||||
* with some features useful for DSOs which implement a KIFACE.
|
* with some features useful for DSOs which implement a KIFACE.
|
||||||
* It is abstract, a few functions must be implemented in derivations.
|
* It is abstract, a few functions must be implemented in derivations.
|
||||||
|
|
|
@ -137,7 +137,7 @@ class wxTopLevelWindow;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class KIFACE
|
* KIFACE
|
||||||
* is used by a participant in the KIWAY alchemy. KIWAY is a minimalistic
|
* is used by a participant in the KIWAY alchemy. KIWAY is a minimalistic
|
||||||
* software bus for communications between various DLLs/DSOs (DSOs) within the same
|
* software bus for communications between various DLLs/DSOs (DSOs) within the same
|
||||||
* KiCad process. It makes it possible to call between DSOs without having to link
|
* KiCad process. It makes it possible to call between DSOs without having to link
|
||||||
|
@ -244,7 +244,7 @@ struct KIFACE
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class KIWAY
|
* KIWAY
|
||||||
* is a minimalistic software bus for communications between various
|
* is a minimalistic software bus for communications between various
|
||||||
* DLLs/DSOs (DSOs) within the same KiCad process. It makes it possible
|
* DLLs/DSOs (DSOs) within the same KiCad process. It makes it possible
|
||||||
* to call between DSOs without having to link them together, and without
|
* to call between DSOs without having to link them together, and without
|
||||||
|
|
|
@ -33,7 +33,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class KIWAY_EXPRESS
|
* KIWAY_EXPRESS
|
||||||
* carries a payload from one KIWAY_PLAYER to another within a PROJECT.
|
* carries a payload from one KIWAY_PLAYER to another within a PROJECT.
|
||||||
*/
|
*/
|
||||||
class KIWAY_EXPRESS : public wxEvent
|
class KIWAY_EXPRESS : public wxEvent
|
||||||
|
|
|
@ -32,7 +32,7 @@ class PROJECT;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class KIWAY_HOLDER
|
* KIWAY_HOLDER
|
||||||
* is a mix in class which holds the location of a wxWindow's KIWAY. It allows calls to
|
* is a mix in class which holds the location of a wxWindow's KIWAY. It allows calls to
|
||||||
* Kiway() and SetKiway().
|
* Kiway() and SetKiway().
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -30,7 +30,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class KIWAY_MGR
|
* KIWAY_MGR
|
||||||
* is a container for all KIWAYS [and PROJECTS]. This class needs to work both
|
* is a container for all KIWAYS [and PROJECTS]. This class needs to work both
|
||||||
* for a C++ project manager and an a wxPython one (after being moved into a
|
* for a C++ project manager and an a wxPython one (after being moved into a
|
||||||
* header later).
|
* header later).
|
||||||
|
|
|
@ -43,7 +43,7 @@ class WX_EVENT_LOOP;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class KIWAY_PLAYER
|
* KIWAY_PLAYER
|
||||||
* is a wxFrame capable of the OpenProjectFiles function, meaning it can load
|
* is a wxFrame capable of the OpenProjectFiles function, meaning it can load
|
||||||
* a portion of a KiCad project. Because this class provides a dummy implementation,
|
* a portion of a KiCad project. Because this class provides a dummy implementation,
|
||||||
* it is not a certainty that all classes which inherit from this clas intend to
|
* it is not a certainty that all classes which inherit from this clas intend to
|
||||||
|
|
|
@ -327,7 +327,7 @@ typedef std::vector<PCB_LAYER_ID> BASE_SEQ;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class LSEQ
|
* LSEQ
|
||||||
* is a sequence (and therefore also a set) of PCB_LAYER_IDs. A sequence provides
|
* is a sequence (and therefore also a set) of PCB_LAYER_IDs. A sequence provides
|
||||||
* a certain order.
|
* a certain order.
|
||||||
* <p>
|
* <p>
|
||||||
|
@ -377,7 +377,7 @@ typedef std::bitset<PCB_LAYER_ID_COUNT> BASE_SET;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class LSET
|
* LSET
|
||||||
* is a set of PCB_LAYER_IDs. It can be converted to numerous purpose LSEQs using
|
* is a set of PCB_LAYER_IDs. It can be converted to numerous purpose LSEQs using
|
||||||
* the various member functions, most of which are based on Seq(). The advantage
|
* the various member functions, most of which are based on Seq(). The advantage
|
||||||
* of converting to LSEQ using purposeful code, is it removes any dependency
|
* of converting to LSEQ using purposeful code, is it removes any dependency
|
||||||
|
|
|
@ -47,7 +47,7 @@ class EDA_MSG_PANEL;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class EDA_MSG_ITEM
|
* EDA_MSG_ITEM
|
||||||
* is used EDA_MSG_PANEL as the item type for displaying messages.
|
* is used EDA_MSG_PANEL as the item type for displaying messages.
|
||||||
*/
|
*/
|
||||||
class MSG_PANEL_ITEM
|
class MSG_PANEL_ITEM
|
||||||
|
@ -105,7 +105,7 @@ typedef MSG_PANEL_ITEMS::const_iterator MSG_PANEL_ITEMS_CITER;
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class EDA_MSG_PANEL
|
* EDA_MSG_PANEL
|
||||||
* is a panel to display various information messages.
|
* is a panel to display various information messages.
|
||||||
*/
|
*/
|
||||||
class EDA_MSG_PANEL : public wxPanel
|
class EDA_MSG_PANEL : public wxPanel
|
||||||
|
|
|
@ -34,7 +34,7 @@
|
||||||
class PCB_BASE_FRAME;
|
class PCB_BASE_FRAME;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class ORIGIN_VIEWITEM
|
* ORIGIN_VIEWITEM
|
||||||
*
|
*
|
||||||
* View item to draw an origin marker.
|
* View item to draw an origin marker.
|
||||||
*/
|
*/
|
||||||
|
|
|
@ -42,7 +42,7 @@
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class PAGE_INFO
|
* PAGE_INFO
|
||||||
* describes the page size and margins of a paper page on which to
|
* describes the page size and margins of a paper page on which to
|
||||||
* eventually print or plot. Paper sizes are often described in inches.
|
* eventually print or plot. Paper sizes are often described in inches.
|
||||||
* Here paper is described in 1/1000th of an inch (mils). For convenience
|
* Here paper is described in 1/1000th of an inch (mils). For convenience
|
||||||
|
|
|
@ -44,7 +44,7 @@ class GAL;
|
||||||
class VIEW_ITEM;
|
class VIEW_ITEM;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class RENDER_SETTINGS
|
* RENDER_SETTINGS
|
||||||
* Contains all the knowledge about how graphical objects are drawn on
|
* Contains all the knowledge about how graphical objects are drawn on
|
||||||
* any output surface/device. This includes:
|
* any output surface/device. This includes:
|
||||||
* - color/transparency settings
|
* - color/transparency settings
|
||||||
|
@ -299,7 +299,7 @@ protected:
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class PAINTER
|
* PAINTER
|
||||||
* contains all the knowledge about how to draw graphical object onto
|
* contains all the knowledge about how to draw graphical object onto
|
||||||
* any particular output device.
|
* any particular output device.
|
||||||
* This knowledge is held outside the individual graphical objects so that
|
* This knowledge is held outside the individual graphical objects so that
|
||||||
|
|
|
@ -60,7 +60,7 @@ class PCB_PLOT_PARAMS;
|
||||||
class FP_LIB_TABLE;
|
class FP_LIB_TABLE;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* class PCB_BASE_FRAME
|
* PCB_BASE_FRAME
|
||||||
* basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
|
* basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
|
||||||
*/
|
*/
|
||||||
class PCB_BASE_FRAME : public EDA_DRAW_FRAME
|
class PCB_BASE_FRAME : public EDA_DRAW_FRAME
|
||||||
|
|
|
@ -31,7 +31,7 @@
|
||||||
#define PCB_DISPLAY_OPTIONS_H_
|
#define PCB_DISPLAY_OPTIONS_H_
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class PCB_DISPLAY_OPTIONS
|
* PCB_DISPLAY_OPTIONS
|
||||||
* handles display options like enable/disable some optional drawings.
|
* handles display options like enable/disable some optional drawings.
|
||||||
*/
|
*/
|
||||||
class PCB_DISPLAY_OPTIONS
|
class PCB_DISPLAY_OPTIONS
|
||||||
|
|
|
@ -56,7 +56,7 @@ enum TRACE_CLEARANCE_DISPLAY_MODE_T {
|
||||||
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Class DISPLAY_OPTIONS
|
* DISPLAY_OPTIONS
|
||||||
* handles display options like enable/disable some optional drawings.
|
* handles display options like enable/disable some optional drawings.
|
||||||
*/
|
*/
|
||||||
class DISPLAY_OPTIONS
|
class DISPLAY_OPTIONS
|
||||||
|
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
Reference in New Issue