diff --git a/3d-viewer/3d_cache/sg/sg_coordindex.h b/3d-viewer/3d_cache/sg/sg_coordindex.h index 2fc06ca77d..31664fcc4e 100644 --- a/3d-viewer/3d_cache/sg/sg_coordindex.h +++ b/3d-viewer/3d_cache/sg/sg_coordindex.h @@ -32,7 +32,7 @@ #include "3d_cache/sg/sg_index.h" /** - * Class SGCOORDINDEX + * SGCOORDINDEX * is a class which maintains a coordinate index list. Users * must ensure that coordinate indices are specified as * triplets (triangular faces) since no checking is performed. diff --git a/3d-viewer/3d_cache/sg/sg_node.h b/3d-viewer/3d_cache/sg/sg_node.h index 575a1aad08..8bbb519097 100644 --- a/3d-viewer/3d_cache/sg/sg_node.h +++ b/3d-viewer/3d_cache/sg/sg_node.h @@ -70,7 +70,7 @@ namespace S3D /** - * Class SGNODE + * SGNODE * represents the base class of all Scene Graph nodes */ class SGNODE diff --git a/3d-viewer/3d_canvas/status_text_reporter.h b/3d-viewer/3d_canvas/status_text_reporter.h index 2d7f9d0c51..5be930f319 100644 --- a/3d-viewer/3d_canvas/status_text_reporter.h +++ b/3d-viewer/3d_canvas/status_text_reporter.h @@ -32,7 +32,7 @@ #include /** - * Class STATUS_TEXT_REPORTER + * STATUS_TEXT_REPORTER * is a wrapper for reporting to a wxString in a wxFrame status text. */ class STATUS_TEXT_REPORTER : public REPORTER diff --git a/3d-viewer/3d_rendering/3d_render_raytracing/shapes2D/cbbox2d.h b/3d-viewer/3d_rendering/3d_render_raytracing/shapes2D/cbbox2d.h index 93656db510..af99c17822 100644 --- a/3d-viewer/3d_rendering/3d_render_raytracing/shapes2D/cbbox2d.h +++ b/3d-viewer/3d_rendering/3d_render_raytracing/shapes2D/cbbox2d.h @@ -34,7 +34,7 @@ /** - * Class CBBOX + * CBBOX * manages a bounding box defined by two SFVEC2F min max points. */ struct CBBOX2D diff --git a/3d-viewer/3d_rendering/3d_render_raytracing/shapes3D/cbbox.h b/3d-viewer/3d_rendering/3d_render_raytracing/shapes3D/cbbox.h index 38dd52794e..1f5fedab80 100644 --- a/3d-viewer/3d_rendering/3d_render_raytracing/shapes3D/cbbox.h +++ b/3d-viewer/3d_rendering/3d_render_raytracing/shapes3D/cbbox.h @@ -34,7 +34,7 @@ #include // For the DBG( /** - * Class CBBOX + * CBBOX * manages a bounding box defined by two SFVEC3F min max points. */ struct CBBOX diff --git a/3d-viewer/3d_rendering/cimage.h b/3d-viewer/3d_rendering/cimage.h index 4429460870..211fe7888c 100644 --- a/3d-viewer/3d_rendering/cimage.h +++ b/3d-viewer/3d_rendering/cimage.h @@ -83,7 +83,7 @@ typedef struct { /** - * Class CIMAGE + * CIMAGE * manages a 8-bit channel image */ class CIMAGE diff --git a/3d-viewer/3d_viewer/3d_actions.h b/3d-viewer/3d_viewer/3d_actions.h index 603f15e44b..5991f06968 100644 --- a/3d-viewer/3d_viewer/3d_actions.h +++ b/3d-viewer/3d_viewer/3d_actions.h @@ -34,7 +34,7 @@ class TOOL_EVENT; 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. */ diff --git a/common/dialog_about/dialog_about.cpp b/common/dialog_about/dialog_about.cpp index 5106138594..5ea2d2bc13 100644 --- a/common/dialog_about/dialog_about.cpp +++ b/common/dialog_about/dialog_about.cpp @@ -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 ) diff --git a/common/dialogs/wx_html_report_panel.h b/common/dialogs/wx_html_report_panel.h index 9531f4d389..1741170850 100644 --- a/common/dialogs/wx_html_report_panel.h +++ b/common/dialogs/wx_html_report_panel.h @@ -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 * dialogs in eeschema and pcbnew. Provides error filtering functionality diff --git a/common/page_layout/page_layout_reader.cpp b/common/page_layout/page_layout_reader.cpp index 2a3ef5e8a7..dfc94becf2 100644 --- a/common/page_layout/page_layout_reader.cpp +++ b/common/page_layout/page_layout_reader.cpp @@ -43,7 +43,7 @@ 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 * for a WS_DATA_MODEL. */ diff --git a/common/widgets/widget_hotkey_list.cpp b/common/widgets/widget_hotkey_list.cpp index 66dbfda10d..99ff9c1548 100644 --- a/common/widgets/widget_hotkey_list.cpp +++ b/common/widgets/widget_hotkey_list.cpp @@ -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 * hotkey, edit it via GetCurrentValue() in the row's client data, then call * 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. */ 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 */ diff --git a/cvpcb/display_footprints_frame.h b/cvpcb/display_footprints_frame.h index d30c83aa80..d7ff734612 100644 --- a/cvpcb/display_footprints_frame.h +++ b/cvpcb/display_footprints_frame.h @@ -35,7 +35,7 @@ /** - * Class DISPLAY_FOOTPRINTS_FRAME + * DISPLAY_FOOTPRINTS_FRAME * is used to display footprints. */ class DISPLAY_FOOTPRINTS_FRAME : public PCB_BASE_FRAME diff --git a/cvpcb/tools/cvpcb_actions.h b/cvpcb/tools/cvpcb_actions.h index f86fa5aa3c..a8fb63baa2 100644 --- a/cvpcb/tools/cvpcb_actions.h +++ b/cvpcb/tools/cvpcb_actions.h @@ -32,7 +32,7 @@ class TOOL_ACTION; /** - * Class CVPCB_ACTIONS + * CVPCB_ACTIONS * * 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. diff --git a/cvpcb/tools/cvpcb_association_tool.h b/cvpcb/tools/cvpcb_association_tool.h index 4c73fbe698..b3689bde47 100644 --- a/cvpcb/tools/cvpcb_association_tool.h +++ b/cvpcb/tools/cvpcb_association_tool.h @@ -27,7 +27,7 @@ /** - * Class CVPCB_CONTROL + * CVPCB_CONTROL * * Handles actions in main cvpcb window. */ diff --git a/cvpcb/tools/cvpcb_control.h b/cvpcb/tools/cvpcb_control.h index 6cc134e672..d60145d24f 100644 --- a/cvpcb/tools/cvpcb_control.h +++ b/cvpcb/tools/cvpcb_control.h @@ -27,7 +27,7 @@ /** - * Class CVPCB_CONTROL + * CVPCB_CONTROL * * Handles actions in main cvpcb window. */ diff --git a/cvpcb/tools/cvpcb_fpviewer_control.h b/cvpcb/tools/cvpcb_fpviewer_control.h index 4caeaa3b28..d3c764f135 100644 --- a/cvpcb/tools/cvpcb_fpviewer_control.h +++ b/cvpcb/tools/cvpcb_fpviewer_control.h @@ -31,7 +31,7 @@ /** - * Class CVPCB_FOOTPRINT_VIEWER_CONTROL + * CVPCB_FOOTPRINT_VIEWER_CONTROL * * Handles control actions for the cvpcb footprint display frame. */ diff --git a/cvpcb/tools/cvpcb_fpviewer_selection_tool.h b/cvpcb/tools/cvpcb_fpviewer_selection_tool.h index b85f6c37cf..fc1b3c652f 100644 --- a/cvpcb/tools/cvpcb_fpviewer_selection_tool.h +++ b/cvpcb/tools/cvpcb_fpviewer_selection_tool.h @@ -29,7 +29,7 @@ /** - * Class CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL + * CVPCB_FOOTPRINT_VIEWER_SELECTION_TOOL * * Selection tool for the footprint viewer in cvpcb. */ diff --git a/eeschema/dialog_erc_listbox.h b/eeschema/dialog_erc_listbox.h index 2dfc61fe0b..fedfac45cf 100644 --- a/eeschema/dialog_erc_listbox.h +++ b/eeschema/dialog_erc_listbox.h @@ -32,7 +32,7 @@ #include /** - * Class ERC_HTML_LISTFRAME + * ERC_HTML_LISTFRAME * is used to display a DRC_ITEM_LIST. */ class ERC_HTML_LISTFRAME : public wxHtmlWindow diff --git a/eeschema/dialogs/dialog_annotate.cpp b/eeschema/dialogs/dialog_annotate.cpp index 295a683087..dab8a1af61 100644 --- a/eeschema/dialogs/dialog_annotate.cpp +++ b/eeschema/dialogs/dialog_annotate.cpp @@ -50,7 +50,7 @@ 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 */ class DIALOG_ANNOTATE: public DIALOG_ANNOTATE_BASE diff --git a/eeschema/dialogs/dialog_edit_one_field.h b/eeschema/dialogs/dialog_edit_one_field.h index 275f91ff7c..54c8483566 100644 --- a/eeschema/dialogs/dialog_edit_one_field.h +++ b/eeschema/dialogs/dialog_edit_one_field.h @@ -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. *

* 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. *

* @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. *

* @note Use ShowQuasiModal when calling this class! diff --git a/eeschema/ee_collectors.h b/eeschema/ee_collectors.h index 810e722e5b..5f04e1aeb5 100644 --- a/eeschema/ee_collectors.h +++ b/eeschema/ee_collectors.h @@ -34,7 +34,7 @@ /** - * Class EE_COLLECTOR + * EE_COLLECTOR */ class EE_COLLECTOR : public COLLECTOR { diff --git a/eeschema/lib_bezier.h b/eeschema/lib_bezier.h index 3de4fe092a..290f8e8c35 100644 --- a/eeschema/lib_bezier.h +++ b/eeschema/lib_bezier.h @@ -29,7 +29,7 @@ /** - * Class LIB_BEZIER + * LIB_BEZIER * defines bezier curve graphic body item. */ class LIB_BEZIER : public LIB_ITEM diff --git a/eeschema/netlist_exporters/netlist_exporter.h b/eeschema/netlist_exporters/netlist_exporter.h index 6f6ebb77f7..37674af89c 100644 --- a/eeschema/netlist_exporters/netlist_exporter.h +++ b/eeschema/netlist_exporters/netlist_exporter.h @@ -36,7 +36,7 @@ #include /** - * Class UNIQUE_STRINGS + * UNIQUE_STRINGS * tracks unique wxStrings and is useful in telling if a string * 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. */ class NETLIST_EXPORTER diff --git a/eeschema/netlist_exporters/netlist_exporter_cadstar.h b/eeschema/netlist_exporters/netlist_exporter_cadstar.h index e40a3c091f..ca67fb9792 100644 --- a/eeschema/netlist_exporters/netlist_exporter_cadstar.h +++ b/eeschema/netlist_exporters/netlist_exporter_cadstar.h @@ -30,7 +30,7 @@ /** - * Class NETLIST_EXPORTER_CADSTAR + * NETLIST_EXPORTER_CADSTAR * generates a netlist compatible with CADSTAR */ class NETLIST_EXPORTER_CADSTAR : public NETLIST_EXPORTER diff --git a/eeschema/netlist_exporters/netlist_exporter_generic.h b/eeschema/netlist_exporters/netlist_exporter_generic.h index dbcfbf7892..7ec1d01c72 100644 --- a/eeschema/netlist_exporters/netlist_exporter_generic.h +++ b/eeschema/netlist_exporters/netlist_exporter_generic.h @@ -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 * transform the XML to other netlist formats outside of the C++ codebase. */ diff --git a/eeschema/netlist_exporters/netlist_exporter_kicad.h b/eeschema/netlist_exporters/netlist_exporter_kicad.h index 9e4e67380c..27813d64e9 100644 --- a/eeschema/netlist_exporters/netlist_exporter_kicad.h +++ b/eeschema/netlist_exporters/netlist_exporter_kicad.h @@ -31,7 +31,7 @@ class OUTPUTFORMATTER; /** - * Class NETLIST_EXPORTER_KICAD + * NETLIST_EXPORTER_KICAD * generates the kicad netlist format supported by pcbnew. It is basically * the generic netlist format just formatted slightly different. */ diff --git a/eeschema/netlist_exporters/netlist_exporter_orcadpcb2.h b/eeschema/netlist_exporters/netlist_exporter_orcadpcb2.h index 8a44dbccc0..8b53b7d75c 100644 --- a/eeschema/netlist_exporters/netlist_exporter_orcadpcb2.h +++ b/eeschema/netlist_exporters/netlist_exporter_orcadpcb2.h @@ -29,7 +29,7 @@ #include "netlist_exporter.h" /** - * Class NETLIST_EXPORTER_ORCADPCB2 + * NETLIST_EXPORTER_ORCADPCB2 * generates a netlist compatible with OrCAD */ class NETLIST_EXPORTER_ORCADPCB2 : public NETLIST_EXPORTER diff --git a/eeschema/netlist_exporters/netlist_exporter_pspice.h b/eeschema/netlist_exporters/netlist_exporter_pspice.h index 214e2fde3b..d651311fe4 100644 --- a/eeschema/netlist_exporters/netlist_exporter_pspice.h +++ b/eeschema/netlist_exporters/netlist_exporter_pspice.h @@ -95,7 +95,7 @@ struct SPICE_ITEM /** - * Class NETLIST_EXPORTER_PSPICE + * NETLIST_EXPORTER_PSPICE * generates a PSPICE compatible netlist */ class NETLIST_EXPORTER_PSPICE : public NETLIST_EXPORTER diff --git a/eeschema/netlist_object.h b/eeschema/netlist_object.h index 0cd2d0d995..7647fad524 100644 --- a/eeschema/netlist_object.h +++ b/eeschema/netlist_object.h @@ -296,7 +296,7 @@ typedef std::vector NETLIST_OBJECTS; /** - * Class NETLIST_OBJECT_LIST + * NETLIST_OBJECT_LIST * 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. */ diff --git a/eeschema/sch_component.h b/eeschema/sch_component.h index 7b5b0ebd37..cc8493af2a 100644 --- a/eeschema/sch_component.h +++ b/eeschema/sch_component.h @@ -83,7 +83,7 @@ extern std::string toUTFTildaText( const wxString& txt ); /** - * Class SCH_COMPONENT + * SCH_COMPONENT * describes a real schematic component */ class SCH_COMPONENT : public SCH_ITEM diff --git a/eeschema/sch_eagle_plugin.h b/eeschema/sch_eagle_plugin.h index 46d31dfdb8..ac829439c7 100644 --- a/eeschema/sch_eagle_plugin.h +++ b/eeschema/sch_eagle_plugin.h @@ -72,7 +72,7 @@ typedef boost::ptr_map EPART_LIST; /** - * Class SCH_EAGLE_PLUGIN + * SCH_EAGLE_PLUGIN * 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. diff --git a/eeschema/sch_field.h b/eeschema/sch_field.h index 0ed1dbcf1b..dc2920acb2 100644 --- a/eeschema/sch_field.h +++ b/eeschema/sch_field.h @@ -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, * reference designator, footprint, and user definable name-value pairs of arbitrary purpose. * diff --git a/eeschema/sch_io_mgr.h b/eeschema/sch_io_mgr.h index 086bd072e7..0be6fa21b1 100644 --- a/eeschema/sch_io_mgr.h +++ b/eeschema/sch_io_mgr.h @@ -39,7 +39,7 @@ class PROPERTIES; /** - * Class SCH_IO_MGR + * SCH_IO_MGR * is a factory which returns an instance of a #SCH_PLUGIN. */ class SCH_IO_MGR diff --git a/eeschema/sch_item.h b/eeschema/sch_item.h index b9bb71dbc2..683f1f4f24 100644 --- a/eeschema/sch_item.h +++ b/eeschema/sch_item.h @@ -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 * 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 * container class, and therefore instances of derived classes should only be * found in EESCHEMA or other programs that use class SCHEMATIC and its contents. diff --git a/eeschema/sch_painter.h b/eeschema/sch_painter.h index 4fa1914298..49fa2b3310 100644 --- a/eeschema/sch_painter.h +++ b/eeschema/sch_painter.h @@ -62,7 +62,7 @@ class SCH_PAINTER; /** - * Class SCH_RENDER_SETTINGS + * SCH_RENDER_SETTINGS * Stores schematic-specific render settings. */ @@ -112,7 +112,7 @@ public: /** - * Class SCH_PAINTER + * SCH_PAINTER * Contains methods for drawing schematic-specific items. */ class SCH_PAINTER : public PAINTER diff --git a/eeschema/sch_reference_list.h b/eeschema/sch_reference_list.h index 9ac828da1d..5c5bf01646 100644 --- a/eeschema/sch_reference_list.h +++ b/eeschema/sch_reference_list.h @@ -45,7 +45,7 @@ class SCH_REFERENCE; 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 * 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 @@ -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 * 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, diff --git a/eeschema/sch_sheet_path.h b/eeschema/sch_sheet_path.h index b1dab43592..191450079a 100644 --- a/eeschema/sch_sheet_path.h +++ b/eeschema/sch_sheet_path.h @@ -97,7 +97,7 @@ class SCH_REFERENCE_LIST; typedef std::map 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 * 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. * diff --git a/eeschema/tools/ee_actions.h b/eeschema/tools/ee_actions.h index edb0731524..e4df8c9eae 100644 --- a/eeschema/tools/ee_actions.h +++ b/eeschema/tools/ee_actions.h @@ -35,7 +35,7 @@ class TOOL_MANAGER; 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 * inside of ACTION_MANAGER object that registers the actions. diff --git a/eeschema/tools/ee_point_editor.h b/eeschema/tools/ee_point_editor.h index 5717224214..fb59a6e8c0 100644 --- a/eeschema/tools/ee_point_editor.h +++ b/eeschema/tools/ee_point_editor.h @@ -33,7 +33,7 @@ class EE_SELECTION_TOOL; class SCH_BASE_FRAME; /** - * Class EE_POINT_EDITOR + * EE_POINT_EDITOR * * Tool that displays edit points allowing to modify items by dragging the points. */ diff --git a/eeschema/tools/ee_tool_base.h b/eeschema/tools/ee_tool_base.h index 0b230c85a5..ca3a1822e8 100644 --- a/eeschema/tools/ee_tool_base.h +++ b/eeschema/tools/ee_tool_base.h @@ -40,7 +40,7 @@ class EE_SELECTION; /** - * Class EE_TOOL_BASE + * EE_TOOL_BASE * * A foundation class for a tool operating on a schematic or symbol **/ diff --git a/eeschema/tools/lib_control.h b/eeschema/tools/lib_control.h index 391a905ca5..4a7afcc839 100644 --- a/eeschema/tools/lib_control.h +++ b/eeschema/tools/lib_control.h @@ -32,7 +32,7 @@ class LIB_EDIT_FRAME; /** - * Class LIB_CONTROL + * LIB_CONTROL * * Handles actions for the various symbol editor and viewers. */ diff --git a/eeschema/tools/lib_drawing_tools.h b/eeschema/tools/lib_drawing_tools.h index 2c7f88db89..e4dd3600b6 100644 --- a/eeschema/tools/lib_drawing_tools.h +++ b/eeschema/tools/lib_drawing_tools.h @@ -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.) */ diff --git a/eeschema/tools/sch_drawing_tools.h b/eeschema/tools/sch_drawing_tools.h index 66ef85a2c3..f5f321ddb4 100644 --- a/eeschema/tools/sch_drawing_tools.h +++ b/eeschema/tools/sch_drawing_tools.h @@ -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.) */ diff --git a/eeschema/tools/sch_editor_control.h b/eeschema/tools/sch_editor_control.h index 070fcd15ce..aae0367612 100644 --- a/eeschema/tools/sch_editor_control.h +++ b/eeschema/tools/sch_editor_control.h @@ -33,7 +33,7 @@ class SCH_EDIT_FRAME; /** - * Class SCH_EDITOR_CONTROL + * SCH_EDITOR_CONTROL * * Handles actions specific to the schematic editor in eeschema. */ diff --git a/eeschema/tools/sch_line_wire_bus_tool.h b/eeschema/tools/sch_line_wire_bus_tool.h index 1298aad566..b1afc33bc8 100644 --- a/eeschema/tools/sch_line_wire_bus_tool.h +++ b/eeschema/tools/sch_line_wire_bus_tool.h @@ -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.) */ diff --git a/eeschema/transform.h b/eeschema/transform.h index 5cdf450bc0..cf70740e9a 100644 --- a/eeschema/transform.h +++ b/eeschema/transform.h @@ -35,7 +35,7 @@ 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 * derived class. Then in the future if some new device context is used, a new transform could diff --git a/gerbview/X2_gerber_attributes.cpp b/gerbview/X2_gerber_attributes.cpp index 1ef8b9e2a6..238e34eae8 100644 --- a/gerbview/X2_gerber_attributes.cpp +++ b/gerbview/X2_gerber_attributes.cpp @@ -46,7 +46,7 @@ #include /* - * class X2_ATTRIBUTE + * X2_ATTRIBUTE * 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: * %TF.FileFunction,Copper,L1,Top*% * - Type. Such as copper, solder mask etc. diff --git a/gerbview/X2_gerber_attributes.h b/gerbview/X2_gerber_attributes.h index 83002dca94..1638b0685a 100644 --- a/gerbview/X2_gerber_attributes.h +++ b/gerbview/X2_gerber_attributes.h @@ -47,7 +47,7 @@ #include /** - * class X2_ATTRIBUTE + * X2_ATTRIBUTE * 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: * %TF.FileFunction,Copper,L1,Top*% * - Type. Such as copper, solder mask etc. diff --git a/gerbview/am_param.h b/gerbview/am_param.h index d119d7a434..27efa0650a 100644 --- a/gerbview/am_param.h +++ b/gerbview/am_param.h @@ -210,7 +210,7 @@ private: typedef std::vector AM_PARAM_EVAL_STACK; /** - * Class AM_PARAM + * AM_PARAM * holds an operand for an AM_PARAM as defined within * 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 @@ -275,7 +275,7 @@ public: }; /** - * Class AM_PARAM + * AM_PARAM * holds a parameter value for an "aperture macro" as defined within * 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. diff --git a/gerbview/dcode.h b/gerbview/dcode.h index 34a86225f7..7e5682d020 100644 --- a/gerbview/dcode.h +++ b/gerbview/dcode.h @@ -76,7 +76,7 @@ struct APERTURE_MACRO; /** - * Class D_CODE + * D_CODE * holds a gerber DCODE (also called Aperture) definition. */ class D_CODE diff --git a/gerbview/gbr_layout.h b/gerbview/gbr_layout.h index 683e10b667..4b1bc627e4 100644 --- a/gerbview/gbr_layout.h +++ b/gerbview/gbr_layout.h @@ -42,7 +42,7 @@ class GERBER_FILE_IMAGE_LIST; /** - * Class GBR_LAYOUT + * GBR_LAYOUT * holds list of GERBER_DRAW_ITEM currently loaded. */ class GBR_LAYOUT : public EDA_ITEM diff --git a/gerbview/gerber_collectors.h b/gerbview/gerber_collectors.h index b5061ec6eb..bbe729cdfb 100644 --- a/gerbview/gerber_collectors.h +++ b/gerbview/gerber_collectors.h @@ -23,7 +23,7 @@ #include /** - * Class GERBER_COLLECTOR + * GERBER_COLLECTOR * is intended for use when the right click button is pressed, or when the * plain "arrow" tool is in effect. */ diff --git a/gerbview/gerber_file_image.h b/gerbview/gerber_file_image.h index eaf1950905..db91dce13c 100644 --- a/gerbview/gerber_file_image.h +++ b/gerbview/gerber_file_image.h @@ -102,7 +102,7 @@ private: }; /** - * Class GERBER_FILE_IMAGE + * GERBER_FILE_IMAGE * holds the Image data and parameters for one gerber file * and layer parameters (TODO: move them in GERBER_LAYER class */ diff --git a/gerbview/gerbview_frame.h b/gerbview/gerbview_frame.h index 0ffa0db29e..514180bf3b 100644 --- a/gerbview/gerbview_frame.h +++ b/gerbview/gerbview_frame.h @@ -49,7 +49,7 @@ class REPORTER; /** - * Class GERBVIEW_FRAME + * GERBVIEW_FRAME * is the main window used in GerbView. */ diff --git a/gerbview/gerbview_layer_widget.cpp b/gerbview/gerbview_layer_widget.cpp index c16b606ce0..3b36c292e0 100644 --- a/gerbview/gerbview_layer_widget.cpp +++ b/gerbview/gerbview_layer_widget.cpp @@ -39,7 +39,7 @@ /* - * Class GERBER_LAYER_WIDGET + * GERBER_LAYER_WIDGET * 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 * menu which is specific to Pcbnew's needs. diff --git a/gerbview/gerbview_layer_widget.h b/gerbview/gerbview_layer_widget.h index efeafb2bf8..9e88b455d7 100644 --- a/gerbview/gerbview_layer_widget.h +++ b/gerbview/gerbview_layer_widget.h @@ -34,7 +34,7 @@ #include /** - * Class GERBER_LAYER_WIDGET + * GERBER_LAYER_WIDGET * 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 * menu which is specific to Pcbnew's needs. diff --git a/gerbview/gerbview_painter.h b/gerbview/gerbview_painter.h index 81fafca8e2..9c5d3c6239 100644 --- a/gerbview/gerbview_painter.h +++ b/gerbview/gerbview_painter.h @@ -43,7 +43,7 @@ namespace KIGFX class GAL; /** - * Class GERBVIEW_RENDER_SETTINGS + * GERBVIEW_RENDER_SETTINGS * Stores GerbView specific 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. */ class GERBVIEW_PAINTER : public PAINTER diff --git a/gerbview/rs274d.cpp b/gerbview/rs274d.cpp index 6e7b627346..043b122b7b 100644 --- a/gerbview/rs274d.cpp +++ b/gerbview/rs274d.cpp @@ -64,7 +64,7 @@ * X and Y are followed by + or - and m + n digits (not separated) * m = integer part * 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) * eg * GxxX00345Y-06123* diff --git a/gerbview/tools/gerbview_actions.h b/gerbview/tools/gerbview_actions.h index 41b99373e5..97869b7001 100644 --- a/gerbview/tools/gerbview_actions.h +++ b/gerbview/tools/gerbview_actions.h @@ -29,7 +29,7 @@ class TOOL_EVENT; class TOOL_MANAGER; /** - * Class GERBVIEW_ACTIONS + * GERBVIEW_ACTIONS * * 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. diff --git a/gerbview/tools/gerbview_control.h b/gerbview/tools/gerbview_control.h index aafa023110..8376fefafe 100644 --- a/gerbview/tools/gerbview_control.h +++ b/gerbview/tools/gerbview_control.h @@ -25,7 +25,7 @@ /** - * Class PCBNEW_CONTROL + * PCBNEW_CONTROL * * Handles actions that are shared between different frames in pcbnew. */ diff --git a/gerbview/tools/gerbview_selection_tool.h b/gerbview/tools/gerbview_selection_tool.h index 96444b6045..7153133961 100644 --- a/gerbview/tools/gerbview_selection_tool.h +++ b/gerbview/tools/gerbview_selection_tool.h @@ -40,7 +40,7 @@ namespace KIGFX /** - * Class GERBVIEW_SELECTION_TOOL + * GERBVIEW_SELECTION_TOOL * * Selection tool for GerbView, based on the one in PcbNew */ diff --git a/include/base_screen.h b/include/base_screen.h index e5ea3a718a..b9e938342a 100644 --- a/include/base_screen.h +++ b/include/base_screen.h @@ -37,7 +37,7 @@ #include /** - * Class GRID_TYPE + * GRID_TYPE * is for grid arrays. */ class GRID_TYPE @@ -68,7 +68,7 @@ typedef std::vector GRIDS; /** - * Class BASE_SCREEN + * BASE_SCREEN * handles how to draw a screen (a board, a schematic ...) */ class BASE_SCREEN : public EDA_ITEM diff --git a/include/base_struct.h b/include/base_struct.h index a670b066a5..8d26e694f1 100644 --- a/include/base_struct.h +++ b/include/base_struct.h @@ -156,7 +156,7 @@ typedef const INSPECTOR_FUNC& INSPECTOR; /// std::function passed to nested u typedef unsigned STATUS_FLAGS; /** - * Class EDA_ITEM + * EDA_ITEM * is a base class for most all the KiCad significant classes, used in * schematics and boards. */ diff --git a/include/basic_gal.h b/include/basic_gal.h index 11463bfe6d..377a7537f2 100644 --- a/include/basic_gal.h +++ b/include/basic_gal.h @@ -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. * * Currently it allows one to use GAL and STROKE_FONT methods in legacy draw mode diff --git a/include/board_design_settings.h b/include/board_design_settings.h index 68ee0bb361..189897e9ba 100644 --- a/include/board_design_settings.h +++ b/include/board_design_settings.h @@ -169,7 +169,7 @@ enum /** - * Class BOARD_DESIGN_SETTINGS + * BOARD_DESIGN_SETTINGS * contains design settings for a BOARD object. */ class BOARD_DESIGN_SETTINGS diff --git a/include/board_printout.h b/include/board_printout.h index bbf1f5c5d0..1ea62a3327 100644 --- a/include/board_printout.h +++ b/include/board_printout.h @@ -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 * when printing a board */ diff --git a/include/class_board_item.h b/include/class_board_item.h index 85fe68fa7c..a81a776681 100644 --- a/include/class_board_item.h +++ b/include/class_board_item.h @@ -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 * container class, and therefore instances of derived classes should only be * found in Pcbnew or other programs that use class BOARD and its contents. diff --git a/include/collector.h b/include/collector.h index a55cf1abac..219109681e 100644 --- a/include/collector.h +++ b/include/collector.h @@ -41,7 +41,7 @@ class EDA_ITEM; /** - * Class COLLECTOR + * COLLECTOR * 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 * any derived class. When Inspect() finds an object that it wants to collect, diff --git a/include/colors_design_settings.h b/include/colors_design_settings.h index 6396bfba3a..8f49ce68ad 100644 --- a/include/colors_design_settings.h +++ b/include/colors_design_settings.h @@ -42,7 +42,7 @@ class wxString; class PARAM_CFG_ARRAY; /** - * Class COLORS_DESIGN_SETTINGS + * COLORS_DESIGN_SETTINGS * is a list of color settings for designs in Pcbnew */ class COLORS_DESIGN_SETTINGS : public SETTINGS diff --git a/include/commit.h b/include/commit.h index 92dea81ba9..9f60d9618b 100644 --- a/include/commit.h +++ b/include/commit.h @@ -60,7 +60,7 @@ CHANGE_TYPE operator&( CHANGE_TYPE aTypeA, T aTypeB ) /** - * Class COMMIT + * COMMIT * * Represents a set of changes (additions, deletions or modifications) * of a data model (e.g. the BOARD) class. diff --git a/include/config_params.h b/include/config_params.h index 3ae33aad6a..0c2c33044d 100644 --- a/include/config_params.h +++ b/include/config_params.h @@ -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, * which are implemented by a number of derived classes, and these function's * doxygen comments are inherited also. diff --git a/include/core/settings.h b/include/core/settings.h index 5eb710f0bc..01a786fec1 100644 --- a/include/core/settings.h +++ b/include/core/settings.h @@ -31,7 +31,7 @@ /** - * Class TOOL_SETTINGS + * TOOL_SETTINGS * * Manages persistent settings for a tool (just a simple wrapper to wxConfigBase) */ diff --git a/include/dialog_helpers.h b/include/dialog_helpers.h index 74918a6f03..29af96ab25 100644 --- a/include/dialog_helpers.h +++ b/include/dialog_helpers.h @@ -40,7 +40,7 @@ void ConvertMarkdown2Html( const wxString& aMarkdownInput, wxString& aHtmlOutput class EDA_DRAW_FRAME; /** - * class EDA_LIST_DIALOG + * EDA_LIST_DIALOG * * A dialog which shows: * a list of elements for selection, diff --git a/include/drc_item.h b/include/drc_item.h index 857c7eb086..f087353790 100644 --- a/include/drc_item.h +++ b/include/drc_item.h @@ -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. * It is generated when two objects are too close (DRC) * or two connected objects (pins) have incompatible electrical types (ERC). diff --git a/include/dsnlexer.h b/include/dsnlexer.h index 0f76bd51fe..6201e99d8c 100644 --- a/include/dsnlexer.h +++ b/include/dsnlexer.h @@ -71,7 +71,7 @@ enum DSN_SYNTAX_T { /** - * Class DSNLEXER + * DSNLEXER * implements a lexical analyzer for the SPECCTRA DSN file format. It * reads lexical tokens from the current LINE_READER through the NextTok() * function. diff --git a/include/eagle_parser.h b/include/eagle_parser.h index 2c01f5a9f6..81ab15d641 100644 --- a/include/eagle_parser.h +++ b/include/eagle_parser.h @@ -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 * Eagle XML parser. */ @@ -97,7 +97,7 @@ struct TRIPLET /** - * Class XPATH + * XPATH * 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 * grief can be reported almost accurately. To minimally impact @@ -181,7 +181,7 @@ template <> wxString Convert( const wxString& aValue ); /** - * Class OPTIONAL_XML_ATTRIBUTE + * OPTIONAL_XML_ATTRIBUTE * models an optional XML attribute. * 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. @@ -600,7 +600,7 @@ struct ERECT /** - * Class EATTR + * EATTR * parses an Eagle "attribute" XML element. Note that an attribute element * 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. diff --git a/include/eda_rect.h b/include/eda_rect.h index 69cb8efb6a..a419d03718 100644 --- a/include/eda_rect.h +++ b/include/eda_rect.h @@ -34,7 +34,7 @@ #include /** - * Class EDA_RECT + * EDA_RECT * handles the component boundary box. * 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) diff --git a/include/enum_vector.h b/include/enum_vector.h index 78c14e8a1c..adb38335f6 100644 --- a/include/enum_vector.h +++ b/include/enum_vector.h @@ -25,7 +25,7 @@ * * Usage: * [header] - * class A { + * A { * DEFINE_ENUM_VECTOR( COLORS, { RED, GREEN, BLUE } ); * }; * diff --git a/include/filter_reader.h b/include/filter_reader.h index 1fcfef6f20..30c9009573 100644 --- a/include/filter_reader.h +++ b/include/filter_reader.h @@ -30,7 +30,7 @@ /** - * Class FILTER_READER + * FILTER_READER * reads lines of text from another LINE_READER, but only returns non-comment * 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 * lines and non-blank lines with leading whitespace characters (space and tab) * removed from its ReadLine() function. diff --git a/include/fp_lib_table.h b/include/fp_lib_table.h index 98902f76b4..84b3f45336 100644 --- a/include/fp_lib_table.h +++ b/include/fp_lib_table.h @@ -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 * object in the #FP_LIB_TABLE. diff --git a/include/gal/color4d.h b/include/gal/color4d.h index acd48205e7..7bb1db628a 100644 --- a/include/gal/color4d.h +++ b/include/gal/color4d.h @@ -33,7 +33,7 @@ namespace KIGFX { /** - * Class COLOR4D + * COLOR4D * is the color representation with 4 components: red, green, blue, alpha. */ class COLOR4D diff --git a/include/grid_tricks.h b/include/grid_tricks.h index fb24d6524f..81dcedeb32 100644 --- a/include/grid_tricks.h +++ b/include/grid_tricks.h @@ -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. */ class GRID_TRICKS : public wxEvtHandler diff --git a/include/html_messagebox.h b/include/html_messagebox.h index f9a7d3c483..3c2aced74b 100644 --- a/include/html_messagebox.h +++ b/include/html_messagebox.h @@ -36,7 +36,7 @@ /** - * Class HTML_MESSAGE_BOX + * HTML_MESSAGE_BOX */ class HTML_MESSAGE_BOX : public DIALOG_DISPLAY_HTML_TEXT_BASE { diff --git a/include/ki_exception.h b/include/ki_exception.h index f9dce32cf5..a4f92ecfab 100644 --- a/include/ki_exception.h +++ b/include/ki_exception.h @@ -38,7 +38,7 @@ #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 * containing a translated error message. */ diff --git a/include/kicad_curl/kicad_curl.h b/include/kicad_curl/kicad_curl.h index 351eff7b20..30d60bde68 100644 --- a/include/kicad_curl/kicad_curl.h +++ b/include/kicad_curl/kicad_curl.h @@ -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. */ class KICAD_CURL diff --git a/include/kicad_curl/kicad_curl_easy.h b/include/kicad_curl/kicad_curl_easy.h index 148e16c706..729cdd0c51 100644 --- a/include/kicad_curl/kicad_curl_easy.h +++ b/include/kicad_curl/kicad_curl_easy.h @@ -38,7 +38,7 @@ typedef void CURL; struct curl_slist; /** - * Class KICAD_CURL_EASY + * KICAD_CURL_EASY * wrapper interface around the curl_easy API * * Handling of using the curl_easy API to make a request and save the response to diff --git a/include/kiface_i.h b/include/kiface_i.h index e72f26a234..55b6198b9e 100644 --- a/include/kiface_i.h +++ b/include/kiface_i.h @@ -29,7 +29,7 @@ /** - * Class KIFACE_I + * KIFACE_I * is a KIFACE (I)mplementation, * with some features useful for DSOs which implement a KIFACE. * It is abstract, a few functions must be implemented in derivations. diff --git a/include/kiway.h b/include/kiway.h index 2f09c180a2..43186257b1 100644 --- a/include/kiway.h +++ b/include/kiway.h @@ -137,7 +137,7 @@ class wxTopLevelWindow; /** - * Class KIFACE + * KIFACE * 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 * 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 * DLLs/DSOs (DSOs) within the same KiCad process. It makes it possible * to call between DSOs without having to link them together, and without diff --git a/include/kiway_express.h b/include/kiway_express.h index dfb0b102c9..77b692d11f 100644 --- a/include/kiway_express.h +++ b/include/kiway_express.h @@ -33,7 +33,7 @@ /** - * Class KIWAY_EXPRESS + * KIWAY_EXPRESS * carries a payload from one KIWAY_PLAYER to another within a PROJECT. */ class KIWAY_EXPRESS : public wxEvent diff --git a/include/kiway_holder.h b/include/kiway_holder.h index 104081a4f4..d231b84bba 100644 --- a/include/kiway_holder.h +++ b/include/kiway_holder.h @@ -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 * Kiway() and SetKiway(). */ diff --git a/include/kiway_mgr.h b/include/kiway_mgr.h index 3b0999d7da..4baaec09d6 100644 --- a/include/kiway_mgr.h +++ b/include/kiway_mgr.h @@ -30,7 +30,7 @@ /** - * Class KIWAY_MGR + * KIWAY_MGR * 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 * header later). diff --git a/include/kiway_player.h b/include/kiway_player.h index 8386c1b325..dce1929c74 100644 --- a/include/kiway_player.h +++ b/include/kiway_player.h @@ -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 * 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 diff --git a/include/layers_id_colors_and_visibility.h b/include/layers_id_colors_and_visibility.h index 34eb716367..32c0190452 100644 --- a/include/layers_id_colors_and_visibility.h +++ b/include/layers_id_colors_and_visibility.h @@ -327,7 +327,7 @@ typedef std::vector BASE_SEQ; /** - * Class LSEQ + * LSEQ * is a sequence (and therefore also a set) of PCB_LAYER_IDs. A sequence provides * a certain order. *

@@ -377,7 +377,7 @@ typedef std::bitset BASE_SET; /** - * Class LSET + * LSET * 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 * of converting to LSEQ using purposeful code, is it removes any dependency diff --git a/include/msgpanel.h b/include/msgpanel.h index 04a0dd2637..a5ea8e7cc9 100644 --- a/include/msgpanel.h +++ b/include/msgpanel.h @@ -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. */ 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. */ class EDA_MSG_PANEL : public wxPanel diff --git a/include/origin_viewitem.h b/include/origin_viewitem.h index bdbe68d411..c38a89929b 100644 --- a/include/origin_viewitem.h +++ b/include/origin_viewitem.h @@ -34,7 +34,7 @@ class PCB_BASE_FRAME; /** - * Class ORIGIN_VIEWITEM + * ORIGIN_VIEWITEM * * View item to draw an origin marker. */ diff --git a/include/page_info.h b/include/page_info.h index b1b41a1d3e..91b2fff670 100644 --- a/include/page_info.h +++ b/include/page_info.h @@ -42,7 +42,7 @@ /** - * Class PAGE_INFO + * PAGE_INFO * describes the page size and margins of a paper page on which to * eventually print or plot. Paper sizes are often described in inches. * Here paper is described in 1/1000th of an inch (mils). For convenience diff --git a/include/painter.h b/include/painter.h index f3f92d4daf..7936b60978 100644 --- a/include/painter.h +++ b/include/painter.h @@ -44,7 +44,7 @@ class GAL; class VIEW_ITEM; /** - * Class RENDER_SETTINGS + * RENDER_SETTINGS * Contains all the knowledge about how graphical objects are drawn on * any output surface/device. This includes: * - color/transparency settings @@ -299,7 +299,7 @@ protected: /** - * Class PAINTER + * PAINTER * contains all the knowledge about how to draw graphical object onto * any particular output device. * This knowledge is held outside the individual graphical objects so that diff --git a/include/pcb_base_frame.h b/include/pcb_base_frame.h index 43daf84aea..bcb98cbef2 100644 --- a/include/pcb_base_frame.h +++ b/include/pcb_base_frame.h @@ -60,7 +60,7 @@ class PCB_PLOT_PARAMS; class FP_LIB_TABLE; /** - * class PCB_BASE_FRAME + * PCB_BASE_FRAME * basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer. */ class PCB_BASE_FRAME : public EDA_DRAW_FRAME diff --git a/include/pcb_display_options.h b/include/pcb_display_options.h index add072c691..38baaca164 100644 --- a/include/pcb_display_options.h +++ b/include/pcb_display_options.h @@ -31,7 +31,7 @@ #define PCB_DISPLAY_OPTIONS_H_ /** - * Class PCB_DISPLAY_OPTIONS + * PCB_DISPLAY_OPTIONS * handles display options like enable/disable some optional drawings. */ class PCB_DISPLAY_OPTIONS diff --git a/include/pcbstruct.h b/include/pcbstruct.h index 59ab39e3d4..1ffe06a353 100644 --- a/include/pcbstruct.h +++ b/include/pcbstruct.h @@ -56,7 +56,7 @@ enum TRACE_CLEARANCE_DISPLAY_MODE_T { /** - * Class DISPLAY_OPTIONS + * DISPLAY_OPTIONS * handles display options like enable/disable some optional drawings. */ class DISPLAY_OPTIONS diff --git a/include/pgm_base.h b/include/pgm_base.h index 7abe53b8ab..fe19229a5d 100644 --- a/include/pgm_base.h +++ b/include/pgm_base.h @@ -98,7 +98,7 @@ struct LANGUAGE_DESCR /** - * Class ENV_VAR_ITEM + * ENV_VAR_ITEM * * is a simple helper class to store environment variable values and the status of whether * or not they were defined externally to the process created when any of the KiCad applications @@ -139,7 +139,7 @@ typedef std::map::const_iterator ENV_VAR_MAP_CITER; /** - * Class PGM_BASE + * PGM_BASE * keeps program (whole process) data for KiCad programs. * The VTBL_ENTRY functions are VTBL_ENTRY so we can do cross module calls * without linking to them. This used to be a wxApp derivative, but that diff --git a/include/plugins/3dapi/ifsg_colors.h b/include/plugins/3dapi/ifsg_colors.h index 05aa299a49..2a22e7310e 100644 --- a/include/plugins/3dapi/ifsg_colors.h +++ b/include/plugins/3dapi/ifsg_colors.h @@ -35,7 +35,7 @@ /** - * Class IFSG_COLORS + * IFSG_COLORS * is the wrapper for SGCOLORS */ class SGLIB_API IFSG_COLORS : public IFSG_NODE diff --git a/include/plugins/3dapi/ifsg_coordindex.h b/include/plugins/3dapi/ifsg_coordindex.h index 2606943808..d94ea001b2 100644 --- a/include/plugins/3dapi/ifsg_coordindex.h +++ b/include/plugins/3dapi/ifsg_coordindex.h @@ -34,7 +34,7 @@ /** - * Class IFSG_COORDINDEX + * IFSG_COORDINDEX * is the wrapper for SGCOORDINDEX */ class SGLIB_API IFSG_COORDINDEX : public IFSG_INDEX diff --git a/include/plugins/3dapi/ifsg_coords.h b/include/plugins/3dapi/ifsg_coords.h index 9e01125c3e..95f11a7363 100644 --- a/include/plugins/3dapi/ifsg_coords.h +++ b/include/plugins/3dapi/ifsg_coords.h @@ -34,7 +34,7 @@ /** - * Class IFSG_COORDS + * IFSG_COORDS * is the wrapper for SGCOORDS */ class SGLIB_API IFSG_COORDS : public IFSG_NODE diff --git a/include/plugins/3dapi/ifsg_faceset.h b/include/plugins/3dapi/ifsg_faceset.h index 57ece8cf16..a18484769b 100644 --- a/include/plugins/3dapi/ifsg_faceset.h +++ b/include/plugins/3dapi/ifsg_faceset.h @@ -34,7 +34,7 @@ /** - * Class IFSG_FACESET + * IFSG_FACESET * is the wrapper for the SGFACESET class */ class SGLIB_API IFSG_FACESET : public IFSG_NODE diff --git a/include/plugins/3dapi/ifsg_index.h b/include/plugins/3dapi/ifsg_index.h index 9358bd8c85..3201d68f27 100644 --- a/include/plugins/3dapi/ifsg_index.h +++ b/include/plugins/3dapi/ifsg_index.h @@ -34,7 +34,7 @@ /** - * Class IFSG_INDEX + * IFSG_INDEX * is the wrapper for SGINDEX */ class SGLIB_API IFSG_INDEX : public IFSG_NODE diff --git a/include/plugins/3dapi/ifsg_node.h b/include/plugins/3dapi/ifsg_node.h index 3fae4c68ca..e247046e96 100644 --- a/include/plugins/3dapi/ifsg_node.h +++ b/include/plugins/3dapi/ifsg_node.h @@ -48,7 +48,7 @@ class SGNODE; /** - * Class IFSG_NODE + * IFSG_NODE * represents the base class of all DLL-safe Scene Graph nodes */ class SGLIB_API IFSG_NODE diff --git a/include/plugins/3dapi/ifsg_normals.h b/include/plugins/3dapi/ifsg_normals.h index 7a607d3ecf..d9792efd99 100644 --- a/include/plugins/3dapi/ifsg_normals.h +++ b/include/plugins/3dapi/ifsg_normals.h @@ -34,7 +34,7 @@ /** - * Class IFSG_NORMALS + * IFSG_NORMALS * is the wrapper for the SGNORMALS class */ class SGLIB_API IFSG_NORMALS : public IFSG_NODE diff --git a/include/plugins/3dapi/ifsg_shape.h b/include/plugins/3dapi/ifsg_shape.h index 570fb2e70c..431c858624 100644 --- a/include/plugins/3dapi/ifsg_shape.h +++ b/include/plugins/3dapi/ifsg_shape.h @@ -34,7 +34,7 @@ /** - * Class IFSG_SHAPE + * IFSG_SHAPE * is the wrapper for the SGSHAPE class */ class SGLIB_API IFSG_SHAPE : public IFSG_NODE diff --git a/include/plugins/3dapi/ifsg_transform.h b/include/plugins/3dapi/ifsg_transform.h index 0ede4cba10..afd124b860 100644 --- a/include/plugins/3dapi/ifsg_transform.h +++ b/include/plugins/3dapi/ifsg_transform.h @@ -34,7 +34,7 @@ /** - * Class IFSG_TRANSFORM + * IFSG_TRANSFORM * is the wrapper for the VRML compatible TRANSFORM block class SCENEGRAPH */ class SGLIB_API IFSG_TRANSFORM : public IFSG_NODE diff --git a/include/preview_items/arc_assistant.h b/include/preview_items/arc_assistant.h index 76397a5a28..2c191f5306 100644 --- a/include/preview_items/arc_assistant.h +++ b/include/preview_items/arc_assistant.h @@ -30,7 +30,7 @@ namespace KIGFX { namespace PREVIEW { /** - * Class SELECTION_AREA + * SELECTION_AREA * * Represents an assitant draw when interactively drawing an * arc on a canvas. diff --git a/include/preview_items/arc_geom_manager.h b/include/preview_items/arc_geom_manager.h index 7eb393fd57..38f0e0a386 100644 --- a/include/preview_items/arc_geom_manager.h +++ b/include/preview_items/arc_geom_manager.h @@ -33,7 +33,7 @@ namespace PREVIEW { /** - * Class ARC_GEOM_MANAGER + * ARC_GEOM_MANAGER * * A class to manage the construction of a circular arc though * sequential setting of critical points: centre, arc start diff --git a/include/preview_items/bright_box.h b/include/preview_items/bright_box.h index 2af9beeaa7..701fc8f889 100644 --- a/include/preview_items/bright_box.h +++ b/include/preview_items/bright_box.h @@ -32,7 +32,7 @@ #include /** - * Class BRIGHT_BOX + * BRIGHT_BOX * * Draws a decoration to indicate a brightened item. */ diff --git a/include/preview_items/centreline_rect_item.h b/include/preview_items/centreline_rect_item.h index b75a4b5ae2..62a1c4340f 100644 --- a/include/preview_items/centreline_rect_item.h +++ b/include/preview_items/centreline_rect_item.h @@ -40,7 +40,7 @@ namespace PREVIEW class TWO_POINT_GEOMETRY_MANAGER; /** - * Class CENTRELINE_RECT_ITEM + * CENTRELINE_RECT_ITEM * * Represents an area drawn by drawing a rectangle of a given aspect * along a vector, with the midpoiunt of one side on the start point diff --git a/include/preview_items/polygon_item.h b/include/preview_items/polygon_item.h index 67a10f68ef..b999037a59 100644 --- a/include/preview_items/polygon_item.h +++ b/include/preview_items/polygon_item.h @@ -39,7 +39,7 @@ namespace PREVIEW { /** - * Class POLYGON_ITEM + * POLYGON_ITEM * * A preview item which shows an in-progress polygon, which * can be used for zone outlines, etc diff --git a/include/preview_items/ruler_item.h b/include/preview_items/ruler_item.h index e29c8429fc..6018069f05 100644 --- a/include/preview_items/ruler_item.h +++ b/include/preview_items/ruler_item.h @@ -36,7 +36,7 @@ namespace PREVIEW class TWO_POINT_GEOMETRY_MANAGER; /** - * Class RULER_ITEM + * RULER_ITEM * * A drawn ruler item for showing the distance between two points. */ diff --git a/include/preview_items/selection_area.h b/include/preview_items/selection_area.h index ea0239e45d..237bb9ae7a 100644 --- a/include/preview_items/selection_area.h +++ b/include/preview_items/selection_area.h @@ -36,7 +36,7 @@ namespace PREVIEW { /** - * Class SELECTION_AREA + * SELECTION_AREA * * Represents a selection area (currently a rectangle) in a VIEW, * drawn corner-to-corner between two points. This is useful when diff --git a/include/preview_items/simple_overlay_item.h b/include/preview_items/simple_overlay_item.h index 5ae64d961b..54dc5c8d19 100644 --- a/include/preview_items/simple_overlay_item.h +++ b/include/preview_items/simple_overlay_item.h @@ -67,7 +67,7 @@ public: * Draws the preview - this is done by calling the two functions: * setupGal() and drawPreviewShape(). If you need more than this, * or direct access to the VIEW, you probably should make a new - * class. + *. */ void ViewDraw( int aLayer, KIGFX::VIEW* aView ) const override; diff --git a/include/preview_items/two_point_geom_manager.h b/include/preview_items/two_point_geom_manager.h index 00f0002fc5..c98c7be3f1 100644 --- a/include/preview_items/two_point_geom_manager.h +++ b/include/preview_items/two_point_geom_manager.h @@ -35,7 +35,7 @@ namespace PREVIEW { /** - * Class TWO_POINT_GEOMETRY_MANAGER + * TWO_POINT_GEOMETRY_MANAGER * * Represents a very simple geometry manager for items that have * a start and end point. diff --git a/include/printout.h b/include/printout.h index ee86c4f9e1..7fae8b2458 100644 --- a/include/printout.h +++ b/include/printout.h @@ -24,7 +24,7 @@ class wxConfigBase; /** - * Class PRINT_PARAMETERS + * PRINT_PARAMETERS * handles the parameters used to print a board drawing. */ struct PRINTOUT_SETTINGS diff --git a/include/project.h b/include/project.h index 7327e53750..ee17ff00dc 100644 --- a/include/project.h +++ b/include/project.h @@ -50,7 +50,7 @@ class FILENAME_RESOLVER; #define VTBL_ENTRY virtual /** - * Class PROJECT + * PROJECT * holds project specific data. Because it is in the neutral program top, which * is not linked to by subsidiarly DSOs, any functions in this interface must * be VTBL_ENTRYs. diff --git a/include/properties.h b/include/properties.h index 66043da3b5..6cb37cb3a5 100644 --- a/include/properties.h +++ b/include/properties.h @@ -27,7 +27,7 @@ /** - * Class PROPERTIES + * PROPERTIES * is a name/value tuple with unique names and optional values. The names * may be iterated alphabetically. */ diff --git a/include/reporter.h b/include/reporter.h index 8d2a8fa670..7fcf1b11a5 100644 --- a/include/reporter.h +++ b/include/reporter.h @@ -40,7 +40,7 @@ class WX_HTML_REPORT_PANEL; /** - * Class REPORTER + * REPORTER * is a pure virtual class used to derive REPORTER objects from. * * The purpose of the REPORTER object is to offer a way for a procedural function @@ -138,7 +138,7 @@ public: /** - * Class WX_TEXT_CTRL_REPORTER + * WX_TEXT_CTRL_REPORTER * is wrapper for reporting to a wxTextCtrl object. */ class WX_TEXT_CTRL_REPORTER : public REPORTER @@ -159,7 +159,7 @@ public: /** - * Class WX_STRING_REPORTER + * WX_STRING_REPORTER * is a wrapper for reporting to a wxString object. */ class WX_STRING_REPORTER : public REPORTER @@ -180,7 +180,7 @@ public: /** - * Class WX_HTML_PANEL_REPORTER + * WX_HTML_PANEL_REPORTER * is a wrapper for reporting to a wx HTML window */ class WX_HTML_PANEL_REPORTER : public REPORTER @@ -204,7 +204,7 @@ public: }; /** - * Class NULL_REPORTER + * NULL_REPORTER * * A singleton reporter that reports to nowhere. Used as to simplify code by * avoiding the reportee to check for a non-NULL reporter object. @@ -224,7 +224,7 @@ public: }; /** - * Class STDOUT_REPORTER + * STDOUT_REPORTER * * Debug type reporter, forwarding messages to std::cout. */ diff --git a/include/richio.h b/include/richio.h index 521b513eb8..b48d8d0f4d 100644 --- a/include/richio.h +++ b/include/richio.h @@ -74,7 +74,7 @@ std::string #define LINE_READER_LINE_INITIAL_SIZE 5000 /** - * Class LINE_READER + * LINE_READER * is an abstract class from which implementation specific LINE_READERs may * be derived to read single lines of text and manage a line number counter. */ @@ -173,7 +173,7 @@ public: /** - * Class FILE_LINE_READER + * FILE_LINE_READER * is a LINE_READER that reads from an open file. File must be already open * so that this class can exist without any UI policy. */ @@ -248,7 +248,7 @@ public: /** - * Class STRING_LINE_READER + * STRING_LINE_READER * is a LINE_READER that reads from a multiline 8 bit wide std::string */ class STRING_LINE_READER : public LINE_READER @@ -284,7 +284,7 @@ public: /** - * Class INPUTSTREAM_LINE_READER + * INPUTSTREAM_LINE_READER * is a LINE_READER that reads from a wxInputStream object. */ class INPUTSTREAM_LINE_READER : public LINE_READER @@ -309,7 +309,7 @@ public: #define OUTPUTFMTBUFZ 500 ///< default buffer size for any OUTPUT_FORMATTER /** - * Class OUTPUTFORMATTER + * OUTPUTFORMATTER * is an important interface (abstract class) used to output 8 bit text in * a convenient way. The primary interface is "printf() - like" but * with support for indentation control. The destination of the 8 bit @@ -438,7 +438,7 @@ public: /** - * Class STRING_FORMATTER + * STRING_FORMATTER * implements OUTPUTFORMATTER to a memory buffer. After Print()ing the * string is available through GetString() */ @@ -485,7 +485,7 @@ protected: /** - * Class FILE_OUTPUTFORMATTER + * FILE_OUTPUTFORMATTER * may be used for text file output. It is about 8 times faster than * STREAM_OUTPUTFORMATTER for file streams. */ @@ -519,7 +519,7 @@ protected: /** - * Class STREAM_OUTPUTFORMATTER + * STREAM_OUTPUTFORMATTER * implements OUTPUTFORMATTER to a wxWidgets wxOutputStream. The stream is * neither opened nor closed by this class. */ diff --git a/include/search_stack.h b/include/search_stack.h index 33067757af..8c72f7c10a 100644 --- a/include/search_stack.h +++ b/include/search_stack.h @@ -32,7 +32,7 @@ /** - * Class SEARCH_STACK + * SEARCH_STACK * looks for files in a number of places. Augments wxPathList. * I chose the name because it sounded like a stack of work, as a reminder * that anything you put in here means searching work at some point in time. diff --git a/include/status_popup.h b/include/status_popup.h index e98000cc4d..6a4e9cb2fa 100644 --- a/include/status_popup.h +++ b/include/status_popup.h @@ -33,7 +33,7 @@ class EDA_DRAW_FRAME; /** - * Class STATUS_POPUP + * STATUS_POPUP * * A tiny, headerless popup window used to display useful status (e.g. line length * tuning info) next to the mouse cursor. @@ -72,7 +72,7 @@ protected: /** - * Class STATUS_TEXT_POPUP + * STATUS_TEXT_POPUP * * Extension of STATUS_POPUP, displaying a single line text. */ diff --git a/include/title_block.h b/include/title_block.h index 7c76813c9d..b36bc05835 100644 --- a/include/title_block.h +++ b/include/title_block.h @@ -31,7 +31,7 @@ class OUTPUTFORMATTER; /** - * Class TITLE_BLOCK + * TITLE_BLOCK * holds the information shown in the lower right corner of a plot, printout, or * editing view. * diff --git a/include/tool/action_manager.h b/include/tool/action_manager.h index 2295afa3f9..e82d243aa4 100644 --- a/include/tool/action_manager.h +++ b/include/tool/action_manager.h @@ -34,7 +34,7 @@ class TOOL_MANAGER; class TOOL_ACTION; /** - * Class ACTION_MANAGER + * ACTION_MANAGER * * Takes care of TOOL_ACTION objects. Registers them and allows one to run them * using associated hot keys, names or ids. diff --git a/include/tool/action_menu.h b/include/tool/action_menu.h index e318b3cb65..832be8746f 100644 --- a/include/tool/action_menu.h +++ b/include/tool/action_menu.h @@ -36,7 +36,7 @@ class TOOL_INTERACTIVE; /** - * Class ACTION_MENU + * ACTION_MENU * * Defines the structure of a menu based on ACTIONs. */ diff --git a/include/tool/action_toolbar.h b/include/tool/action_toolbar.h index 3258962b69..6be31170ed 100644 --- a/include/tool/action_toolbar.h +++ b/include/tool/action_toolbar.h @@ -34,7 +34,7 @@ class TOOL_MANAGER; class TOOL_ACTION; /** - * Class ACTION_TOOLBAR + * ACTION_TOOLBAR * * Defines the structure of a toolbar with buttons that invoke ACTIONs. */ diff --git a/include/tool/actions.h b/include/tool/actions.h index 60829934cb..cd309bf6e4 100644 --- a/include/tool/actions.h +++ b/include/tool/actions.h @@ -35,7 +35,7 @@ class TOOL_MANAGER; #define LEGACY_HK_NAME( x ) x /** - * Class ACTIONS + * ACTIONS * * Gathers all the actions that are shared by tools. The instance of a subclass of * ACTIONS is created inside of ACTION_MANAGER object that registers the actions. @@ -187,7 +187,7 @@ public: /** - * Class EVENTS + * EVENTS * * Gathers all the events that are shared by tools. */ diff --git a/include/tool/common_control.h b/include/tool/common_control.h index e0097e42cb..59e87bc61b 100644 --- a/include/tool/common_control.h +++ b/include/tool/common_control.h @@ -29,7 +29,7 @@ class EDA_BASE_FRAME; /** - * Class COMMON_CONTROL + * COMMON_CONTROL * * Handles actions that are shared between different applications */ diff --git a/include/tool/common_tools.h b/include/tool/common_tools.h index a7593ad5db..104ffee3c4 100644 --- a/include/tool/common_tools.h +++ b/include/tool/common_tools.h @@ -30,7 +30,7 @@ class EDA_DRAW_FRAME; /** - * Class COMMON_TOOLS + * COMMON_TOOLS * * Handles actions that are shared between different applications */ diff --git a/include/tool/edit_constraints.h b/include/tool/edit_constraints.h index 627c25566e..e6caa17ad8 100644 --- a/include/tool/edit_constraints.h +++ b/include/tool/edit_constraints.h @@ -33,7 +33,7 @@ class EDIT_LINE; class EDIT_POINTS; /** - * Class EDIT_CONSTRAINT + * EDIT_CONSTRAINT * * Allows one to describe constraints between two edit handles. After the constrained handle is changed, * Apply() has to be called to fix its coordinates according to the implemented constraint. @@ -74,7 +74,7 @@ protected: /** - * Class EC_VERTICAL. + * EC_VERTICAL. * * EDIT_CONSTRAINT that imposes a constraint that two points have to have the same X coordinate. */ @@ -100,7 +100,7 @@ private: /** - * Class EC_HORIZONTAL. + * EC_HORIZONTAL. * * EDIT_CONSTRAINT that imposes a constraint that two points have to have the same Y coordinate. */ @@ -126,7 +126,7 @@ private: /** - * Class EC_45DEGREE + * EC_45DEGREE * * EDIT_CONSTRAINT that imposes a constraint that two points have to be located at angle of 45 * degree multiplicity. @@ -153,7 +153,7 @@ private: /** - * Class EC_LINE + * EC_LINE * * EDIT_CONSTRAINT that imposes a constraint that a point has to lie on a line (determined * by 2 points). @@ -173,7 +173,7 @@ private: /** - * Class EC_CIRCLE. + * EC_CIRCLE. * * EDIT_CONSTRAINT that imposes a constraint that a point has to lie on a circle. */ @@ -204,7 +204,7 @@ private: /** - * Class EC_CONVERGING + * EC_CONVERGING * * EDIT_CONSTRAINT for 3 segments: dragged and two adjacent ones, enforcing to keep their slopes * and allows only to change ending points. Applied to zones. @@ -239,7 +239,7 @@ private: /** - * Class EC_SNAPLINE + * EC_SNAPLINE * * EDIT_CONSTRAINT for a EDIT_LINE, one of the ends is snapped to a spot determined by a * transform function passed as parameter (e.g. it can be snapped to a grid), instead of having diff --git a/include/tool/edit_points.h b/include/tool/edit_points.h index b82def383f..7c324d3f45 100644 --- a/include/tool/edit_points.h +++ b/include/tool/edit_points.h @@ -38,7 +38,7 @@ #include /** - * Class EDIT_POINT + * EDIT_POINT * * Represents a single point that can be used for modifying items. It is directly related to one * of points in a graphical item (e.g. vertex of a zone or center of a circle). @@ -198,7 +198,7 @@ private: /** - * Class EDIT_LINE + * EDIT_LINE * * Represents a line connecting two EDIT_POINTs. That allows one to move them * both by dragging the EDIT_POINT in the middle. As it uses references to @@ -316,7 +316,7 @@ private: /** - * Class EDIT_POINTS + * EDIT_POINTS * * EDIT_POINTS is a VIEW_ITEM that manages EDIT_POINTs and EDIT_LINEs and draws them. */ diff --git a/include/tool/tool_action.h b/include/tool/tool_action.h index e7de543c2e..edfe7e943f 100644 --- a/include/tool/tool_action.h +++ b/include/tool/tool_action.h @@ -34,7 +34,7 @@ struct BITMAP_OPAQUE; /** - * Class TOOL_ACTION + * TOOL_ACTION * * Represents a single user action. For instance: * - changing layer to top by pressing PgUp diff --git a/include/tool/tool_base.h b/include/tool/tool_base.h index 32727c5a54..185fa2e2dd 100644 --- a/include/tool/tool_base.h +++ b/include/tool/tool_base.h @@ -59,7 +59,7 @@ using TOOL_STATE_FUNC = std::function; /** - * Class TOOL_BASE + * TOOL_BASE * * Base abstract interface for all kinds of tools. */ diff --git a/include/tool/tool_dispatcher.h b/include/tool/tool_dispatcher.h index b1249304cb..582b898cf8 100644 --- a/include/tool/tool_dispatcher.h +++ b/include/tool/tool_dispatcher.h @@ -39,7 +39,7 @@ class VIEW; } /** - * Class TOOL_DISPATCHER + * TOOL_DISPATCHER * * - takes wx events, * - fixes all wx quirks (mouse warping, panning, ordering problems, etc) diff --git a/include/tool/tool_event.h b/include/tool/tool_event.h index 4577a8ef76..fe24587f89 100644 --- a/include/tool/tool_event.h +++ b/include/tool/tool_event.h @@ -164,7 +164,7 @@ enum CONTEXT_MENU_TRIGGER }; /** - * Class TOOL_EVENT + * TOOL_EVENT * * Generic, UI-independent tool event. */ @@ -556,7 +556,7 @@ private: typedef OPT OPT_TOOL_EVENT; /** - * Class TOOL_EVENT_LIST + * TOOL_EVENT_LIST * * A list of TOOL_EVENTs, with overloaded || operators allowing for * concatenating TOOL_EVENTs with little code. diff --git a/include/tool/tool_manager.h b/include/tool/tool_manager.h index 218e83f956..10888b3973 100644 --- a/include/tool/tool_manager.h +++ b/include/tool/tool_manager.h @@ -41,7 +41,7 @@ class EDA_BASE_FRAME; /** - * Class TOOL_MANAGER. + * TOOL_MANAGER. * Master controller class: * - registers editing tools * - pumps UI events to tools requesting them diff --git a/include/tool/tool_menu.h b/include/tool/tool_menu.h index 670eaf16e6..373dec15c2 100644 --- a/include/tool/tool_menu.h +++ b/include/tool/tool_menu.h @@ -33,7 +33,7 @@ class ACTION_MENU; /** - * Class TOOL_MENU + * TOOL_MENU * * Manages a CONDITIONAL_MENU and some number of * CONTEXT_MENUs as sub-menus diff --git a/include/tool/tool_settings.h b/include/tool/tool_settings.h index 59ad96f338..0da9f9582c 100644 --- a/include/tool/tool_settings.h +++ b/include/tool/tool_settings.h @@ -29,7 +29,7 @@ #include /** - * Class TOOL_SETTINGS + * TOOL_SETTINGS * * Manages persistent settings for a tool (just a simple wrapper to wxConfigBase) */ diff --git a/include/undo_redo_container.h b/include/undo_redo_container.h index 30ff280615..0d3d7bb38d 100644 --- a/include/undo_redo_container.h +++ b/include/undo_redo_container.h @@ -118,7 +118,7 @@ public: /** - * Class PICKED_ITEMS_LIST + * PICKED_ITEMS_LIST * is a holder to handle information on schematic or board items. * The information held is a pointer on each item, and the command made. */ @@ -297,7 +297,7 @@ public: /** - * Class UNDO_REDO_CONTAINER + * UNDO_REDO_CONTAINER * is a holder to handle alist of undo (or redo) command. * this class handles a list of ITEM_PICKER (each manage one schematic or board item). */ diff --git a/include/utf8.h b/include/utf8.h index 3360bc85ea..4b528d1c17 100644 --- a/include/utf8.h +++ b/include/utf8.h @@ -49,7 +49,7 @@ bool IsUTF8( const char* aString ); /** - * Class UTF8 + * UTF8 * is an 8 bit string that is assuredly encoded in UTF8, and supplies special * conversion support to and from wxString, to and from std::string, and has * non-mutating iteration over unicode characters. @@ -198,7 +198,7 @@ public: #ifndef SWIG /** - * class uni_iter + * uni_iter * is a non-mutating iterator that walks through unicode code points in the UTF8 encoded * string. The normal ++(), ++(int), ->(), and *() operators are all supported * for read only access and some return an unsigned holding the unicode character diff --git a/include/view/view.h b/include/view/view.h index 9471fe8fbc..636c9e00eb 100644 --- a/include/view/view.h +++ b/include/view/view.h @@ -44,7 +44,7 @@ class VIEW_GROUP; class VIEW_RTREE; /** - * Class VIEW. + * VIEW. * Holds a (potentially large) number of VIEW_ITEMs and renders them on a graphics device * provided by the GAL. VIEWs can exist in two flavors: * - dynamic - where items can be added, removed or changed anytime, intended for the main diff --git a/include/view/view_controls.h b/include/view/view_controls.h index 1e16ae6cf9..cfcc473acc 100644 --- a/include/view/view_controls.h +++ b/include/view/view_controls.h @@ -108,7 +108,7 @@ struct VC_SETTINGS /** - * Class VIEW_CONTROLS + * VIEW_CONTROLS * is an interface for classes handling user events controlling the view behaviour * (such as zooming, panning, mouse grab, etc.) */ diff --git a/include/view/view_item.h b/include/view/view_item.h index 854395c88d..577d59a2d1 100644 --- a/include/view/view_item.h +++ b/include/view/view_item.h @@ -71,7 +71,7 @@ enum VIEW_VISIBILITY_FLAGS { }; /** - * Class VIEW_ITEM - + * VIEW_ITEM - * is an abstract base class for deriving all objects that can be added to a VIEW. * It's role is to: * - communicte geometry, appearance and visibility updates to the associated dynamic VIEW, diff --git a/include/view/view_rtree.h b/include/view/view_rtree.h index 2466f343c9..3f16c8777d 100644 --- a/include/view/view_rtree.h +++ b/include/view/view_rtree.h @@ -34,7 +34,7 @@ namespace KIGFX typedef RTree VIEW_RTREE_BASE; /** - * Class VIEW_RTREE - + * VIEW_RTREE - * Implements an R-tree for fast spatial indexing of VIEW items. * Non-owning. */ diff --git a/include/view/wx_view_controls.h b/include/view/wx_view_controls.h index f3b9a112d4..df896b03e1 100644 --- a/include/view/wx_view_controls.h +++ b/include/view/wx_view_controls.h @@ -45,7 +45,7 @@ namespace KIGFX class ZOOM_CONTROLLER; /** - * Class WX_VIEW_CONTROLS + * WX_VIEW_CONTROLS * is a specific implementation of class VIEW_CONTROLS for wxWidgets library. */ class WX_VIEW_CONTROLS : public VIEW_CONTROLS, public wxEvtHandler diff --git a/include/widgets/indicator_icon.h b/include/widgets/indicator_icon.h index 39c610d8ed..b4c47c1b0a 100644 --- a/include/widgets/indicator_icon.h +++ b/include/widgets/indicator_icon.h @@ -27,7 +27,7 @@ #include /** - * Class representing a row indicator icon for use in + * representing a row indicator icon for use in * places like the layer widget */ class INDICATOR_ICON: public wxPanel diff --git a/include/ws_painter.h b/include/ws_painter.h index cec964f1e7..786380961b 100644 --- a/include/ws_painter.h +++ b/include/ws_painter.h @@ -40,7 +40,7 @@ namespace KIGFX { /** - * Class WS_RENDER_SETTINGS + * WS_RENDER_SETTINGS * Stores page-layout-specific render settings. */ class WS_RENDER_SETTINGS : public RENDER_SETTINGS @@ -89,7 +89,7 @@ private: /** - * Class WS_PAINTER + * WS_PAINTER * Contains methods for drawing worksheet items. */ class WS_PAINTER : public PAINTER diff --git a/include/xnode.h b/include/xnode.h index fce88e3a6f..9c74a30e9d 100644 --- a/include/xnode.h +++ b/include/xnode.h @@ -36,7 +36,7 @@ /** - * Class XNODE + * XNODE * holds an XML or S-expression element. It is used for eXporting * a document tree in EITHER XML or S-expression. */ diff --git a/kicad/pgm_kicad.h b/kicad/pgm_kicad.h index 2a8e234dc8..8eabba5635 100644 --- a/kicad/pgm_kicad.h +++ b/kicad/pgm_kicad.h @@ -31,7 +31,7 @@ /** - * Class PGM_KICAD + * PGM_KICAD * extends PGM_BASE to bring in FileHistory() and PdfBrowser() which were moved * from EDA_APP into KIFACE_I. KIFACE_I is not applicable in the project manager * since it is not a KIFACE. This header is in the kicad directory since nobody diff --git a/kicad/tools/kicad_manager_actions.h b/kicad/tools/kicad_manager_actions.h index 93396b7705..d693f135c6 100644 --- a/kicad/tools/kicad_manager_actions.h +++ b/kicad/tools/kicad_manager_actions.h @@ -33,7 +33,7 @@ class TOOL_EVENT; class TOOL_MANAGER; /** - * Class KICAD_MANAGER_ACTIONS + * KICAD_MANAGER_ACTIONS * */ class KICAD_MANAGER_ACTIONS : public ACTIONS { diff --git a/kicad/tools/kicad_manager_control.h b/kicad/tools/kicad_manager_control.h index 213563b757..c48911ac90 100644 --- a/kicad/tools/kicad_manager_control.h +++ b/kicad/tools/kicad_manager_control.h @@ -32,7 +32,7 @@ class KICAD_MANAGER_FRAME; /** - * Class KICAD_MANAGER_CONTROL + * KICAD_MANAGER_CONTROL * * Handles actions in the kicad manager frame. */ diff --git a/kicad/tree_project_frame.h b/kicad/tree_project_frame.h index 6fc35f4240..d67437fdb4 100644 --- a/kicad/tree_project_frame.h +++ b/kicad/tree_project_frame.h @@ -41,7 +41,7 @@ class KICAD_MANAGER_FRAME; class TREEPROJECT_ITEM; class TREEPROJECTFILES; -/** class TREE_PROJECT_FRAME +/** TREE_PROJECT_FRAME * Window to display the tree files */ class TREE_PROJECT_FRAME : public wxSashLayoutWindow diff --git a/kicad/treeproject_item.h b/kicad/treeproject_item.h index ece6bd24ff..7aeb947878 100644 --- a/kicad/treeproject_item.h +++ b/kicad/treeproject_item.h @@ -32,7 +32,7 @@ /** - * Class TREEPROJECT_ITEM + * TREEPROJECT_ITEM * handles one item (a file or a directory name) for the tree file */ class TREEPROJECT_ITEM : public wxTreeItemData diff --git a/kicad/treeprojectfiles.h b/kicad/treeprojectfiles.h index adfe100fa8..98149e8c55 100644 --- a/kicad/treeprojectfiles.h +++ b/kicad/treeprojectfiles.h @@ -35,7 +35,7 @@ #include "kicad_manager_frame.h" -/** Class TREEPROJECTFILES +/** TREEPROJECTFILES * This is the class to show (as a tree) the files in the project directory */ class TREEPROJECTFILES : public wxTreeCtrl diff --git a/libs/kimath/include/geometry/direction45.h b/libs/kimath/include/geometry/direction45.h index 5f3ff3298e..360f75f19f 100644 --- a/libs/kimath/include/geometry/direction45.h +++ b/libs/kimath/include/geometry/direction45.h @@ -30,7 +30,7 @@ #undef Opposite /** - * Class DIRECTION_45. + * DIRECTION_45. * Represents route directions & corner angles in a 45-degree metric. */ diff --git a/libs/kimath/include/geometry/poly_grid_partition.h b/libs/kimath/include/geometry/poly_grid_partition.h index b78527d7db..469f042b30 100644 --- a/libs/kimath/include/geometry/poly_grid_partition.h +++ b/libs/kimath/include/geometry/poly_grid_partition.h @@ -39,7 +39,7 @@ #include /** - * Class POLY_GRID_PARTITION + * POLY_GRID_PARTITION * * Provides a fast test for point inside polygon by splitting the edges * of the polygon into a rectangular grid. diff --git a/libs/kimath/include/geometry/shape.h b/libs/kimath/include/geometry/shape.h index 12f0327419..aa9492adb6 100644 --- a/libs/kimath/include/geometry/shape.h +++ b/libs/kimath/include/geometry/shape.h @@ -53,7 +53,7 @@ enum SHAPE_TYPE }; /** - * Class SHAPE + * SHAPE * * Represents an abstract shape on 2D plane. */ diff --git a/libs/kimath/include/geometry/shape_file_io.h b/libs/kimath/include/geometry/shape_file_io.h index 89e558023c..46930d8ab8 100644 --- a/libs/kimath/include/geometry/shape_file_io.h +++ b/libs/kimath/include/geometry/shape_file_io.h @@ -32,7 +32,7 @@ class SHAPE; /** - * Class SHAPE_FILE_IO + * SHAPE_FILE_IO * * Helper class for saving/loading shapes from a file. */ diff --git a/libs/kimath/include/geometry/shape_line_chain.h b/libs/kimath/include/geometry/shape_line_chain.h index 4948a34915..73fc0d8adb 100644 --- a/libs/kimath/include/geometry/shape_line_chain.h +++ b/libs/kimath/include/geometry/shape_line_chain.h @@ -42,11 +42,11 @@ /** - * Class SHAPE_LINE_CHAIN + * SHAPE_LINE_CHAIN * * Represents a polyline (an zero-thickness chain of connected line segments). * I purposedly didn't name it "polyline" to avoid confusion with the existing CPolyLine - * class in pcbnew. + * in pcbnew. * * SHAPE_LINE_CHAIN class shall not be used for polygons! */ diff --git a/libs/kimath/include/geometry/shape_poly_set.h b/libs/kimath/include/geometry/shape_poly_set.h index 641ee76dff..95d4488983 100644 --- a/libs/kimath/include/geometry/shape_poly_set.h +++ b/libs/kimath/include/geometry/shape_poly_set.h @@ -45,7 +45,7 @@ /** - * Class SHAPE_POLY_SET + * SHAPE_POLY_SET * * Represents a set of closed polygons. Polygons may be nonconvex, self-intersecting * and have holes. Provides boolean operations (using Clipper library as the backend). @@ -144,7 +144,7 @@ class SHAPE_POLY_SET : public SHAPE } VERTEX_INDEX; /** - * Class ITERATOR_TEMPLATE + * ITERATOR_TEMPLATE * * Base class for iterating over all vertices in a given SHAPE_POLY_SET. */ @@ -282,7 +282,7 @@ class SHAPE_POLY_SET : public SHAPE }; /** - * Class SEGMENT_ITERATOR_TEMPLATE + * SEGMENT_ITERATOR_TEMPLATE * * Base class for iterating over all segments in a given SHAPE_POLY_SET. */ diff --git a/libs/kimath/include/geometry/shape_simple.h b/libs/kimath/include/geometry/shape_simple.h index 904c02167d..a9a9027cf2 100644 --- a/libs/kimath/include/geometry/shape_simple.h +++ b/libs/kimath/include/geometry/shape_simple.h @@ -31,7 +31,7 @@ #include /** - * Class SHAPE_SIMPLE + * SHAPE_SIMPLE * * Represents a simple polygon consisting of a zero-thickness closed chain of * connected line segments. diff --git a/libs/kimath/include/math/box2.h b/libs/kimath/include/math/box2.h index 3d099afb50..7c0ce9008c 100644 --- a/libs/kimath/include/math/box2.h +++ b/libs/kimath/include/math/box2.h @@ -34,7 +34,7 @@ #include /** - * Class BOX2 + * BOX2 * handles a 2-D bounding box, built on top of an origin point * and size vector, both of templated class Vec */ diff --git a/libs/kimath/include/math/matrix3x3.h b/libs/kimath/include/math/matrix3x3.h index 7719cb36d5..2e2bbb85a3 100644 --- a/libs/kimath/include/math/matrix3x3.h +++ b/libs/kimath/include/math/matrix3x3.h @@ -30,7 +30,7 @@ #include /** - * Class MATRIX3x3 describes a general 3x3 matrix. + * MATRIX3x3 describes a general 3x3 matrix. * * Any linear transformation in 2D can be represented * by a homogeneous 3x3 transformation matrix. Given a vector x, the linear transformation diff --git a/libs/kimath/include/math/vector2d.h b/libs/kimath/include/math/vector2d.h index 28b3acf264..d34db0f9f7 100644 --- a/libs/kimath/include/math/vector2d.h +++ b/libs/kimath/include/math/vector2d.h @@ -39,7 +39,7 @@ #endif /** - * Class VECTOR2_TRAITS + * VECTOR2_TRAITS * traits class for VECTOR2. */ template @@ -63,7 +63,7 @@ template std::ostream& operator<<( std::ostream& aStream, const VECTOR2& aVector ); /** - * Class VECTOR2 + * VECTOR2 * defines a general 2D-vector/point. * * This class uses templates to be universal. Several operators are provided to help diff --git a/new/design.h b/new/design.h index 3b3e4b0802..e266def61f 100644 --- a/new/design.h +++ b/new/design.h @@ -360,7 +360,7 @@ library in the new design is LIB. /** - * Class HTTP_LIB_SOURCE + * HTTP_LIB_SOURCE * implements a LIB_SOURCE to access a remote document root repository using http protocol. */ class HTTP_LIB_SOURCE : public LIB_SOURCE @@ -387,7 +387,7 @@ protected: /** - * Class SVN_LIB_SOURCE + * SVN_LIB_SOURCE * implements a LIB_SOURCE to access a [remote or local] subversion repository * using subversion client protocol. */ @@ -415,7 +415,7 @@ protected: /** - * Class SCHEMATIC_LIB_SOURCE + * SCHEMATIC_LIB_SOURCE * implements a LIB_SOURCE in by reading a parts list from schematic file * unrelated to the schematic currently being edited. */ @@ -444,7 +444,7 @@ protected: /** - * Class PARTS_LIST + * PARTS_LIST * is a LIB which resides in a SCHEMATIC, and it is a table model for a * spread sheet both. When columns are added or removed to/from the spreadsheet, * this is adding or removing fields/properties to/from ALL the contained PARTS. diff --git a/new/sch_dir_lib_source.cpp b/new/sch_dir_lib_source.cpp index 4d422a5356..1e959cff2e 100644 --- a/new/sch_dir_lib_source.cpp +++ b/new/sch_dir_lib_source.cpp @@ -57,7 +57,7 @@ using namespace SCH; /** - * Class DIR_WRAP + * DIR_WRAP * provides a destructor which is invoked if an exception is thrown. */ class DIR_WRAP @@ -80,7 +80,7 @@ public: /** - * Class FILE_WRAP + * FILE_WRAP * provides a destructor which is invoked if an exception is thrown. */ class FILE_WRAP diff --git a/new/sch_dir_lib_source.h b/new/sch_dir_lib_source.h index b5a172c528..a2ab86bf9d 100644 --- a/new/sch_dir_lib_source.h +++ b/new/sch_dir_lib_source.h @@ -69,7 +69,7 @@ typedef std::set< STRING > NAME_CACHE; namespace SCH { /** - * Class DIR_LIB_SOURCE + * DIR_LIB_SOURCE * implements a LIB_SOURCE in a file system directory. * * @author Dick Hollenbeck diff --git a/new/sch_lib.cpp b/new/sch_lib.cpp index f9df194fb3..7390690ea6 100644 --- a/new/sch_lib.cpp +++ b/new/sch_lib.cpp @@ -70,7 +70,7 @@ struct LTREV /** - * Class PART_REVS + * PART_REVS * contains the collection of revisions for a particular part name, in the * form of cached PARTs. The tuple consists of a rev string and a PART pointer. * The rev string is like "rev1", the PART pointer will be NULL until the PART @@ -90,7 +90,7 @@ public: /** - * Class PARTS + * PARTS * contains the collection of PART_REVS for all PARTs in the lib. * The tuple consists of a part name and a PART_REVS pointer. * The part name does not have the revision attached (of course this is understood diff --git a/new/sch_lib.h b/new/sch_lib.h index 2801d16c78..942f34512b 100644 --- a/new/sch_lib.h +++ b/new/sch_lib.h @@ -37,7 +37,7 @@ class PART; class LIB_TABLE; /** - * Class LIB_SOURCE + * LIB_SOURCE * is an abstract class from which implementation specific LIB_SOURCEs * may be derived, one for each kind of library type allowed in the library table. * The class name stems from the fact that this interface only provides READ ONLY @@ -138,7 +138,7 @@ protected: /** - * Class LIB_SINK + * LIB_SINK * is an abstract class from which implementation specific LIB_SINKs * may be derived, one for each kind of library type in the library table that * supports writing. The class name stems from the fact that this interface @@ -185,7 +185,7 @@ class PARTS; /** - * Class LIB + * LIB * is a cache of parts, and because the LIB_SOURCE is abstracted, there * should be no need to extend from this class in any case except for the * PARTS_LIST. diff --git a/new/sch_lib_table.h b/new/sch_lib_table.h index dc7c899947..79386edd51 100644 --- a/new/sch_lib_table.h +++ b/new/sch_lib_table.h @@ -41,7 +41,7 @@ class LPID; class PART; /** - * Class LIB_TABLE + * LIB_TABLE * holds LIB_TABLE::ROW records, and can be searched in a very high speed * way based on logical library name. *

@@ -87,7 +87,7 @@ class MY_API LIB_TABLE public: /** - * Class ROW + * ROW * holds a record identifying a LIB in the LIB_TABLE. */ class ROW diff --git a/new/sch_lpid.h b/new/sch_lpid.h index 97fdf77ca2..45a84db593 100644 --- a/new/sch_lpid.h +++ b/new/sch_lpid.h @@ -32,7 +32,7 @@ namespace SCH { /** - * Class LPID + * LPID * (aka GUID) is a Logical Part ID and consists of various portions much like a URI. * It is a container for the separated portions of a logical part id STRING so they * can be accessed individually. The various portions of an LPID are: diff --git a/new/sch_part.h b/new/sch_part.h index ea0bb55423..d57163b873 100644 --- a/new/sch_part.h +++ b/new/sch_part.h @@ -132,7 +132,7 @@ typedef boost::ptr_map< wxString, MERGE_SET > MERGE_SETS; /** - * Class FONTZ + * FONTZ * is the size of a font, and comes with a constructor which initializes * height and width to special values which defer font size decision to * a higher control. @@ -583,7 +583,7 @@ protected: /** - * Class PART_REF + * PART_REF * is an LPID with a pointer to the "looked up" PART, which is looked up lazily. */ class PART_REF : public LPID @@ -651,7 +651,7 @@ class SWEET_PARSER; /** - * Class PART + * PART * will have to be unified with what Wayne is doing. I want a separate copy * here until I can get the state management correct. Since a PART only lives @@ -669,7 +669,7 @@ public: /** * Enum PROP_ID * is the set of "mandatory" properties within a PART. These are used by - * class PART as array indices into PART::mandatory[]. + * PART as array indices into PART::mandatory[]. */ enum PROP_ID { diff --git a/new/sch_sweet_parser.h b/new/sch_sweet_parser.h index d5424f936e..7dd9057365 100644 --- a/new/sch_sweet_parser.h +++ b/new/sch_sweet_parser.h @@ -54,7 +54,7 @@ struct TEXT_EFFECTS; /** - * Class SWEET_PARSER + * SWEET_PARSER * scans a Sweet string as input and stuffs a PART. *

* Most functions in this class throw IO_ERROR and PARSE_ERROR. The IO_ERROR can diff --git a/new/sweet_edit.cpp b/new/sweet_edit.cpp index 86c2039f52..fe18a33f39 100644 --- a/new/sweet_edit.cpp +++ b/new/sweet_edit.cpp @@ -49,7 +49,7 @@ /** - * Class SWEET_EDIT + * SWEET_EDIT * implements an editor for SWEET, including support for inheritance and * LIB_TABLE configuration. */ diff --git a/pagelayout_editor/design_inspector.h b/pagelayout_editor/design_inspector.h index 96c55e3330..aa705b71a6 100644 --- a/pagelayout_editor/design_inspector.h +++ b/pagelayout_editor/design_inspector.h @@ -32,7 +32,7 @@ /** - * Class DESIGN_INSPECTOR is the left window showing the list of items + * DESIGN_INSPECTOR is the left window showing the list of items */ class DIALOG_INSPECTOR : public DIALOG_INSPECTOR_BASE diff --git a/pagelayout_editor/pl_editor_frame.h b/pagelayout_editor/pl_editor_frame.h index 9985b6db3f..c245d2c46d 100644 --- a/pagelayout_editor/pl_editor_frame.h +++ b/pagelayout_editor/pl_editor_frame.h @@ -38,7 +38,7 @@ class WS_DATA_ITEM; /** - * Class PL_EDITOR_FRAME + * PL_EDITOR_FRAME * is the main window used in the page layout editor. */ diff --git a/pagelayout_editor/pl_editor_layout.h b/pagelayout_editor/pl_editor_layout.h index c98468b0ab..df03f6ccda 100644 --- a/pagelayout_editor/pl_editor_layout.h +++ b/pagelayout_editor/pl_editor_layout.h @@ -35,7 +35,7 @@ /** - * Class PL_EDITOR_LAYOUT + * PL_EDITOR_LAYOUT */ class PL_EDITOR_LAYOUT { diff --git a/pagelayout_editor/properties_frame.h b/pagelayout_editor/properties_frame.h index e45505a1c2..f555a476f0 100644 --- a/pagelayout_editor/properties_frame.h +++ b/pagelayout_editor/properties_frame.h @@ -35,7 +35,7 @@ class WS_DATA_ITEM; /** - * Class PROPERTIES_FRAME display properties of the current item. + * PROPERTIES_FRAME display properties of the current item. */ class PROPERTIES_FRAME : public PANEL_PROPERTIES_BASE diff --git a/pagelayout_editor/tools/pl_actions.h b/pagelayout_editor/tools/pl_actions.h index 381fab5b65..03f89c0f3d 100644 --- a/pagelayout_editor/tools/pl_actions.h +++ b/pagelayout_editor/tools/pl_actions.h @@ -33,7 +33,7 @@ class TOOL_EVENT; class TOOL_MANAGER; /** - * Class PL_ACTIONS + * PL_ACTIONS * * Gathers all the actions that are shared by tools. The instance of PL_ACTIONS is created * inside of ACTION_MANAGER object that registers the actions. diff --git a/pagelayout_editor/tools/pl_drawing_tools.h b/pagelayout_editor/tools/pl_drawing_tools.h index cf5f91a740..869905e671 100644 --- a/pagelayout_editor/tools/pl_drawing_tools.h +++ b/pagelayout_editor/tools/pl_drawing_tools.h @@ -34,7 +34,7 @@ class PL_SELECTION_TOOL; /** - * Class PL_DRAWING_TOOLS + * PL_DRAWING_TOOLS * * Tool responsible for drawing/placing items (lines, rectangles, text, etc.) */ diff --git a/pagelayout_editor/tools/pl_editor_control.h b/pagelayout_editor/tools/pl_editor_control.h index 66ce391601..73f39d8201 100644 --- a/pagelayout_editor/tools/pl_editor_control.h +++ b/pagelayout_editor/tools/pl_editor_control.h @@ -32,7 +32,7 @@ class PL_EDITOR_FRAME; /** - * Class PL_EDITOR_CONTROL + * PL_EDITOR_CONTROL * * Handles actions specific to the schematic editor in eeschema. */ diff --git a/pagelayout_editor/tools/pl_point_editor.h b/pagelayout_editor/tools/pl_point_editor.h index 8a9e5bd6b4..5fa08240bd 100644 --- a/pagelayout_editor/tools/pl_point_editor.h +++ b/pagelayout_editor/tools/pl_point_editor.h @@ -34,7 +34,7 @@ class PL_SELECTION_TOOL; class PL_EDITOR_FRAME; /** - * Class PL_POINT_EDITOR + * PL_POINT_EDITOR * * Tool that displays edit points allowing to modify items by dragging the points. */ diff --git a/pcb_calculator/datafile_read_write.h b/pcb_calculator/datafile_read_write.h index 8326309300..219aa44cda 100644 --- a/pcb_calculator/datafile_read_write.h +++ b/pcb_calculator/datafile_read_write.h @@ -26,7 +26,7 @@ class PCB_CALCULATOR_DATAFILE_PARSER; /** - * Class PCB_CALCULATOR_DATAFILE + * PCB_CALCULATOR_DATAFILE * handles data to calculate regulators parameters */ class PCB_CALCULATOR_DATAFILE @@ -45,7 +45,7 @@ public: /** - * Class PCB_CALCULATOR_DATAFILE_PARSER + * PCB_CALCULATOR_DATAFILE_PARSER * is the parser class for PCB_CALCULATOR_DATAFILE. */ class PCB_CALCULATOR_DATAFILE_PARSER : public PCB_CALCULATOR_DATAFILE_LEXER diff --git a/pcb_calculator/transline_ident.cpp b/pcb_calculator/transline_ident.cpp index 90bff3f623..149a4bbd68 100644 --- a/pcb_calculator/transline_ident.cpp +++ b/pcb_calculator/transline_ident.cpp @@ -50,7 +50,7 @@ /* - * class TRANSLINE_PRM + * TRANSLINE_PRM * A class to handle one parameter of transline */ TRANSLINE_PRM::TRANSLINE_PRM( PRM_TYPE aType, PRMS_ID aId, @@ -121,7 +121,7 @@ double TRANSLINE_PRM::FromUserUnit() /* - * class TRANSLINE_IDENT + * TRANSLINE_IDENT * A class to handle a list of parameters of a given transline */ diff --git a/pcbnew/action_plugin.h b/pcbnew/action_plugin.h index 8bb6c9c4aa..aa2df37e82 100644 --- a/pcbnew/action_plugin.h +++ b/pcbnew/action_plugin.h @@ -33,7 +33,7 @@ #include /** - * Class ACTION_PLUGIN + * ACTION_PLUGIN * This is the parent class from where any action plugin class must * derive */ @@ -116,7 +116,7 @@ public: /** - * Class ACTION_PLUGINS + * ACTION_PLUGINS * Mainly static. Storing all plugins informations. */ class ACTION_PLUGINS diff --git a/pcbnew/autorouter/ar_matrix.h b/pcbnew/autorouter/ar_matrix.h index e673e3a05a..db01f37ae5 100644 --- a/pcbnew/autorouter/ar_matrix.h +++ b/pcbnew/autorouter/ar_matrix.h @@ -43,7 +43,7 @@ class MODULE; #define AR_SIDE_BOTTOM 1 /** - * class AR_MATRIX + * AR_MATRIX * handle the matrix routing that describes the actual board */ class AR_MATRIX diff --git a/pcbnew/autorouter/autoplacer_tool.h b/pcbnew/autorouter/autoplacer_tool.h index 00c5364199..c8af588eb5 100644 --- a/pcbnew/autorouter/autoplacer_tool.h +++ b/pcbnew/autorouter/autoplacer_tool.h @@ -28,7 +28,7 @@ /** - * Class AUTOPLACE_TOOL + * AUTOPLACE_TOOL * * Tool responsible for automagic placement of components. */ diff --git a/pcbnew/board_connected_item.h b/pcbnew/board_connected_item.h index dca49511c7..d7edaf303a 100644 --- a/pcbnew/board_connected_item.h +++ b/pcbnew/board_connected_item.h @@ -35,7 +35,7 @@ class TRACK; class D_PAD; /** - * Class BOARD_CONNECTED_ITEM + * BOARD_CONNECTED_ITEM * is a base class derived from BOARD_ITEM for items that can be connected * and have a net, a netname, a clearance ... * mainly: tracks, pads and zones diff --git a/pcbnew/class_board.h b/pcbnew/class_board.h index db51c20544..9d2a565faf 100644 --- a/pcbnew/class_board.h +++ b/pcbnew/class_board.h @@ -73,7 +73,7 @@ enum LAYER_T /** - * Class LAYER + * LAYER * holds information pertinent to a layer of a BOARD. */ struct LAYER @@ -154,7 +154,7 @@ DECL_DEQ_FOR_SWIG( TRACKS, TRACK* ) /** - * Class BOARD + * BOARD * holds information pertinent to a Pcbnew printed circuit board. */ class BOARD : public BOARD_ITEM_CONTAINER diff --git a/pcbnew/class_dimension.h b/pcbnew/class_dimension.h index 1a41073f8c..06ddce88bb 100644 --- a/pcbnew/class_dimension.h +++ b/pcbnew/class_dimension.h @@ -41,7 +41,7 @@ class MSG_PANEL_ITEM; /** - * Class DIMENSION + * DIMENSION * * For better understanding of the points that make a dimension: * diff --git a/pcbnew/class_zone.h b/pcbnew/class_zone.h index c223512fd5..970cb1f08f 100644 --- a/pcbnew/class_zone.h +++ b/pcbnew/class_zone.h @@ -49,7 +49,7 @@ class MSG_PANEL_ITEM; typedef std::vector ZONE_SEGMENT_FILL; /** - * Class ZONE_CONTAINER + * ZONE_CONTAINER * handles a list of polygons defining a copper zone. * A zone is described by a main polygon, a time stamp, a layer or a lyer set, and a net name. * Other polygons inside the main polygon are holes in the zone. diff --git a/pcbnew/connectivity/connectivity_rtree.h b/pcbnew/connectivity/connectivity_rtree.h index 1bab9b3cfb..c57a566b8b 100644 --- a/pcbnew/connectivity/connectivity_rtree.h +++ b/pcbnew/connectivity/connectivity_rtree.h @@ -31,7 +31,7 @@ /** - * Class CN_RTREE - + * CN_RTREE - * Implements an R-tree for fast spatial indexing of connectivity items. * Non-owning. */ diff --git a/pcbnew/dialogs/dialog_board_statistics.h b/pcbnew/dialogs/dialog_board_statistics.h index b44b593481..946c247ab4 100644 --- a/pcbnew/dialogs/dialog_board_statistics.h +++ b/pcbnew/dialogs/dialog_board_statistics.h @@ -40,7 +40,7 @@ #include /** - * Class DIALOG_BOARD_STATISTIC + * DIALOG_BOARD_STATISTIC * * Dialog to show common board info. */ diff --git a/pcbnew/dialogs/dialog_drclistbox.h b/pcbnew/dialogs/dialog_drclistbox.h index e87fc645b1..9480a22417 100644 --- a/pcbnew/dialogs/dialog_drclistbox.h +++ b/pcbnew/dialogs/dialog_drclistbox.h @@ -36,7 +36,7 @@ /** - * Class DRC_LIST_MARKERS + * DRC_LIST_MARKERS * is an implementation of the interface named DRC_ITEM_LIST which uses * a BOARD instance to fulfill the interface. No ownership is taken of the * BOARD. @@ -96,7 +96,7 @@ public: /** - * Class DRC_LIST_GENERIC + * DRC_LIST_GENERIC * is an implementation of the interface named DRC_ITEM_LIST which uses * a vector of pointers to DRC_ITEMs to fulfill the interface. No ownership is taken of the * vector, which will reside in class DRC @@ -171,7 +171,7 @@ public: /** - * Class DRCLISTBOX + * DRCLISTBOX * is used to display a DRC_ITEM_LIST. */ class DRCLISTBOX : public wxHtmlListBox diff --git a/pcbnew/dialogs/dialog_fp_plugin_options.cpp b/pcbnew/dialogs/dialog_fp_plugin_options.cpp index 9fe65ee170..613230fe93 100644 --- a/pcbnew/dialogs/dialog_fp_plugin_options.cpp +++ b/pcbnew/dialogs/dialog_fp_plugin_options.cpp @@ -41,7 +41,7 @@ using std::string; /** - * Class DIALOG_FP_PLUGIN_OPTIONS + * DIALOG_FP_PLUGIN_OPTIONS * is an options editor in the form of a two column name/value * spreadsheet like (table) UI. It takes hints from a pcbnew PLUGIN as to * supported options. diff --git a/pcbnew/dialogs/dialog_pad_properties.h b/pcbnew/dialogs/dialog_pad_properties.h index 3dab9dfa50..c76d6fdc6b 100644 --- a/pcbnew/dialogs/dialog_pad_properties.h +++ b/pcbnew/dialogs/dialog_pad_properties.h @@ -41,7 +41,7 @@ #include /** - * class DIALOG_PAD_PROPERTIES, derived from DIALOG_PAD_PROPERTIES_BASE, + * DIALOG_PAD_PROPERTIES, derived from DIALOG_PAD_PROPERTIES_BASE, * created by wxFormBuilder */ class DIALOG_PAD_PROPERTIES : public DIALOG_PAD_PROPERTIES_BASE diff --git a/pcbnew/dialogs/dialog_plot.h b/pcbnew/dialogs/dialog_plot.h index a1c56a641f..794391aeb0 100644 --- a/pcbnew/dialogs/dialog_plot.h +++ b/pcbnew/dialogs/dialog_plot.h @@ -34,7 +34,7 @@ #define DLG_WINDOW_NAME "plot_dialog-window" /** - * Class DIALOG_PLOT is the dialog to set the plot options, and create plot files + * DIALOG_PLOT is the dialog to set the plot options, and create plot files * in various formats. */ class DIALOG_PLOT : public DIALOG_PLOT_BASE diff --git a/pcbnew/drc/drc_provider.h b/pcbnew/drc/drc_provider.h index 65080d0445..04ecda0caa 100644 --- a/pcbnew/drc/drc_provider.h +++ b/pcbnew/drc/drc_provider.h @@ -34,7 +34,7 @@ /** - * Class that represents a DRC "provider" which runs some + * that represents a DRC "provider" which runs some * DRC functions over a #BOARD and spits out #PCB_MARKERs as needed. */ class DRC_PROVIDER diff --git a/pcbnew/eagle_plugin.h b/pcbnew/eagle_plugin.h index fbe2901f85..82c9f1de3e 100644 --- a/pcbnew/eagle_plugin.h +++ b/pcbnew/eagle_plugin.h @@ -110,7 +110,7 @@ struct ERULES }; /** - * Class EAGLE_PLUGIN + * EAGLE_PLUGIN * works with Eagle 6.x XML board files and footprints to implement the * Pcbnew PLUGIN API, or a portion of it. */ diff --git a/pcbnew/exporters/gerber_jobfile_writer.h b/pcbnew/exporters/gerber_jobfile_writer.h index fbb8d14c16..ae8d81528c 100644 --- a/pcbnew/exporters/gerber_jobfile_writer.h +++ b/pcbnew/exporters/gerber_jobfile_writer.h @@ -47,7 +47,7 @@ enum ONSIDE class BOARD; /** - * class JOBFILE_PARAMS store the list of parameters written in Gerber job file + * JOBFILE_PARAMS store the list of parameters written in Gerber job file * especialy list of .gbr filenames and the corresponding layer id belonging the job */ class JOBFILE_PARAMS diff --git a/pcbnew/footprint_wizard.h b/pcbnew/footprint_wizard.h index ced1183438..e927d9fe9d 100644 --- a/pcbnew/footprint_wizard.h +++ b/pcbnew/footprint_wizard.h @@ -46,7 +46,7 @@ const wxString WIZARD_PARAM_UNITS_PERCENT = "%"; // Percent (0% -> 1 const wxString WIZARD_PARAM_UNITS_STRING = "string"; // String /** - * Class FOOTPRINT_WIZARD + * FOOTPRINT_WIZARD * This is the parent class from where any footprint wizard class must * derive */ class FOOTPRINT_WIZARD diff --git a/pcbnew/footprint_wizard_frame.h b/pcbnew/footprint_wizard_frame.h index 634432b4d6..c63d520802 100644 --- a/pcbnew/footprint_wizard_frame.h +++ b/pcbnew/footprint_wizard_frame.h @@ -48,7 +48,7 @@ enum WizardParameterColumnNames }; /** - * Class FOOTPRINT_WIZARD_FRAME + * FOOTPRINT_WIZARD_FRAME */ class FOOTPRINT_WIZARD_FRAME : public PCB_BASE_FRAME { diff --git a/pcbnew/github/github_getliblist.h b/pcbnew/github/github_getliblist.h index b9f1225e97..2c5ae8415d 100644 --- a/pcbnew/github/github_getliblist.h +++ b/pcbnew/github/github_getliblist.h @@ -27,7 +27,7 @@ /** - * Class GITHUB_GETLIBLIST + * GITHUB_GETLIBLIST * implements a portion of pcbnew's PLUGIN interface to provide read only access * to a github repo to extract pretty footprints library list, in json format, * or extract 3D shapes libraries list (.3dshapes folders) and download the 3d shapes files diff --git a/pcbnew/github/github_plugin.cpp b/pcbnew/github/github_plugin.cpp index 9800dde6b8..d183a3a00b 100644 --- a/pcbnew/github/github_plugin.cpp +++ b/pcbnew/github/github_plugin.cpp @@ -104,7 +104,7 @@ typedef MODULE_MAP::const_iterator MODULE_CITER; /** - * Class GH_CACHE + * GH_CACHE * assists only within GITHUB_PLUGIN and holds a map of footprint name to wxZipEntry */ struct GH_CACHE : public MODULE_MAP diff --git a/pcbnew/gpcb_plugin.cpp b/pcbnew/gpcb_plugin.cpp index 2f714d48d0..145635a103 100644 --- a/pcbnew/gpcb_plugin.cpp +++ b/pcbnew/gpcb_plugin.cpp @@ -99,7 +99,7 @@ static inline long parseInt( const wxString& aValue, double aScalar ) /** - * Class GPCB_FPL_CACHE_ITEM + * GPCB_FPL_CACHE_ITEM * is helper class for creating a footprint library cache. * * The new footprint library design is a file path of individual module files diff --git a/pcbnew/gpcb_plugin.h b/pcbnew/gpcb_plugin.h index 35c3ea06db..a1bda236a5 100644 --- a/pcbnew/gpcb_plugin.h +++ b/pcbnew/gpcb_plugin.h @@ -38,7 +38,7 @@ class GPCB_FPL_CACHE; /** - * Class GPCB_PLUGIN + * GPCB_PLUGIN * is a PLUGIN derivation for saving and loading Geda PCB files. * * @note This class is not thread safe, but it is re-entrant multiple times in sequence. diff --git a/pcbnew/io_mgr.h b/pcbnew/io_mgr.h index d2362cc3d7..849d87ba19 100644 --- a/pcbnew/io_mgr.h +++ b/pcbnew/io_mgr.h @@ -39,7 +39,7 @@ class PROPERTIES; /** - * Class IO_MGR + * IO_MGR * is a factory which returns an instance of a PLUGIN. */ class IO_MGR @@ -72,7 +72,7 @@ public: }; /** - * Class PLUGIN_REGISTRY + * PLUGIN_REGISTRY * Holds a list of available plugins, created using a singleton REGISTER_PLUGIN object. * This way, plugins can be added link-time. */ @@ -128,7 +128,7 @@ public: }; /** - * Class REGISTER_PLUGIN + * REGISTER_PLUGIN * Registers a plugin. Declare as a static variable in an anonymous namespace. * @param aType: type of the plugin * @param aName: name of the file format @@ -247,7 +247,7 @@ public: /** - * Class PLUGIN + * PLUGIN * is a base class that BOARD loading and saving plugins should derive from. * Implementations can provide either Load() or Save() functions, or both. * PLUGINs throw exceptions, so it is best that you wrap your calls to these @@ -570,7 +570,7 @@ public: #ifndef SWIG /** - * Class RELEASER + * RELEASER * releases a PLUGIN in the context of a potential thrown exception, through * its destructor. */ diff --git a/pcbnew/kicad_plugin.cpp b/pcbnew/kicad_plugin.cpp index 34f5db62cf..acc127ecc9 100644 --- a/pcbnew/kicad_plugin.cpp +++ b/pcbnew/kicad_plugin.cpp @@ -74,7 +74,7 @@ void filterNetClass( const BOARD& aBoard, NETCLASS& aNetClass ) } /** - * Class FP_CACHE_ITEM + * FP_CACHE_ITEM * is helper class for creating a footprint library cache. * * The new footprint library design is a file path of individual module files diff --git a/pcbnew/kicad_plugin.h b/pcbnew/kicad_plugin.h index ae99bd98cf..338fc34a84 100644 --- a/pcbnew/kicad_plugin.h +++ b/pcbnew/kicad_plugin.h @@ -91,7 +91,7 @@ class TEXTE_PCB; /** - * Class PCB_IO + * PCB_IO * is a PLUGIN derivation for saving and loading Pcbnew s-expression formatted files. * * @note This class is not thread safe, but it is re-entrant multiple times in sequence. diff --git a/pcbnew/layer_widget.cpp b/pcbnew/layer_widget.cpp index 9cc50e66d3..fa3d29d8c8 100644 --- a/pcbnew/layer_widget.cpp +++ b/pcbnew/layer_widget.cpp @@ -816,7 +816,7 @@ void LAYER_WIDGET::UpdateLayerIcons() /** - * Class MYFRAME + * MYFRAME * is a test class here to exercise the LAYER_WIDGET and explore use cases. * @see http://www.kirix.com/labs/wxaui/screenshots.html * for ideas. diff --git a/pcbnew/layer_widget.h b/pcbnew/layer_widget.h index 8b650e1919..55b6241451 100644 --- a/pcbnew/layer_widget.h +++ b/pcbnew/layer_widget.h @@ -58,7 +58,7 @@ using KIGFX::COLOR4D; /** - * Class LAYER_WIDGET + * LAYER_WIDGET * is abstract and is used to manage a list of layers, with the notion of * a "current" layer, and layer specific visibility control. You must derive from * it to use it so you can implement the abstract functions which recieve the @@ -432,7 +432,7 @@ public: /** * Function OnLayerColorChange * is called to notify client code about a layer color change. Derived - * classes will handle this accordingly. + *es will handle this accordingly. * @param aLayer is the board layer to change * @param aColor is the new color */ diff --git a/pcbnew/legacy_plugin.cpp b/pcbnew/legacy_plugin.cpp index 699abe5809..c89b1a85d1 100644 --- a/pcbnew/legacy_plugin.cpp +++ b/pcbnew/legacy_plugin.cpp @@ -3202,7 +3202,7 @@ typedef MODULE_MAP::const_iterator MODULE_CITER; /** - * Class LP_CACHE + * LP_CACHE * assists only for the footprint portion of the PLUGIN API, and only for the * LEGACY_PLUGIN, so therefore is private to this implementation file, i.e. not placed * into a header. diff --git a/pcbnew/legacy_plugin.h b/pcbnew/legacy_plugin.h index c7a5300891..4e4a380b28 100644 --- a/pcbnew/legacy_plugin.h +++ b/pcbnew/legacy_plugin.h @@ -58,7 +58,7 @@ struct LP_CACHE; /** - * Class LEGACY_PLUGIN + * LEGACY_PLUGIN * is a PLUGIN derivation which could possibly be put into a DLL/DSO. * As with any PLUGIN, there is no UI, i.e. windowing calls allowed. */ diff --git a/pcbnew/netclass.h b/pcbnew/netclass.h index 57e9f72639..b1f60f5f64 100644 --- a/pcbnew/netclass.h +++ b/pcbnew/netclass.h @@ -47,7 +47,7 @@ DECL_SET_FOR_SWIG( STRINGSET, wxString ) /** - * Class NETCLASS + * NETCLASS * handles a collection of nets and the parameters used to route or * test these nets. */ @@ -216,7 +216,7 @@ DECL_MAP_FOR_SWIG( NETCLASS_MAP, wxString, NETCLASSPTR ) /** - * Class NETCLASSES + * NETCLASSES * is a container for NETCLASS instances. It owns all its NETCLASSes * (=> it will delete them at time of destruction). This container will always have * a default NETCLASS with the name given by const NETCLASS::Default. diff --git a/pcbnew/netinfo.h b/pcbnew/netinfo.h index b705b5aa73..5cee12a128 100644 --- a/pcbnew/netinfo.h +++ b/pcbnew/netinfo.h @@ -59,7 +59,7 @@ class PCB_BASE_FRAME; DECL_VEC_FOR_SWIG( D_PADS, D_PAD* ) /** - * Class NETINFO_ITEM + * NETINFO_ITEM * handles the data for a net */ class NETINFO_ITEM : public BOARD_ITEM @@ -402,7 +402,7 @@ DECL_MAP_FOR_SWIG( NETCODES_MAP, int, NETINFO_ITEM* ) #endif /** - * Class NETINFO_LIST + * NETINFO_LIST * is a container class for NETINFO_ITEM elements, which are the nets. That makes * this class a container for the nets. */ diff --git a/pcbnew/netlist_reader/board_netlist_updater.h b/pcbnew/netlist_reader/board_netlist_updater.h index 7b3596a645..d276dec7c8 100644 --- a/pcbnew/netlist_reader/board_netlist_updater.h +++ b/pcbnew/netlist_reader/board_netlist_updater.h @@ -44,7 +44,7 @@ class PCB_EDIT_FRAME; #include /** - * Class BOARD_NETLIST_UPDATER + * BOARD_NETLIST_UPDATER * updates the #BOARD with a new netlist. * * The changes are made to the board are as follows they are not disabled in the status diff --git a/pcbnew/netlist_reader/netlist_reader.h b/pcbnew/netlist_reader/netlist_reader.h index d7e05773b6..13b3e0c313 100644 --- a/pcbnew/netlist_reader/netlist_reader.h +++ b/pcbnew/netlist_reader/netlist_reader.h @@ -44,7 +44,7 @@ class COMPONENT; /** - * Class CMP_READER + * CMP_READER * reads a component footprint link file (*.cmp) format. */ class CMP_READER @@ -105,7 +105,7 @@ public: /** - * Class NETLIST_READER + * NETLIST_READER * is a pure virtual class to derive a specific type of netlist reader from. */ class NETLIST_READER @@ -200,7 +200,7 @@ protected: /** - * Class LEGACY_NETLIST_READER + * LEGACY_NETLIST_READER * reads the KiCad legacy and the old Orcad netlist formats. * * The KiCad legacy netlist format was derived directly from an old Orcad netlist format. The @@ -288,7 +288,7 @@ public: /** - * Class KICAD_NETLIST_PARSER + * KICAD_NETLIST_PARSER * is the parser for reading the KiCad s-expression netlist format. */ class KICAD_NETLIST_PARSER : public NETLIST_LEXER @@ -376,7 +376,7 @@ public: /** - * Class KICAD_NETLIST_READER + * KICAD_NETLIST_READER * read the new s-expression based KiCad netlist format. */ class KICAD_NETLIST_READER : public NETLIST_READER diff --git a/pcbnew/netlist_reader/pcb_netlist.h b/pcbnew/netlist_reader/pcb_netlist.h index cbdfab7e9b..4a2cc84731 100644 --- a/pcbnew/netlist_reader/pcb_netlist.h +++ b/pcbnew/netlist_reader/pcb_netlist.h @@ -42,7 +42,7 @@ class REPORTER; /** - * Class COMPONENT_NET + * COMPONENT_NET * is used to store the component pin name to net name (and pin function) * associations stored in a netlist. */ @@ -79,7 +79,7 @@ public: typedef std::vector< COMPONENT_NET > COMPONENT_NETS; /** - * Class COMPONENT + * COMPONENT * is used to store components and all of their related information found in a netlist. */ class COMPONENT @@ -210,7 +210,7 @@ typedef COMPONENTS::const_iterator COMPONENTS_CITER; /** - * Class NETLIST + * NETLIST * stores all of information read from a netlist along with the flags used to update * the NETLIST in the #BOARD. */ diff --git a/pcbnew/pad_custom_shape_functions.cpp b/pcbnew/pad_custom_shape_functions.cpp index f1175b8516..38da24075f 100644 --- a/pcbnew/pad_custom_shape_functions.cpp +++ b/pcbnew/pad_custom_shape_functions.cpp @@ -24,7 +24,7 @@ /** * @file class_pad_custom_shape_functions.cpp - * class D_PAD functions specific to custom shaped pads. + * D_PAD functions specific to custom shaped pads. */ #include diff --git a/pcbnew/pcb_edit_frame.h b/pcbnew/pcb_edit_frame.h index 02e674a434..dbd95098a7 100644 --- a/pcbnew/pcb_edit_frame.h +++ b/pcbnew/pcb_edit_frame.h @@ -86,7 +86,7 @@ enum LAST_PATH_TYPE }; /** - * Class PCB_EDIT_FRAME + * PCB_EDIT_FRAME * is the main frame for Pcbnew. * * See also class PCB_BASE_FRAME(): Basic class for Pcbnew and GerbView. diff --git a/pcbnew/pcb_layer_widget.h b/pcbnew/pcb_layer_widget.h index ab6b7c2350..3c36bc0fc3 100644 --- a/pcbnew/pcb_layer_widget.h +++ b/pcbnew/pcb_layer_widget.h @@ -34,7 +34,7 @@ #include /** - * Class PCB_LAYER_WIDGET + * PCB_LAYER_WIDGET * is here to implement the abstract functions of LAYER_WIDGET so they * may be tied into the PCB_EDIT_FRAME's data and so we can add a popup * menu which is specific to PCBNEW's needs. diff --git a/pcbnew/pcb_painter.h b/pcbnew/pcb_painter.h index f0a93dc8a6..e822ac411d 100644 --- a/pcbnew/pcb_painter.h +++ b/pcbnew/pcb_painter.h @@ -55,7 +55,7 @@ namespace KIGFX class GAL; /** - * Class PCB_RENDER_SETTINGS + * PCB_RENDER_SETTINGS * Stores PCB specific render settings. */ class PCB_RENDER_SETTINGS : public RENDER_SETTINGS @@ -220,7 +220,7 @@ protected: /** - * Class PCB_PAINTER + * PCB_PAINTER * Contains methods for drawing PCB-specific items. */ class PCB_PAINTER : public PAINTER diff --git a/pcbnew/pcb_parser.h b/pcbnew/pcb_parser.h index 3af64d421c..c531f65330 100644 --- a/pcbnew/pcb_parser.h +++ b/pcbnew/pcb_parser.h @@ -60,7 +60,7 @@ struct LAYER; /** - * Class PCB_PARSER + * PCB_PARSER * reads a Pcbnew s-expression formatted #LINE_READER object and returns the appropriate * #BOARD_ITEM object. */ diff --git a/pcbnew/pcb_plot_params.h b/pcbnew/pcb_plot_params.h index 0037c7e33e..5fa4bce089 100644 --- a/pcbnew/pcb_plot_params.h +++ b/pcbnew/pcb_plot_params.h @@ -31,7 +31,7 @@ class PCB_PLOT_PARAMS_PARSER; /** - * Class PCB_PLOT_PARAMS + * PCB_PLOT_PARAMS * handles plot parameters and options when plotting/printing a board. */ class PCB_PLOT_PARAMS diff --git a/pcbnew/pcb_plot_params_parser.h b/pcbnew/pcb_plot_params_parser.h index 90106a816a..e36de529cf 100644 --- a/pcbnew/pcb_plot_params_parser.h +++ b/pcbnew/pcb_plot_params_parser.h @@ -30,7 +30,7 @@ class LINE_READER; /** - * Class PCB_PLOT_PARAMS_PARSER + * PCB_PLOT_PARAMS_PARSER * is the parser class for PCB_PLOT_PARAMS. */ class PCB_PLOT_PARAMS_PARSER : public PCB_PLOT_PARAMS_LEXER diff --git a/pcbnew/ratsnest_data.h b/pcbnew/ratsnest_data.h index 8d6ef5cfe5..9b2d87e9ce 100644 --- a/pcbnew/ratsnest_data.h +++ b/pcbnew/ratsnest_data.h @@ -53,7 +53,7 @@ struct RN_NODE_AND_FILTER; /** - * Class RN_NET + * RN_NET * Describes ratsnest for a single net. */ class RN_NET diff --git a/pcbnew/router/pns_algo_base.h b/pcbnew/router/pns_algo_base.h index c6b4b683e1..a3d43372c7 100644 --- a/pcbnew/router/pns_algo_base.h +++ b/pcbnew/router/pns_algo_base.h @@ -31,7 +31,7 @@ class LOGGER; class DEBUG_DECORATOR; /** - * Class ALGO_BASE + * ALGO_BASE * * Base class for all P&S algorithms (shoving, walkaround, line placement, dragging, etc.) * Holds a bunch of objects commonly used by all algorithms (P&S settings, parent router instance, logging) diff --git a/pcbnew/router/pns_diff_pair.h b/pcbnew/router/pns_diff_pair.h index 25a288e7e4..ccd2cec766 100644 --- a/pcbnew/router/pns_diff_pair.h +++ b/pcbnew/router/pns_diff_pair.h @@ -38,7 +38,7 @@ namespace PNS { class DIFF_PAIR; /** - * Class DP_GATEWAY + * DP_GATEWAY * * Defines a "gateway" for routing a differential pair - e.g. a pair of points (anchors) with certain * orientation, spacing and (optionally) predefined entry paths. The routing algorithm connects such @@ -129,7 +129,7 @@ private: }; /** - * Class DP_PRIMITIVE_PAIR + * DP_PRIMITIVE_PAIR * * Stores staring/ending primitives (pads, vias or segments) for a differential pair. **/ @@ -178,7 +178,7 @@ private: }; /** - * Class DP_GATEWAYS + * DP_GATEWAYS * * A set of gateways calculated for the cursor or starting/ending primitive pair. **/ @@ -257,7 +257,7 @@ class DP_GATEWAYS /** - * Class DIFF_PAIR + * DIFF_PAIR * * Basic class for a differential pair. Stores two PNS_LINEs (for positive and negative nets, respectively), * the gap and coupling constraints. diff --git a/pcbnew/router/pns_diff_pair_placer.h b/pcbnew/router/pns_diff_pair_placer.h index c2cb591944..02fd2cd0cc 100644 --- a/pcbnew/router/pns_diff_pair_placer.h +++ b/pcbnew/router/pns_diff_pair_placer.h @@ -46,7 +46,7 @@ class SIZES_SETTINGS; /** - * Class LINE_PLACER + * LINE_PLACER * * Single track placement algorithm. Interactively routes a track. * Applies shove and walkaround algorithms when needed. diff --git a/pcbnew/router/pns_dp_meander_placer.h b/pcbnew/router/pns_dp_meander_placer.h index f939da03ac..725e3d18e1 100644 --- a/pcbnew/router/pns_dp_meander_placer.h +++ b/pcbnew/router/pns_dp_meander_placer.h @@ -41,7 +41,7 @@ namespace PNS { class ROUTER; /** - * Class DP_MEANDER_PLACER + * DP_MEANDER_PLACER * * Differential Pair length-matching/meandering tool. */ diff --git a/pcbnew/router/pns_dragger.h b/pcbnew/router/pns_dragger.h index 53a5a95a05..4459fb2288 100644 --- a/pcbnew/router/pns_dragger.h +++ b/pcbnew/router/pns_dragger.h @@ -40,7 +40,7 @@ class SHOVE; class OPTIMIZER; /** - * Class DRAGGER + * DRAGGER * * Via, segment and corner dragging algorithm. */ diff --git a/pcbnew/router/pns_index.h b/pcbnew/router/pns_index.h index 3fb7b13f67..28da0107a6 100644 --- a/pcbnew/router/pns_index.h +++ b/pcbnew/router/pns_index.h @@ -37,7 +37,7 @@ namespace PNS { /** - * Class INDEX + * INDEX * * Custom spatial index, holding our board items and allowing for very fast searches. Items * are assigned to separate R-Tree subindices depending on their type and spanned layers, reducing diff --git a/pcbnew/router/pns_item.h b/pcbnew/router/pns_item.h index 32ce615fca..f48425e701 100644 --- a/pcbnew/router/pns_item.h +++ b/pcbnew/router/pns_item.h @@ -45,7 +45,7 @@ enum LineMarker { /** - * Class ITEM + * ITEM * * Base class for PNS router board items. Implements the shared properties of all PCB items - * net, spanned layers, geometric shape & refererence to owning model. diff --git a/pcbnew/router/pns_itemset.h b/pcbnew/router/pns_itemset.h index 9c88d65ec0..118a9541a4 100644 --- a/pcbnew/router/pns_itemset.h +++ b/pcbnew/router/pns_itemset.h @@ -29,7 +29,7 @@ namespace PNS { /** - * Class ITEM_SET + * ITEM_SET * * Holds a list of board items, that can be filtered against net, kinds, * layers, etc. diff --git a/pcbnew/router/pns_joint.h b/pcbnew/router/pns_joint.h index b394c13cd9..0ebdf43a59 100644 --- a/pcbnew/router/pns_joint.h +++ b/pcbnew/router/pns_joint.h @@ -33,7 +33,7 @@ namespace PNS { /** - * Class JOINT + * JOINT * * Represents a 2D point on a given set of layers and belonging to a certain * net, that links together a number of board items. diff --git a/pcbnew/router/pns_layerset.h b/pcbnew/router/pns_layerset.h index 1bdbbce836..948ee982a6 100644 --- a/pcbnew/router/pns_layerset.h +++ b/pcbnew/router/pns_layerset.h @@ -25,7 +25,7 @@ #include /** - * Class LAYER_RANGE + * LAYER_RANGE * * Represents a contiguous set of PCB layers. */ diff --git a/pcbnew/router/pns_line.h b/pcbnew/router/pns_line.h index fba3fa536f..66cf22deeb 100644 --- a/pcbnew/router/pns_line.h +++ b/pcbnew/router/pns_line.h @@ -40,7 +40,7 @@ class SEGMENT; class VIA; /** - * Class LINE + * LINE * * Represents a track on a PCB, connecting two non-trivial joints (that is, * vias, pads, junctions between multiple traces or two traces different widths diff --git a/pcbnew/router/pns_line_placer.h b/pcbnew/router/pns_line_placer.h index 1e5a61d80c..5e06349444 100644 --- a/pcbnew/router/pns_line_placer.h +++ b/pcbnew/router/pns_line_placer.h @@ -43,7 +43,7 @@ class SIZES_SETTINGS; /** - * Class LINE_PLACER + * LINE_PLACER * * Single track placement algorithm. Interactively routes a track. * Applies shove and walkaround algorithms when needed. diff --git a/pcbnew/router/pns_meander.h b/pcbnew/router/pns_meander.h index 5f4a6410be..5dbe1d76af 100644 --- a/pcbnew/router/pns_meander.h +++ b/pcbnew/router/pns_meander.h @@ -50,7 +50,7 @@ enum MEANDER_STYLE { }; /** - * Class MEANDER_SETTINGS + * MEANDER_SETTINGS * * Holds dimensions for the meandering algorithm. */ @@ -100,7 +100,7 @@ public: class MEANDERED_LINE; /** - * Class MEANDER_SETTINGS + * MEANDER_SETTINGS * * Holds the geometry of a single meander. */ @@ -391,7 +391,7 @@ private: /** - * Class MEANDERED_LINE + * MEANDERED_LINE * * Represents a set of meanders fitted over a single or two lines. */ diff --git a/pcbnew/router/pns_meander_placer.h b/pcbnew/router/pns_meander_placer.h index e288d21d4c..bf486d2c19 100644 --- a/pcbnew/router/pns_meander_placer.h +++ b/pcbnew/router/pns_meander_placer.h @@ -41,7 +41,7 @@ class SHOVE; class OPTIMIZER; /** - * Class MEANDER_PLACER + * MEANDER_PLACER * * Single track length matching/meandering tool. */ diff --git a/pcbnew/router/pns_meander_placer_base.h b/pcbnew/router/pns_meander_placer_base.h index 33e482680d..c1daf8b4da 100644 --- a/pcbnew/router/pns_meander_placer_base.h +++ b/pcbnew/router/pns_meander_placer_base.h @@ -40,7 +40,7 @@ class SHOVE; class OPTIMIZER; /** - * Class MEANDER_PLACER_BASE + * MEANDER_PLACER_BASE * * Base class for Single trace & Differenial pair meandering tools, as * both of them share a lot of code. diff --git a/pcbnew/router/pns_meander_skew_placer.h b/pcbnew/router/pns_meander_skew_placer.h index 580877c479..fd8e020f43 100644 --- a/pcbnew/router/pns_meander_skew_placer.h +++ b/pcbnew/router/pns_meander_skew_placer.h @@ -32,7 +32,7 @@ class SHOVE; class OPTIMIZER; /** - * Class MEANDER_SKEW_PLACER + * MEANDER_SKEW_PLACER * * Differential pair skew adjustment algorithm. */ diff --git a/pcbnew/router/pns_node.h b/pcbnew/router/pns_node.h index 2b03d20265..12c1243579 100644 --- a/pcbnew/router/pns_node.h +++ b/pcbnew/router/pns_node.h @@ -48,7 +48,7 @@ class ROUTER; class NODE; /** - * Class RULE_RESOLVER + * RULE_RESOLVER * * An abstract function object, returning a design rule (clearance, diff pair gap, etc) required between two items. **/ @@ -126,7 +126,7 @@ protected: }; /** - * Class NODE + * NODE * * Keeps the router "world" - i.e. all the tracks, vias, solids in a * hierarchical and indexed way. diff --git a/pcbnew/router/pns_optimizer.h b/pcbnew/router/pns_optimizer.h index c216b4047d..9292dbc7d2 100644 --- a/pcbnew/router/pns_optimizer.h +++ b/pcbnew/router/pns_optimizer.h @@ -38,7 +38,7 @@ class LINE; class DIFF_PAIR; /** - * Class COST_ESTIMATOR + * COST_ESTIMATOR * * Calculates the cost of a given line, taking corner angles and total length into account. **/ @@ -77,7 +77,7 @@ private: }; /** - * Class OPTIMIZER + * OPTIMIZER * * Performs various optimizations of the lines being routed, attempting to make the lines shorter * and less cornery. There are 3 kinds of optimizations so far: diff --git a/pcbnew/router/pns_placement_algo.h b/pcbnew/router/pns_placement_algo.h index 98af6cbc72..0ffc7d6dac 100644 --- a/pcbnew/router/pns_placement_algo.h +++ b/pcbnew/router/pns_placement_algo.h @@ -35,7 +35,7 @@ class ITEM; class NODE; /** - * Class PLACEMENT_ALGO + * PLACEMENT_ALGO * * Abstract class for a P&S placement/dragging algorithm. * All subtools (drag, single/diff pair routing and meandering) diff --git a/pcbnew/router/pns_router.h b/pcbnew/router/pns_router.h index e41b4a54d0..c4ebe2ddf1 100644 --- a/pcbnew/router/pns_router.h +++ b/pcbnew/router/pns_router.h @@ -79,7 +79,7 @@ enum DRAG_MODE DM_ANY = 0x7 }; /** - * Class ROUTER + * ROUTER * * Main router class. */ diff --git a/pcbnew/router/pns_routing_settings.h b/pcbnew/router/pns_routing_settings.h index 46534bc3f8..e537753d69 100644 --- a/pcbnew/router/pns_routing_settings.h +++ b/pcbnew/router/pns_routing_settings.h @@ -49,7 +49,7 @@ enum PNS_OPTIMIZATION_EFFORT }; /** - * Class ROUTING_SETTINGS + * ROUTING_SETTINGS * * Contains all persistent settings of the router, such as the mode, optimization effort, etc. */ diff --git a/pcbnew/router/pns_shove.h b/pcbnew/router/pns_shove.h index 53c5051fa4..420e9b2f6d 100644 --- a/pcbnew/router/pns_shove.h +++ b/pcbnew/router/pns_shove.h @@ -40,7 +40,7 @@ class NODE; class ROUTER; /** - * Class SHOVE + * SHOVE * * The actual Push and Shove algorithm. */ diff --git a/pcbnew/sel_layer.cpp b/pcbnew/sel_layer.cpp index 9e7f8a4264..87f2a4c4f8 100644 --- a/pcbnew/sel_layer.cpp +++ b/pcbnew/sel_layer.cpp @@ -223,7 +223,7 @@ PCB_LAYER_ID PCB_BASE_FRAME::SelectLayer( PCB_LAYER_ID aDefaultLayer, LSET aNotA /** - * Class SELECT_COPPER_LAYERS_PAIR_DIALOG + * SELECT_COPPER_LAYERS_PAIR_DIALOG * displays a double pcb copper layers list in a dialog, * to select a layer pair from these lists */ diff --git a/pcbnew/specctra_import_export/specctra.h b/pcbnew/specctra_import_export/specctra.h index 31be70fcfc..28f11ecc42 100644 --- a/pcbnew/specctra_import_export/specctra.h +++ b/pcbnew/specctra_import_export/specctra.h @@ -187,7 +187,7 @@ typedef std::vector PROPERTIES; class UNIT_RES; /** - * Class ELEM + * ELEM * is a base class for any DSN element class. * See class ELEM_HOLDER also. */ @@ -274,7 +274,7 @@ public: /** - * Class ELEM_HOLDER + * ELEM_HOLDER * is a holder for any DSN class. It can contain other * class instances, including classes derived from this class. */ @@ -360,7 +360,7 @@ public: /** - * Class PARSER + * PARSER * is simply a configuration record per the SPECCTRA DSN file spec. * It is not actually a parser, but rather corresponds to <parser_descriptor> */ @@ -394,7 +394,7 @@ public: /** - * Class UNIT_RES + * UNIT_RES * is a holder for either a T_unit or T_resolution object which are usually * mutually exclusive in the dsn grammar, except within the T_pcb level. */ @@ -486,7 +486,7 @@ public: /** - * Class RULE + * RULE * corresponds to the <rule_descriptor> in the specctra dsn spec. */ class RULE : public ELEM @@ -569,7 +569,7 @@ typedef boost::ptr_vector LAYER_RULES; /** - * Class PATH + * PATH * supports both the <path_descriptor> and the <polygon_descriptor> per * the specctra dsn spec. */ @@ -878,7 +878,7 @@ typedef boost::ptr_vector WINDOWS; /** - * Class KEEPOUT + * KEEPOUT * is used for <keepout_descriptor> and <plane_descriptor>. */ class KEEPOUT : public ELEM @@ -1005,7 +1005,7 @@ typedef boost::ptr_vector KEEPOUTS; /** - * Class VIA + * VIA * corresponds to the <via_descriptor> in the specctra dsn spec. */ class VIA : public ELEM @@ -1319,7 +1319,7 @@ public: /** - * Class COPPER_PLANE + * COPPER_PLANE * corresponds to a <plane_descriptor> in the specctra dsn spec. */ class COPPER_PLANE : public KEEPOUT @@ -1335,7 +1335,7 @@ typedef boost::ptr_vector COPPER_PLANES; /** - * Class TOKPROP + * TOKPROP * is a container for a single property whose value is another DSN_T token. * The name of the property is obtained from the DSN_T Type(). */ @@ -1363,7 +1363,7 @@ public: /** - * Class STRINGPROP + * STRINGPROP * is a container for a single property whose value is a string. * The name of the property is obtained from the DSN_T. */ @@ -1653,7 +1653,7 @@ public: /** - * Class PLACE + * PLACE * implements the <placement_reference> in the specctra dsn spec. */ class PLACE : public ELEM @@ -1733,7 +1733,7 @@ typedef boost::ptr_vector PLACES; /** - * Class COMPONENT + * COMPONENT * implements the <component_descriptor> in the specctra dsn spec. */ class COMPONENT : public ELEM @@ -1854,7 +1854,7 @@ public: /** - * Class SHAPE + * SHAPE * corresponds to the "(shape ..)" element in the specctra dsn spec. * It is not a <shape_descriptor>, which is one of things that this * elements contains, i.e. in its "shape" field. This class also implements @@ -2092,7 +2092,7 @@ typedef boost::ptr_vector IMAGES; /** - * Class PADSTACK + * PADSTACK * holds either a via or a pad definition. */ class PADSTACK : public ELEM_HOLDER @@ -2223,7 +2223,7 @@ inline bool operator<( const PADSTACK& lhs, const PADSTACK& rhs ) /** - * Class LIBRARY + * LIBRARY * corresponds to the <library_descriptor> in the specctra dsn specification. * Only unit_descriptor, image_descriptors, and padstack_descriptors are * included as children at this time. @@ -2422,7 +2422,7 @@ public: /** - * Class PIN_REF + * PIN_REF * corresponds to the <pin_reference> definition in the specctra dsn spec. */ struct PIN_REF : public ELEM @@ -2528,7 +2528,7 @@ typedef boost::ptr_vector FROMTOS; /** - * Class COMP_ORDER + * COMP_ORDER * corresponds to the <component_order_descriptor> */ class COMP_ORDER : public ELEM @@ -2561,7 +2561,7 @@ public: typedef boost::ptr_vector COMP_ORDERS; /** - * Class NET + * NET * corresponds to a <net_descriptor> * in the DSN spec. */ @@ -2715,7 +2715,7 @@ public: /** - * Class CLASS + * CLASS * corresponds to the <class_descriptor> in the specctra spec. */ class CLASS : public ELEM @@ -2841,7 +2841,7 @@ public: /** - * Class WIRE + * WIRE * corresponds to <wire_shape_descriptor> in the specctra dsn spec. */ class WIRE : public ELEM @@ -2951,7 +2951,7 @@ typedef boost::ptr_vector WIRES; /** - * Class WIRE_VIA + * WIRE_VIA * corresponds to <wire_via_descriptor> in the specctra dsn spec. */ class WIRE_VIA : public ELEM @@ -3087,7 +3087,7 @@ typedef boost::ptr_vector WIRE_VIAS; /** - * Class WIRING + * WIRING * corresponds to <wiring_descriptor> in the specctra dsn spec. */ class WIRING : public ELEM @@ -3307,7 +3307,7 @@ public: /** - * Class SUPPLY_PIN + * SUPPLY_PIN * corresponds to the <supply_pin_descriptor> in the specctra dsn spec. */ class SUPPLY_PIN : public ELEM @@ -3355,7 +3355,7 @@ typedef boost::ptr_vector SUPPLY_PINS; /** - * Class NET_OUT + * NET_OUT * corresponds to the <net_out_descriptor> of the specctra dsn spec. */ class NET_OUT : public ELEM @@ -3497,7 +3497,7 @@ typedef std::vector PIN_PAIRS; /** - * Class WAS_IS + * WAS_IS * corresponds to the <was_is_descriptor> in the specctra dsn spec. */ class WAS_IS : public ELEM @@ -3527,7 +3527,7 @@ public: /** - * Class SESSION + * SESSION * corresponds to the <session_file_descriptor> in the specctra dsn spec. */ class SESSION : public ELEM @@ -3600,7 +3600,7 @@ typedef boost::ptr_set PADSTACKSET; /** - * Class SPECCTRA_DB + * SPECCTRA_DB * holds a DSN data tree, usually coming from a DSN file. Is essentially a * SPECCTRA_PARSER class. */ diff --git a/pcbnew/tools/drawing_tool.h b/pcbnew/tools/drawing_tool.h index 5dc0393076..c22267b3fa 100644 --- a/pcbnew/tools/drawing_tool.h +++ b/pcbnew/tools/drawing_tool.h @@ -41,7 +41,7 @@ class DRAWSEGMENT; class POLYGON_GEOM_MANAGER; /** - * Class DRAWING_TOOL + * DRAWING_TOOL * * Tool responsible for drawing graphical elements like lines, arcs, circles, etc. */ diff --git a/pcbnew/tools/edit_tool.h b/pcbnew/tools/edit_tool.h index a1b7dbe1be..bb965efca5 100644 --- a/pcbnew/tools/edit_tool.h +++ b/pcbnew/tools/edit_tool.h @@ -57,7 +57,7 @@ namespace KIGFX { void EditToolSelectionFilter( GENERAL_COLLECTOR& aCollector, int aFlags ); /** - * Class EDIT_TOOL + * EDIT_TOOL * * The interactive edit tool. Allows one to move, rotate, flip and change properties of items selected * using the pcbnew.InteractiveSelection tool. diff --git a/pcbnew/tools/footprint_editor_tools.h b/pcbnew/tools/footprint_editor_tools.h index 98d79b7bf9..4edef6262d 100644 --- a/pcbnew/tools/footprint_editor_tools.h +++ b/pcbnew/tools/footprint_editor_tools.h @@ -32,7 +32,7 @@ class FOOTPRINT_EDIT_FRAME; /** - * Class MODULE_EDITOR_TOOLS + * MODULE_EDITOR_TOOLS * * Module editor specific tools. */ diff --git a/pcbnew/tools/microwave_tool.h b/pcbnew/tools/microwave_tool.h index a0913e6396..4929de3d62 100644 --- a/pcbnew/tools/microwave_tool.h +++ b/pcbnew/tools/microwave_tool.h @@ -30,7 +30,7 @@ /** - * Class MICROWAVE_TOOL + * MICROWAVE_TOOL * * Tool responsible for adding microwave features to PCBs */ diff --git a/pcbnew/tools/pad_tool.h b/pcbnew/tools/pad_tool.h index cd32fba54b..82d2e40a77 100644 --- a/pcbnew/tools/pad_tool.h +++ b/pcbnew/tools/pad_tool.h @@ -30,7 +30,7 @@ class ACTION_MENU; /** - * Class PAD_TOOL + * PAD_TOOL * * Tools relating to pads and pad settings */ diff --git a/pcbnew/tools/pcb_actions.h b/pcbnew/tools/pcb_actions.h index 6d6cfd23fc..c1ccd40269 100644 --- a/pcbnew/tools/pcb_actions.h +++ b/pcbnew/tools/pcb_actions.h @@ -54,7 +54,7 @@ enum class ZONE_MODE /** - * Class PCB_ACTIONS + * PCB_ACTIONS * * Gathers all the actions that are shared by tools. The instance of PCB_ACTIONS is created * inside of ACTION_MANAGER object that registers the actions. diff --git a/pcbnew/tools/pcb_bright_box.h b/pcbnew/tools/pcb_bright_box.h index e057eb614d..6390a32a3a 100644 --- a/pcbnew/tools/pcb_bright_box.h +++ b/pcbnew/tools/pcb_bright_box.h @@ -27,7 +27,7 @@ #include /** - * Class PCB_BRIGHT_BOX + * PCB_BRIGHT_BOX * * Draws a decoration to indicate a brightened item. */ diff --git a/pcbnew/tools/pcb_editor_control.h b/pcbnew/tools/pcb_editor_control.h index 8f8fc8a0ee..7f00acd149 100644 --- a/pcbnew/tools/pcb_editor_control.h +++ b/pcbnew/tools/pcb_editor_control.h @@ -35,7 +35,7 @@ namespace KIGFX { class PCB_EDIT_FRAME; /** - * Class PCB_EDITOR_CONTROL + * PCB_EDITOR_CONTROL * * Handles actions specific to the board editor in pcbnew. */ diff --git a/pcbnew/tools/pcb_inspection_tool.h b/pcbnew/tools/pcb_inspection_tool.h index 79542a5064..fd86ff3bc0 100644 --- a/pcbnew/tools/pcb_inspection_tool.h +++ b/pcbnew/tools/pcb_inspection_tool.h @@ -32,7 +32,7 @@ /** - * Class PCB_INSPECTION_TOOL + * PCB_INSPECTION_TOOL * * Tool for pcb inspection. */ diff --git a/pcbnew/tools/pcb_tool_base.h b/pcbnew/tools/pcb_tool_base.h index 01819a21ce..a89a11744e 100644 --- a/pcbnew/tools/pcb_tool_base.h +++ b/pcbnew/tools/pcb_tool_base.h @@ -39,7 +39,7 @@ #include /** - * Class PCB_TOOL_BASE + * PCB_TOOL_BASE * * A tool operating on a BOARD object **/ diff --git a/pcbnew/tools/pcbnew_control.h b/pcbnew/tools/pcbnew_control.h index ab54e3381f..5a0f94f42b 100644 --- a/pcbnew/tools/pcbnew_control.h +++ b/pcbnew/tools/pcbnew_control.h @@ -36,7 +36,7 @@ namespace KIGFX { class PCB_BASE_FRAME; class BOARD_ITEM; /** - * Class PCBNEW_CONTROL + * PCBNEW_CONTROL * * Handles actions that are shared between different frames in pcbnew. */ diff --git a/pcbnew/tools/point_editor.h b/pcbnew/tools/point_editor.h index 153f4697e4..4c1378606d 100644 --- a/pcbnew/tools/point_editor.h +++ b/pcbnew/tools/point_editor.h @@ -36,7 +36,7 @@ class SELECTION_TOOL; class SHAPE_POLY_SET; /** - * Class POINT_EDITOR + * POINT_EDITOR * * Tool that displays edit points allowing to modify items by dragging the points. */ diff --git a/pcbnew/tools/position_relative_tool.h b/pcbnew/tools/position_relative_tool.h index 725febd092..04ca200546 100644 --- a/pcbnew/tools/position_relative_tool.h +++ b/pcbnew/tools/position_relative_tool.h @@ -36,7 +36,7 @@ class SELECTION_TOOL; class DIALOG_POSITION_RELATIVE; /** - * Class POSITION_RELATIVE_TOOL + * POSITION_RELATIVE_TOOL * * The interactive edit tool. Allows one to move, rotate, flip and change properties of items selected * using the pcbnew.InteractiveSelection tool. diff --git a/pcbnew/tools/selection_tool.h b/pcbnew/tools/selection_tool.h index baec5708e9..b17e6dd32e 100644 --- a/pcbnew/tools/selection_tool.h +++ b/pcbnew/tools/selection_tool.h @@ -50,7 +50,7 @@ typedef void (*CLIENT_SELECTION_FILTER)( const VECTOR2I&, GENERAL_COLLECTOR& ); /** - * Class SELECTION_TOOL + * SELECTION_TOOL * * Our sample selection tool: currently supports: * - pick single objects (click LMB) diff --git a/pcbnew/tools/zone_filler_tool.h b/pcbnew/tools/zone_filler_tool.h index f8a89f3726..30c5c1fd7f 100644 --- a/pcbnew/tools/zone_filler_tool.h +++ b/pcbnew/tools/zone_filler_tool.h @@ -31,7 +31,7 @@ class PCB_EDIT_FRAME; /** - * Class ZONE_FILLER_TOOL + * ZONE_FILLER_TOOL * * Handles actions specific to filling copper zones. */ diff --git a/pcbnew/zone_settings.h b/pcbnew/zone_settings.h index 2507210628..8c128ce0ed 100644 --- a/pcbnew/zone_settings.h +++ b/pcbnew/zone_settings.h @@ -50,7 +50,7 @@ enum class ZONE_HATCH_STYLE }; /** - * Class ZONE_SETTINGS + * ZONE_SETTINGS * handles zones parameters. * Because a zone can be on copper or non copper layers, and can be also * a keepout area, some parameters are irrelevant depending on the type of zone diff --git a/plugins/3d/vrml/v1/vrml1_base.h b/plugins/3d/vrml/v1/vrml1_base.h index fe93ef4420..35ee5c677f 100644 --- a/plugins/3d/vrml/v1/vrml1_base.h +++ b/plugins/3d/vrml/v1/vrml1_base.h @@ -39,7 +39,7 @@ class SGNODE; class WRL1INLINE; /** - * Class WRL1BASE + * WRL1BASE * represents the top node of a VRML1 model */ class WRL1BASE : public WRL1NODE diff --git a/plugins/3d/vrml/v1/vrml1_coords.h b/plugins/3d/vrml/v1/vrml1_coords.h index 6f190e5b24..80138dec25 100644 --- a/plugins/3d/vrml/v1/vrml1_coords.h +++ b/plugins/3d/vrml/v1/vrml1_coords.h @@ -37,7 +37,7 @@ class WRL1BASE; class SGNODE; /** - * Class WRL1COORDS + * WRL1COORDS */ class WRL1COORDS : public WRL1NODE { diff --git a/plugins/3d/vrml/v1/vrml1_faceset.h b/plugins/3d/vrml/v1/vrml1_faceset.h index 0d96d3227f..effabd6c85 100644 --- a/plugins/3d/vrml/v1/vrml1_faceset.h +++ b/plugins/3d/vrml/v1/vrml1_faceset.h @@ -37,7 +37,7 @@ class WRL1BASE; class SGNODE; /** - * Class WRL1FACESET + * WRL1FACESET */ class WRL1FACESET : public WRL1NODE { diff --git a/plugins/3d/vrml/v1/vrml1_group.h b/plugins/3d/vrml/v1/vrml1_group.h index efa8a1c558..19fa2e7870 100644 --- a/plugins/3d/vrml/v1/vrml1_group.h +++ b/plugins/3d/vrml/v1/vrml1_group.h @@ -35,7 +35,7 @@ class WRL1BASE; class SGNODE; /** - * Class WRL1GROUP + * WRL1GROUP */ class WRL1GROUP : public WRL1NODE { diff --git a/plugins/3d/vrml/v1/vrml1_matbinding.h b/plugins/3d/vrml/v1/vrml1_matbinding.h index 778b5b6a81..8eb819f3b2 100644 --- a/plugins/3d/vrml/v1/vrml1_matbinding.h +++ b/plugins/3d/vrml/v1/vrml1_matbinding.h @@ -36,7 +36,7 @@ class WRL1BASE; class SGNODE; /** - * Class WRL1MATBINDING + * WRL1MATBINDING */ class WRL1MATBINDING : public WRL1NODE { diff --git a/plugins/3d/vrml/v1/vrml1_material.h b/plugins/3d/vrml/v1/vrml1_material.h index 9ee9de44b1..2e4927e1ee 100644 --- a/plugins/3d/vrml/v1/vrml1_material.h +++ b/plugins/3d/vrml/v1/vrml1_material.h @@ -38,7 +38,7 @@ class SGNODE; class SGCOLOR; /** - * Class WRL1MATERIAL + * WRL1MATERIAL */ class WRL1MATERIAL : public WRL1NODE { diff --git a/plugins/3d/vrml/v1/vrml1_node.h b/plugins/3d/vrml/v1/vrml1_node.h index c7f5cc9019..b1e08c4cca 100644 --- a/plugins/3d/vrml/v1/vrml1_node.h +++ b/plugins/3d/vrml/v1/vrml1_node.h @@ -105,7 +105,7 @@ struct WRL1STATUS /** - * Class WRL1NODE + * WRL1NODE * represents the base class of all VRML1 nodes */ class WRL1NODE diff --git a/plugins/3d/vrml/v1/vrml1_separator.h b/plugins/3d/vrml/v1/vrml1_separator.h index 907f36954a..8a92e4472f 100644 --- a/plugins/3d/vrml/v1/vrml1_separator.h +++ b/plugins/3d/vrml/v1/vrml1_separator.h @@ -35,7 +35,7 @@ class WRL1BASE; class SGNODE; /** - * Class WRL1SEPARATOR + * WRL1SEPARATOR */ class WRL1SEPARATOR : public WRL1NODE { diff --git a/plugins/3d/vrml/v1/vrml1_shapehints.h b/plugins/3d/vrml/v1/vrml1_shapehints.h index 83797777db..c0e7118f1a 100644 --- a/plugins/3d/vrml/v1/vrml1_shapehints.h +++ b/plugins/3d/vrml/v1/vrml1_shapehints.h @@ -36,7 +36,7 @@ class WRL1BASE; class SGNODE; /** - * Class WRL1SHAPEHINTS + * WRL1SHAPEHINTS */ class WRL1SHAPEHINTS : public WRL1NODE { diff --git a/plugins/3d/vrml/v1/vrml1_switch.h b/plugins/3d/vrml/v1/vrml1_switch.h index 628eb3bc49..96cb7b3038 100644 --- a/plugins/3d/vrml/v1/vrml1_switch.h +++ b/plugins/3d/vrml/v1/vrml1_switch.h @@ -35,7 +35,7 @@ class WRL1BASE; class SGNODE; /** - * Class WRL1SWITCH + * WRL1SWITCH */ class WRL1SWITCH : public WRL1NODE { diff --git a/plugins/3d/vrml/v1/vrml1_transform.h b/plugins/3d/vrml/v1/vrml1_transform.h index 3654b0296e..86ed4cc886 100644 --- a/plugins/3d/vrml/v1/vrml1_transform.h +++ b/plugins/3d/vrml/v1/vrml1_transform.h @@ -35,7 +35,7 @@ class WRL1BASE; class SGNODE; /** - * Class WRL1TRANSFORM + * WRL1TRANSFORM */ class WRL1TRANSFORM : public WRL1NODE { diff --git a/plugins/3d/vrml/v2/vrml2_appearance.h b/plugins/3d/vrml/v2/vrml2_appearance.h index fa23b91e42..ffe159f627 100644 --- a/plugins/3d/vrml/v2/vrml2_appearance.h +++ b/plugins/3d/vrml/v2/vrml2_appearance.h @@ -35,7 +35,7 @@ class WRL2BASE; class SGNODE; /** - * Class WRL2APPEARANCE + * WRL2APPEARANCE */ class WRL2APPEARANCE : public WRL2NODE { diff --git a/plugins/3d/vrml/v2/vrml2_base.h b/plugins/3d/vrml/v2/vrml2_base.h index f3f3a98a46..c56ef325ea 100644 --- a/plugins/3d/vrml/v2/vrml2_base.h +++ b/plugins/3d/vrml/v2/vrml2_base.h @@ -53,7 +53,7 @@ class SGNODE; class WRL2INLINE; /** - * Class WRL2BASE + * WRL2BASE * represents the top node of a VRML2 model */ class WRL2BASE : public WRL2NODE diff --git a/plugins/3d/vrml/v2/vrml2_box.h b/plugins/3d/vrml/v2/vrml2_box.h index 29df95bb0c..03c1d11fc4 100644 --- a/plugins/3d/vrml/v2/vrml2_box.h +++ b/plugins/3d/vrml/v2/vrml2_box.h @@ -35,7 +35,7 @@ class WRL2BASE; class SGNODE; /** - * Class WRL2BOX + * WRL2BOX */ class WRL2BOX : public WRL2NODE { diff --git a/plugins/3d/vrml/v2/vrml2_color.h b/plugins/3d/vrml/v2/vrml2_color.h index 7e184797a1..456280b22e 100644 --- a/plugins/3d/vrml/v2/vrml2_color.h +++ b/plugins/3d/vrml/v2/vrml2_color.h @@ -37,7 +37,7 @@ class WRL2BASE; class SGNODE; /** - * Class WRL2COLOR + * WRL2COLOR */ class WRL2COLOR : public WRL2NODE { diff --git a/plugins/3d/vrml/v2/vrml2_coords.h b/plugins/3d/vrml/v2/vrml2_coords.h index deeed07b0b..413fc9b750 100644 --- a/plugins/3d/vrml/v2/vrml2_coords.h +++ b/plugins/3d/vrml/v2/vrml2_coords.h @@ -37,7 +37,7 @@ class WRL2BASE; class SGNODE; /** - * Class WRL2COORDS + * WRL2COORDS */ class WRL2COORDS : public WRL2NODE { diff --git a/plugins/3d/vrml/v2/vrml2_faceset.h b/plugins/3d/vrml/v2/vrml2_faceset.h index 78b395a139..620129eed0 100644 --- a/plugins/3d/vrml/v2/vrml2_faceset.h +++ b/plugins/3d/vrml/v2/vrml2_faceset.h @@ -37,7 +37,7 @@ class WRL2BASE; class SGNODE; /** - * Class WRL2FACESET + * WRL2FACESET */ class WRL2FACESET : public WRL2NODE { diff --git a/plugins/3d/vrml/v2/vrml2_inline.h b/plugins/3d/vrml/v2/vrml2_inline.h index aa1e208f23..006a1bd899 100644 --- a/plugins/3d/vrml/v2/vrml2_inline.h +++ b/plugins/3d/vrml/v2/vrml2_inline.h @@ -35,7 +35,7 @@ class WRL2BASE; class SGNODE; /** - * Class WRL2INLINE + * WRL2INLINE */ class WRL2INLINE : public WRL2NODE { diff --git a/plugins/3d/vrml/v2/vrml2_lineset.h b/plugins/3d/vrml/v2/vrml2_lineset.h index 01e55518e1..2a76c333df 100644 --- a/plugins/3d/vrml/v2/vrml2_lineset.h +++ b/plugins/3d/vrml/v2/vrml2_lineset.h @@ -37,7 +37,7 @@ class WRL2BASE; class SGNODE; /** - * Class WRL2LINESET + * WRL2LINESET */ class WRL2LINESET : public WRL2NODE { diff --git a/plugins/3d/vrml/v2/vrml2_material.h b/plugins/3d/vrml/v2/vrml2_material.h index e7ab5476db..624c696870 100644 --- a/plugins/3d/vrml/v2/vrml2_material.h +++ b/plugins/3d/vrml/v2/vrml2_material.h @@ -35,7 +35,7 @@ class WRL2BASE; class SGNODE; /** - * Class WRL2MATERIAL + * WRL2MATERIAL */ class WRL2MATERIAL : public WRL2NODE { diff --git a/plugins/3d/vrml/v2/vrml2_node.h b/plugins/3d/vrml/v2/vrml2_node.h index 7aaa1e7eef..fade242bc9 100644 --- a/plugins/3d/vrml/v2/vrml2_node.h +++ b/plugins/3d/vrml/v2/vrml2_node.h @@ -52,7 +52,7 @@ class WRL2BASE; class SGNODE; /** - * Class WRL2NODE + * WRL2NODE * represents the base class of all VRML2 nodes */ class WRL2NODE diff --git a/plugins/3d/vrml/v2/vrml2_norms.h b/plugins/3d/vrml/v2/vrml2_norms.h index 424c2fa1e0..843a8f9398 100644 --- a/plugins/3d/vrml/v2/vrml2_norms.h +++ b/plugins/3d/vrml/v2/vrml2_norms.h @@ -37,7 +37,7 @@ class WRL2BASE; class SGNODE; /** - * Class WRL2NORMS + * WRL2NORMS */ class WRL2NORMS : public WRL2NODE { diff --git a/plugins/3d/vrml/v2/vrml2_pointset.h b/plugins/3d/vrml/v2/vrml2_pointset.h index fa14a88805..8d4816c63d 100644 --- a/plugins/3d/vrml/v2/vrml2_pointset.h +++ b/plugins/3d/vrml/v2/vrml2_pointset.h @@ -37,7 +37,7 @@ class WRL2BASE; class SGNODE; /** - * Class WRL2POINTSET + * WRL2POINTSET */ class WRL2POINTSET : public WRL2NODE { diff --git a/plugins/3d/vrml/v2/vrml2_shape.h b/plugins/3d/vrml/v2/vrml2_shape.h index 276e2c6442..4cc16ee467 100644 --- a/plugins/3d/vrml/v2/vrml2_shape.h +++ b/plugins/3d/vrml/v2/vrml2_shape.h @@ -35,7 +35,7 @@ class WRL2BASE; class SGNODE; /** - * Class WRL2SHAPE + * WRL2SHAPE */ class WRL2SHAPE : public WRL2NODE { diff --git a/plugins/3d/vrml/v2/vrml2_switch.h b/plugins/3d/vrml/v2/vrml2_switch.h index e03471c5ad..2d4bf8730e 100644 --- a/plugins/3d/vrml/v2/vrml2_switch.h +++ b/plugins/3d/vrml/v2/vrml2_switch.h @@ -35,7 +35,7 @@ class WRL2BASE; class SGNODE; /** - * Class WRL2SWITCH + * WRL2SWITCH */ class WRL2SWITCH : public WRL2NODE { diff --git a/plugins/3d/vrml/v2/vrml2_transform.h b/plugins/3d/vrml/v2/vrml2_transform.h index bd2fabf77c..e3e2da894d 100644 --- a/plugins/3d/vrml/v2/vrml2_transform.h +++ b/plugins/3d/vrml/v2/vrml2_transform.h @@ -35,7 +35,7 @@ class WRL2BASE; class SGNODE; /** - * Class WRL2TRANSFORM + * WRL2TRANSFORM */ class WRL2TRANSFORM : public WRL2NODE { diff --git a/plugins/3d/vrml/x3d/x3d_appearance.h b/plugins/3d/vrml/x3d/x3d_appearance.h index 6bd5d72e5b..dba4a973ba 100644 --- a/plugins/3d/vrml/x3d/x3d_appearance.h +++ b/plugins/3d/vrml/x3d/x3d_appearance.h @@ -36,7 +36,7 @@ /** - * Class X3DAPP + * X3DAPP */ class X3DAPP : public X3DNODE { diff --git a/plugins/3d/vrml/x3d/x3d_base.h b/plugins/3d/vrml/x3d/x3d_base.h index f2aa7437cd..d4c88455fe 100644 --- a/plugins/3d/vrml/x3d/x3d_base.h +++ b/plugins/3d/vrml/x3d/x3d_base.h @@ -69,7 +69,7 @@ enum X3DNODES }; /** - * Class X3DNODE + * X3DNODE * represents the base class of all X3D nodes */ class X3DNODE diff --git a/plugins/3d/vrml/x3d/x3d_coords.h b/plugins/3d/vrml/x3d/x3d_coords.h index 8c3400db5b..155cc614db 100644 --- a/plugins/3d/vrml/x3d/x3d_coords.h +++ b/plugins/3d/vrml/x3d/x3d_coords.h @@ -36,7 +36,7 @@ /** - * Class X3DCOORDS + * X3DCOORDS */ class X3DCOORDS : public X3DNODE { diff --git a/plugins/3d/vrml/x3d/x3d_ifaceset.h b/plugins/3d/vrml/x3d/x3d_ifaceset.h index 881f27e480..818956d88d 100644 --- a/plugins/3d/vrml/x3d/x3d_ifaceset.h +++ b/plugins/3d/vrml/x3d/x3d_ifaceset.h @@ -36,7 +36,7 @@ /** - * Class X3DIFACESET + * X3DIFACESET */ class X3DIFACESET : public X3DNODE { diff --git a/plugins/3d/vrml/x3d/x3d_shape.h b/plugins/3d/vrml/x3d/x3d_shape.h index 7d52ee238c..beb4eaa824 100644 --- a/plugins/3d/vrml/x3d/x3d_shape.h +++ b/plugins/3d/vrml/x3d/x3d_shape.h @@ -36,7 +36,7 @@ /** - * Class X3DSHAPE + * X3DSHAPE */ class X3DSHAPE : public X3DNODE { diff --git a/plugins/3d/vrml/x3d/x3d_transform.h b/plugins/3d/vrml/x3d/x3d_transform.h index 32b9cbcd30..f1f9412212 100644 --- a/plugins/3d/vrml/x3d/x3d_transform.h +++ b/plugins/3d/vrml/x3d/x3d_transform.h @@ -36,7 +36,7 @@ /** - * Class X3DTRANSFORM + * X3DTRANSFORM */ class X3DTRANSFORM : public X3DNODE { diff --git a/utils/idftools/idf_common.cpp b/utils/idftools/idf_common.cpp index a4b522b806..bc7dc1ac46 100644 --- a/utils/idftools/idf_common.cpp +++ b/utils/idftools/idf_common.cpp @@ -312,7 +312,7 @@ void IDF_NOTE::GetSize( double& aHeight, double& aLength ) /* - * CLASS: IDF_DRILL_DATA + * IDF_DRILL_DATA */ IDF_DRILL_DATA::IDF_DRILL_DATA() { diff --git a/utils/idftools/idf_common.h b/utils/idftools/idf_common.h index 8dda141a9e..632ce2af3a 100644 --- a/utils/idftools/idf_common.h +++ b/utils/idftools/idf_common.h @@ -256,7 +256,7 @@ namespace IDF3 { /** - * Class IDF_NOTE + * IDF_NOTE * represents an entry in the NOTE section of an IDF file */ class IDF_NOTE diff --git a/utils/idftools/idf_outlines.cpp b/utils/idftools/idf_outlines.cpp index 1cef84e225..7ffdcba0bc 100644 --- a/utils/idftools/idf_outlines.cpp +++ b/utils/idftools/idf_outlines.cpp @@ -128,7 +128,7 @@ static bool CheckOwnership( int aSourceLine, const char* aSourceFunc, /* - * CLASS: BOARD OUTLINE + * BOARD OUTLINE */ BOARD_OUTLINE::BOARD_OUTLINE() { @@ -1545,7 +1545,7 @@ void BOARD_OUTLINE::ClearComments( void ) /* - * CLASS: OTHER_OUTLINE + * OTHER_OUTLINE */ OTHER_OUTLINE::OTHER_OUTLINE( IDF3_BOARD* aParent ) { @@ -1944,7 +1944,7 @@ bool OTHER_OUTLINE::Clear( void ) /* - * CLASS: ROUTE_OUTLINE + * ROUTE_OUTLINE */ ROUTE_OUTLINE::ROUTE_OUTLINE( IDF3_BOARD* aParent ) { @@ -2236,7 +2236,7 @@ bool ROUTE_OUTLINE::Clear( void ) /* - * CLASS: PLACE_OUTLINE + * PLACE_OUTLINE */ PLACE_OUTLINE::PLACE_OUTLINE( IDF3_BOARD* aParent ) { @@ -2640,7 +2640,7 @@ bool PLACE_OUTLINE::Clear( void ) /* - * CLASS: ROUTE_KEEPOUT + * ROUTE_KEEPOUT */ ROUTE_KO_OUTLINE::ROUTE_KO_OUTLINE( IDF3_BOARD* aParent ) : ROUTE_OUTLINE( aParent ) @@ -2651,7 +2651,7 @@ ROUTE_KO_OUTLINE::ROUTE_KO_OUTLINE( IDF3_BOARD* aParent ) /* - * CLASS: PLACE_KEEPOUT + * PLACE_KEEPOUT */ PLACE_KO_OUTLINE::PLACE_KO_OUTLINE( IDF3_BOARD* aParent ) : PLACE_OUTLINE( aParent ) @@ -2662,7 +2662,7 @@ PLACE_KO_OUTLINE::PLACE_KO_OUTLINE( IDF3_BOARD* aParent ) /* - * CLASS: VIA_KEEPOUT + * VIA_KEEPOUT */ VIA_KO_OUTLINE::VIA_KO_OUTLINE( IDF3_BOARD* aParent ) : OTHER_OUTLINE( aParent ) @@ -2673,7 +2673,7 @@ VIA_KO_OUTLINE::VIA_KO_OUTLINE( IDF3_BOARD* aParent ) /* - * CLASS: PLACEMENT GROUP (PLACE_REGION) + * PLACEMENT GROUP (PLACE_REGION) */ GROUP_OUTLINE::GROUP_OUTLINE( IDF3_BOARD* aParent ) { @@ -2963,7 +2963,7 @@ bool GROUP_OUTLINE::Clear( void ) } /* - * CLASS: COMPONENT OUTLINE + * COMPONENT OUTLINE */ IDF3_COMP_OUTLINE::IDF3_COMP_OUTLINE( IDF3_BOARD* aParent ) { diff --git a/utils/idftools/idf_outlines.h b/utils/idftools/idf_outlines.h index 36f1905130..63768dd263 100644 --- a/utils/idftools/idf_outlines.h +++ b/utils/idftools/idf_outlines.h @@ -84,7 +84,7 @@ class IDF3_BOARD; /** - * Class BOARD_OUTLINE + * BOARD_OUTLINE * supports the IDFv3 BOARD OUTLINE data and is the basis of other IDFv3 outline classes */ class BOARD_OUTLINE @@ -343,7 +343,7 @@ public: /** - * Class OTHER_OUTLINE + * OTHER_OUTLINE * describes miscellaneous extrusions on the board */ class OTHER_OUTLINE : public BOARD_OUTLINE @@ -414,7 +414,7 @@ public: /** - * Class ROUTE_OUTLINE + * ROUTE_OUTLINE * describes routing areas on the board */ class ROUTE_OUTLINE : public BOARD_OUTLINE @@ -466,7 +466,7 @@ public: }; /** - * Class PLACE_OUTLINE + * PLACE_OUTLINE * describes areas on the board for placing components */ class PLACE_OUTLINE : public BOARD_OUTLINE @@ -537,7 +537,7 @@ public: /** - * Class ROUTE_KO_OUTLINE + * ROUTE_KO_OUTLINE * describes regions and layers where no electrical routing is permitted */ class ROUTE_KO_OUTLINE : public ROUTE_OUTLINE @@ -547,7 +547,7 @@ public: }; /** - * Class VIA_KO_OUTLINE + * VIA_KO_OUTLINE * describes regions in which vias are prohibited. Note: IDFv3 only considers * thru-hole vias and makes no statement regarding behavior with blind or buried * vias. @@ -560,7 +560,7 @@ public: /** - * Class PLACE_KO_OUTLINE + * PLACE_KO_OUTLINE * represents regions and layers in which no component may * be placed or on which a maximum component height is in effect. */ @@ -571,7 +571,7 @@ public: }; /** - * Class GROUP_OUTLINE + * GROUP_OUTLINE * represents regions and layers in which user-specified features or components * may be placed. */ @@ -643,7 +643,7 @@ public: /** - * class IDF3_COMP_OUTLINE + * IDF3_COMP_OUTLINE * represents a component's outline as stored in an IDF library file */ class IDF3_COMP_OUTLINE : public BOARD_OUTLINE diff --git a/utils/idftools/idf_parser.cpp b/utils/idftools/idf_parser.cpp index 3ea410e4e3..1cfe166531 100644 --- a/utils/idftools/idf_parser.cpp +++ b/utils/idftools/idf_parser.cpp @@ -82,7 +82,7 @@ static bool MatchCompOutline( IDF3_COMP_OUTLINE* aOutlineA, IDF3_COMP_OUTLINE* a /* - * CLASS: IDF3_COMP_OUTLINE_DATA + * IDF3_COMP_OUTLINE_DATA * This represents the outline placement * information and other data specific to * each component instance. @@ -816,7 +816,7 @@ void IDF3_COMP_OUTLINE_DATA::writePlaceData( std::ostream& aBoardFile, /* - * CLASS: IDF3_COMPONENT + * IDF3_COMPONENT * * This represents a component and its associated * IDF outlines and ancillary data (position, etc)