Comment-only changes

Makes class comments conform to coding standards
2025-04-04 23:05:30 +00:00 · 2020-01-10 06:31:00 -08:00 · 2020-01-10 06:31:00 -08:00 · 7c28c3838a
commit 7c28c3838a
parent 2a780dba0e
307 changed files with 443 additions and 443 deletions
--- 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.
--- 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
--- a/3d-viewer/3d_canvas/status_text_reporter.h
+++ b/3d-viewer/3d_canvas/status_text_reporter.h
@ -32,7 +32,7 @@
 #include <reporter.h>
 
 /**
- * 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
--- 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
--- 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 <fctsys.h>     // For the DBG(

 /**
- * Class CBBOX
+ * CBBOX
 * manages a bounding box defined by two SFVEC3F min max points.
 */
 struct CBBOX
--- 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
--- 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.
 */
--- 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 )
--- 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
--- 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.
 */
--- 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
 */
--- 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
--- 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.
--- 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.
 */
--- 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.
 */
--- 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.
 */
--- 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.
 */
--- a/eeschema/dialog_erc_listbox.h
+++ b/eeschema/dialog_erc_listbox.h
@ -32,7 +32,7 @@
 #include <wx/html/htmlwin.h>

 /**
- * Class ERC_HTML_LISTFRAME
+ * ERC_HTML_LISTFRAME
 * is used to display a DRC_ITEM_LIST.
 */
 class ERC_HTML_LISTFRAME : public wxHtmlWindow
--- 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
--- 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.
 * <p>
 * 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.
 * <p>
 * @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.
 * <p>
 * @note Use ShowQuasiModal when calling this class!
--- a/eeschema/ee_collectors.h
+++ b/eeschema/ee_collectors.h
@ -34,7 +34,7 @@


 /**
- * Class EE_COLLECTOR
+ * EE_COLLECTOR
 */
 class EE_COLLECTOR : public COLLECTOR
 {
--- 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
--- a/eeschema/netlist_exporters/netlist_exporter.h
+++ b/eeschema/netlist_exporters/netlist_exporter.h
@ -36,7 +36,7 @@
 #include <sch_sheet.h>

 /**
- * 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
--- 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
--- 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.
 */
--- a/Show More
+++ b/Show More