From 4b853dedb45d4eed040644b5514745cd66db3226 Mon Sep 17 00:00:00 2001
From: Wayne Stambaugh <stambaughw@verizon.net>
Date: Fri, 30 Sep 2011 14:15:37 -0400
Subject: [PATCH] Application name capitalization fixes.
* Correct all user strings and comments for the correct capitalization of
application names according to JP. They are KiCad, Pcbnew, CvPcb,
Eeschema, and GerbView.
* Add a note the the user interface policy about the correct capitalization.
---
Documentation/guidelines/UIpolicies.txt | 10 +++-
common/base_struct.cpp | 9 ++--
common/basicframe.cpp | 4 +-
common/bitmap.cpp | 4 +-
common/block_commande.cpp | 8 ++--
common/build_version.cpp | 2 +-
common/class_bitmap_base.cpp | 10 ++--
common/class_colors_design_settings.cpp | 12 ++---
common/class_marker_base.cpp | 10 ++--
common/class_undoredo_container.cpp | 4 +-
common/common.cpp | 22 ++++-----
common/common_plotDXF_functions.cpp | 7 +--
common/common_plotHPGL_functions.cpp | 7 +--
common/common_plotPS_functions.cpp | 7 +--
common/common_plot_functions.cpp | 9 ++--
common/copy_to_clipboard.cpp | 2 +-
common/dialogs/dialog_page_settings.cpp | 8 ++--
common/dlist.cpp | 4 +-
common/drawframe.cpp | 4 +-
common/drawpanel.cpp | 2 +-
common/drawtxt.cpp | 2 +-
common/dsnlexer.cpp | 4 +-
common/eda_doc.cpp | 4 +-
common/edaappl.cpp | 16 +++----
common/filter_reader.cpp | 4 +-
common/footprint_info.cpp | 2 +-
common/gestfich.cpp | 48 +++++++++----------
common/gr_basic.cpp | 4 +-
common/hotkeys_basic.cpp | 4 +-
common/newstroke_font.cpp | 4 +-
common/pcbcommon.cpp | 8 ++--
common/projet_config.cpp | 4 +-
common/richio.cpp | 4 +-
common/sch_item_struct.cpp | 2 +-
common/xnode.cpp | 4 +-
cvpcb/autosel.cpp | 6 +--
cvpcb/class_DisplayFootprintsFrame.cpp | 11 +++--
cvpcb/class_DisplayFootprintsFrame.h | 4 +-
cvpcb/cvframe.cpp | 2 +-
cvpcb/cvpcb.cpp | 10 ++--
cvpcb/init.cpp | 2 +-
cvpcb/loadcmp.cpp | 2 +-
cvpcb/menubar.cpp | 4 +-
cvpcb/readschematicnetlist.cpp | 2 +-
cvpcb/savecmp.cpp | 2 +-
cvpcb/setvisu.cpp | 4 +-
cvpcb/tool_cvpcb.cpp | 2 +-
cvpcb/writenetlistpcbnew.cpp | 2 +-
eeschema/backanno.cpp | 10 ++--
eeschema/block.cpp | 2 +-
eeschema/class_drc_erc_item.cpp | 4 +-
eeschema/class_libentry.h | 2 +-
eeschema/class_library.cpp | 2 +-
eeschema/component_references_lister.cpp | 4 +-
eeschema/controle.cpp | 4 +-
eeschema/cross-probing.cpp | 24 +++++-----
eeschema/database.cpp | 6 +--
eeschema/dialogs/annotate_dialog.cpp | 11 ++---
eeschema/dialogs/dialog_build_BOM.cpp | 2 +-
eeschema/dialogs/dialog_color_config.cpp | 2 +-
eeschema/dialogs/dialog_eeschema_config.cpp | 2 +-
.../dialogs/dialog_plot_schematic_DXF.cpp | 4 +-
.../dialogs/dialog_plot_schematic_HPGL.cpp | 6 +--
eeschema/dialogs/dialog_plot_schematic_PS.cpp | 4 +-
eeschema/edit_bitmap.cpp | 10 ++--
eeschema/eeschema.cpp | 25 +++++-----
eeschema/eeschema_id.h | 4 +-
eeschema/erc.h | 4 +-
eeschema/find.cpp | 7 +--
eeschema/general.h | 5 +-
eeschema/hotkeys.cpp | 10 ++--
eeschema/hotkeys.h | 2 +-
eeschema/lib_circle.cpp | 9 ++--
eeschema/lib_collectors.cpp | 4 +-
eeschema/lib_collectors.h | 4 +-
eeschema/lib_draw_item.h | 2 +-
eeschema/lib_export.cpp | 13 ++---
eeschema/lib_text.h | 2 +-
eeschema/libedit.cpp | 7 +--
eeschema/libedit_onleftclick.cpp | 8 ++--
eeschema/libedit_plot_component.cpp | 6 +--
eeschema/libeditframe.cpp | 7 ++-
eeschema/load_one_schematic_file.cpp | 23 ++++-----
eeschema/menubar.cpp | 16 +++----
eeschema/menubar_libedit.cpp | 8 ++--
eeschema/netform.cpp | 9 ++--
eeschema/netlist.h | 10 ++--
eeschema/netlist_control.cpp | 11 +++--
eeschema/pinedit.cpp | 7 +--
eeschema/sch_bitmap.cpp | 12 ++---
eeschema/sch_bitmap.h | 4 +-
eeschema/sch_bus_entry.cpp | 2 +-
eeschema/sch_collectors.cpp | 8 +++-
eeschema/sch_collectors.h | 8 +++-
eeschema/sch_component.cpp | 6 +--
eeschema/sch_component.h | 7 +--
eeschema/sch_field.h | 7 +--
eeschema/sch_junction.cpp | 2 +-
eeschema/sch_line.cpp | 4 +-
eeschema/sch_no_connect.cpp | 2 +-
eeschema/sch_polyline.cpp | 4 +-
eeschema/sch_screen.cpp | 2 +-
eeschema/sch_sheet.cpp | 10 ++--
eeschema/sch_sheet.h | 7 +--
eeschema/sch_sheet_path.h | 11 +++--
eeschema/sch_sheet_pin.cpp | 2 +-
eeschema/sch_text.cpp | 24 +++++-----
eeschema/sch_text.h | 7 +--
eeschema/schematic_undo_redo.cpp | 7 +--
eeschema/selpart.cpp | 6 +--
eeschema/symbdraw.cpp | 9 ++--
eeschema/template_fieldnames.cpp | 2 +-
eeschema/tool_sch.cpp | 4 +-
eeschema/transform.h | 7 ++-
eeschema/viewlib_frame.cpp | 2 +-
eeschema/viewlibs.cpp | 6 +--
gerbview/block.cpp | 11 +++--
gerbview/class_GERBER.cpp | 7 +--
gerbview/class_GERBER.h | 4 +-
gerbview/class_am_param.cpp | 10 ++--
gerbview/class_am_param.h | 10 ++--
gerbview/class_aperture_macro.cpp | 13 +++--
gerbview/class_aperture_macro.h | 10 ++--
gerbview/class_gerber_draw_item.cpp | 10 ++--
gerbview/class_gerber_draw_item.h | 10 ++--
gerbview/class_gerbview_layer_widget.cpp | 15 +++---
gerbview/class_gerbview_layer_widget.h | 6 +--
gerbview/dcode.h | 10 ++--
.../dialogs/dialog_print_using_printer.cpp | 4 +-
.../gerbview_dialog_display_options_frame.cpp | 2 +-
gerbview/draw_gerber_screen.cpp | 10 ++--
gerbview/events_called_functions.cpp | 2 +-
gerbview/excellon_read_drill_file.cpp | 10 ++--
gerbview/export_to_pcbnew.cpp | 8 ++--
gerbview/files.cpp | 4 +-
gerbview/gerbview_config.cpp | 10 ++--
gerbview/gerbview_frame.cpp | 2 +-
gerbview/gerbview_frame.h | 26 +++++-----
gerbview/gerbview_id.h | 6 +--
gerbview/hotkeys.cpp | 3 +-
gerbview/hotkeys.h | 2 +-
gerbview/menubar.cpp | 12 ++---
gerbview/options.cpp | 9 ++--
gerbview/readgerb.cpp | 4 +-
gerbview/rs274d.cpp | 2 +-
gerbview/rs274x.cpp | 4 +-
gerbview/select_layers_to_pcb.cpp | 14 +++---
gerbview/toolbars_gerber.cpp | 2 +-
include/appl_wxstruct.h | 18 +++----
include/base_struct.h | 12 ++---
include/class_bitmap_base.h | 8 ++--
include/class_board_design_settings.h | 2 +-
include/class_board_item.h | 4 +-
include/class_collector.h | 4 +-
include/class_colors_design_settings.h | 15 +++---
include/class_drawpanel.h | 4 +-
include/class_drc_item.h | 4 +-
include/class_sch_screen.h | 7 +--
include/class_undoredo_container.h | 8 ++--
include/colors.h | 4 +-
include/common.h | 8 ++--
include/eda_dde.h | 31 +++++++-----
include/filter_reader.h | 4 +-
include/gestfich.h | 6 +--
include/hotkeys_basic.h | 4 +-
include/id.h | 6 +--
include/kicad_device_context.h | 8 ++--
include/kicad_msvc.h | 7 +--
include/layers_id_colors_and_visibility.h | 7 +--
include/newstroke_font.h | 4 +-
include/online_help.h | 9 ++--
include/pcbstruct.h | 2 +-
include/richio.h | 4 +-
include/sch_item_struct.h | 4 +-
include/wxBasePcbFrame.h | 8 ++--
include/wxEeschemaStruct.h | 16 +++----
include/wxPcbStruct.h | 31 ++++++------
include/wxstruct.h | 40 ++++++++--------
include/xnode.h | 4 +-
kicad/class_treeproject_item.cpp | 6 +--
kicad/class_treeprojectfiles.cpp | 6 +--
kicad/commandframe.cpp | 12 ++---
kicad/files-io.cpp | 2 +-
kicad/kicad.cpp | 2 +-
kicad/kicad.h | 12 ++---
kicad/mainframe.cpp | 7 +--
kicad/menubar.cpp | 4 +-
kicad/prjconfig.cpp | 6 +--
kicad/tree_project_frame.cpp | 6 +--
kicad/tree_project_frame.h | 10 ++--
pcbnew/board_undo_redo.cpp | 4 +-
pcbnew/class_board.cpp | 4 +-
pcbnew/class_board.h | 4 +-
pcbnew/class_board_design_settings.cpp | 4 +-
pcbnew/class_drc_item.cpp | 4 +-
pcbnew/class_netclass.cpp | 4 +-
pcbnew/class_netclass.h | 4 +-
pcbnew/class_netinfo.h | 2 +-
pcbnew/class_pad.h | 2 +-
pcbnew/class_pad_draw_functions.cpp | 4 +-
pcbnew/class_pcb_layer_widget.cpp | 8 ++--
pcbnew/class_pcb_layer_widget.h | 4 +-
pcbnew/class_text_mod.cpp | 4 +-
pcbnew/class_track.cpp | 4 +-
pcbnew/classpcb.cpp | 13 ++---
pcbnew/collectors.cpp | 4 +-
pcbnew/collectors.h | 4 +-
pcbnew/cross-probing.cpp | 27 ++++++-----
pcbnew/debug_kbool_key_file_fct.cpp | 2 +-
pcbnew/dialogs/dialog_copper_zones.cpp | 2 +-
pcbnew/dialogs/dialog_design_rules.cpp | 10 ++--
pcbnew/dialogs/dialog_gendrill.cpp | 8 ++--
pcbnew/dialogs/dialog_gendrill.h | 4 +-
.../dialog_global_edit_tracks_and_vias.h | 4 +-
pcbnew/dialogs/dialog_graphic_items_options.h | 11 +++--
pcbnew/dialogs/dialog_layers_setup.cpp | 4 +-
pcbnew/dialogs/dialog_orient_footprints.cpp | 4 +-
pcbnew/dialogs/dialog_pcb_text_properties.cpp | 4 +-
.../dialog_pcbnew_config_libs_and_paths.cpp | 2 +-
pcbnew/dialogs/dialog_print_using_printer.cpp | 6 +--
pcbnew/drc.cpp | 4 +-
pcbnew/drc_clearance_test_functions.cpp | 6 +--
pcbnew/drc_marker_functions.cpp | 9 ++--
pcbnew/drc_stuff.h | 4 +-
pcbnew/export_gencad.cpp | 8 +++-
pcbnew/export_vrml.cpp | 4 +-
pcbnew/files.cpp | 12 ++---
pcbnew/find.cpp | 7 +--
pcbnew/gen_modules_placefile.cpp | 4 +-
pcbnew/gendrill.cpp | 10 ++--
pcbnew/gendrill.h | 4 +-
pcbnew/gpcb_exchange.cpp | 8 ++--
pcbnew/hotkeys.cpp | 4 +-
pcbnew/ioascii.cpp | 6 +--
pcbnew/layer_widget.cpp | 8 ++--
pcbnew/layer_widget.h | 6 +--
pcbnew/librairi.cpp | 4 +-
pcbnew/loadcmp.cpp | 2 +-
pcbnew/menubar_modedit.cpp | 8 ++--
pcbnew/menubar_pcbframe.cpp | 20 ++++----
pcbnew/modeditoptions.cpp | 7 +--
pcbnew/netlist.cpp | 8 ++--
pcbnew/pcb_plot_params.cpp | 4 +-
pcbnew/pcb_plot_params.h | 4 +-
pcbnew/pcbframe.cpp | 4 +-
pcbnew/pcbnew.cpp | 25 +++++-----
pcbnew/pcbnew.h | 8 ++--
pcbnew/pcbnew_config.cpp | 2 +-
pcbnew/pcbnew_config.h | 7 +--
pcbnew/pcbnew_id.h | 4 +-
pcbnew/pcbplot.cpp | 2 +-
pcbnew/plotgerb.cpp | 4 +-
pcbnew/polygons_defs.h | 2 +-
pcbnew/printout_controler.cpp | 2 +-
pcbnew/specctra.cpp | 10 ++--
pcbnew/specctra.h | 16 +++----
pcbnew/specctra_export.cpp | 18 +++----
pcbnew/specctra_import.cpp | 20 ++++----
pcbnew/specctra_test.cpp | 4 +-
pcbnew/surbrill.cpp | 2 +-
pcbnew/xchgmod.cpp | 2 +-
pcbnew/zones_by_polygon_fill_functions.cpp | 4 +-
pcbnew/zones_functions_for_undo_redo.cpp | 4 +-
pcbnew/zones_functions_for_undo_redo.h | 11 +++--
pcbnew/zones_test_and_combine_areas.cpp | 2 +-
265 files changed, 959 insertions(+), 924 deletions(-)
diff --git a/Documentation/guidelines/UIpolicies.txt b/Documentation/guidelines/UIpolicies.txt
index a604bdd674..a84928f6ec 100644
--- a/Documentation/guidelines/UIpolicies.txt
+++ b/Documentation/guidelines/UIpolicies.txt
@@ -1,13 +1,19 @@
-** General UI Guidelines for KICAD Development
+** General UI Guidelines for KiCad Development
Capitalization:
- For any visible text used within Kicad, follow recommendations here:
+ For any visible text used within KiCad, follow recommendations here:
http://library.gnome.org/devel/hig-book/2.20/design-text-labels.html.en#layout-capitalization
This applies to all Menus, Titles, Labels, Tooltips, Buttons, etc.
+ The capitalization for the application names is KiCad, Eeschema, CvPcb,
+ GerbView, and Pcbnew. All strings that have application names that are
+ visible to the user should be capitalized this way. It's also a good
+ idea use this capitalization in source code comments as well to prevent
+ confusion of new contributors.
+
Dialogs:
diff --git a/common/base_struct.cpp b/common/base_struct.cpp
index 06639105e8..6858346a1f 100644
--- a/common/base_struct.cpp
+++ b/common/base_struct.cpp
@@ -1,8 +1,7 @@
-/**********************************/
-/* Basic classes for Kicad: */
-/* EDA_ITEM */
-/* EDA_TEXT */
-/**********************************/
+/**
+ * @file base_struct.cpp
+ * @brief Implementation of EDA_ITEM and EDA_TEXT base classes for KiCad.
+ */
#include "fctsys.h"
#include "gr_basic.h"
diff --git a/common/basicframe.cpp b/common/basicframe.cpp
index 162d09db6a..ae4a16b6d0 100644
--- a/common/basicframe.cpp
+++ b/common/basicframe.cpp
@@ -261,7 +261,7 @@ void EDA_BASE_FRAME::GetKicadHelp( wxCommandEvent& event )
* or the the full specific doc
* if event id is wxID_INDEX, we want the document for beginners.
* else the specific doc file (its name is in wxGetApp().m_HelpFileName)
- * The document for beginners is the same for all kicad utilities
+ * The document for beginners is the same for all KiCad utilities
*/
if( event.GetId() == wxID_INDEX )
{
@@ -318,7 +318,7 @@ void EDA_BASE_FRAME::GetKicadHelp( wxCommandEvent& event )
/*
* Function OnSelectPreferredEditor
- * Open a dialog to select the preferred editor that will be used in Kicad
+ * Open a dialog to select the preferred editor that will be used in KiCad
* to edit or display files (reports ... )
* The full filename editor is saved in configuration (global params)
*/
diff --git a/common/bitmap.cpp b/common/bitmap.cpp
index 0736faba97..c8e7d447c0 100644
--- a/common/bitmap.cpp
+++ b/common/bitmap.cpp
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2011 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/common/block_commande.cpp b/common/block_commande.cpp
index dfeae5066a..4c14ce74bd 100644
--- a/common/block_commande.cpp
+++ b/common/block_commande.cpp
@@ -1,7 +1,7 @@
-/********************************************/
-/* Routines for managing on block commands. */
-/* (Common section Eeschema / pcbnew ... */
-/********************************************/
+/**
+ * @file block_commande.cpp
+ * @brief Common routines for managing on block commands.
+ */
#include "fctsys.h"
#include "gr_basic.h"
diff --git a/common/build_version.cpp b/common/build_version.cpp
index 1e0ac76c58..4202ebfab1 100644
--- a/common/build_version.cpp
+++ b/common/build_version.cpp
@@ -1,4 +1,4 @@
-/* Date for kicad build version */
+/* Date for KiCad build version */
#include "fctsys.h"
#ifdef HAVE_SVN_VERSION
diff --git a/common/class_bitmap_base.cpp b/common/class_bitmap_base.cpp
index c645b40705..ebca19d945 100644
--- a/common/class_bitmap_base.cpp
+++ b/common/class_bitmap_base.cpp
@@ -1,12 +1,12 @@
-/********************/
-/* sch_bitmap.cpp */
-/********************/
+/**
+ * @file sch_bitmap.cpp
+ */
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2011 jean-pierre.charras
- * Copyright (C) 2011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/common/class_colors_design_settings.cpp b/common/class_colors_design_settings.cpp
index 9812d04d04..224963aba3 100644
--- a/common/class_colors_design_settings.cpp
+++ b/common/class_colors_design_settings.cpp
@@ -1,7 +1,7 @@
-/****************************************************/
-/* class_colors_design_settings.cpp */
-/* handle colors used to draw all items or layers */
-/****************************************************/
+/**
+ * @file class_colors_design_settings.cpp
+ * @brief Handle colors used to draw all items or layers.
+ */
#include "fctsys.h"
#include "colors.h"
#include "macros.h"
@@ -9,10 +9,10 @@
#include "class_colors_design_settings.h"
/* Class for handle list of color settings for designs
- * in Eeschema, Pcbnew and gerbview
+ * in Eeschema, Pcbnew and GerbView
*/
-/* Initial colors values: optimized for pcbnew, but are also Ok for eeschema
+/* Initial colors values: optimized for Pcbnew, but are also Ok for Eeschema
* these values are superseded by config reading
*/
static const int default_layer_color[LAYERSCOLORSBUFFERSIZE] =
diff --git a/common/class_marker_base.cpp b/common/class_marker_base.cpp
index 5685e946da..9de65efc59 100644
--- a/common/class_marker_base.cpp
+++ b/common/class_marker_base.cpp
@@ -1,7 +1,9 @@
-/**********************************************************************************
-* class MARKER_BASE; markers are used to show something (usually a drc/erc problem)
-* Markers in pcbnew and eeschema are derived from this basic class
-**********************************************************************************/
+/**
+ * @file class_marker_base.cpp
+ * @brief Implementation of MARKER_BASE class.
+ * Markers are used to show something (usually a drc/erc problem).
+ * Markers in Pcbnew and Eeschema are derived from this base class.
+ */
/* file class_marker_base.cpp
*/
diff --git a/common/class_undoredo_container.cpp b/common/class_undoredo_container.cpp
index 0a2cb25091..8ab4a66243 100644
--- a/common/class_undoredo_container.cpp
+++ b/common/class_undoredo_container.cpp
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009 jean-pierre.charras@gipsa-lab.inpg.fr
* Copyright (C) 2011 Wayne Stambaugh <stambaughw@verizon.net>
- * Copyright (C) 2009 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2009 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/common/common.cpp b/common/common.cpp
index fb48935876..37d9c41a87 100644
--- a/common/common.cpp
+++ b/common/common.cpp
@@ -62,13 +62,13 @@ const wxString PdfFileExtension( wxT( "pdf" ) );
const wxString MacrosFileExtension( wxT( "mcr" ) );
/* Proper wxFileDialog wild card definitions. */
-const wxString ProjectFileWildcard( _( "Kicad project files (*.pro)|*.pro" ) );
-const wxString SchematicFileWildcard( _( "Kicad schematic files (*.sch)|*.sch" ) );
-const wxString NetlistFileWildcard( _( "Kicad netlist files (*.net)|*.net" ) );
+const wxString ProjectFileWildcard( _( "KiCad project files (*.pro)|*.pro" ) );
+const wxString SchematicFileWildcard( _( "KiCad schematic files (*.sch)|*.sch" ) );
+const wxString NetlistFileWildcard( _( "KiCad netlist files (*.net)|*.net" ) );
const wxString GerberFileWildcard( _( "Gerber files (*.pho)|*.pho" ) );
-const wxString PcbFileWildcard( _( "Kicad printed circuit board files (*.brd)|*.brd" ) );
+const wxString PcbFileWildcard( _( "KiCad printed circuit board files (*.brd)|*.brd" ) );
const wxString PdfFileWildcard( _( "Portable document format files (*.pdf)|*.pdf" ) );
-const wxString MacrosFileWildcard( _( "Kicad recorded macros (*.mcr)|*.mcr" ) );
+const wxString MacrosFileWildcard( _( "KiCad recorded macros (*.mcr)|*.mcr" ) );
const wxString AllFilesWildcard( _( "All files (*)|*" ) );
@@ -87,7 +87,7 @@ int g_GhostColor;
/* predefined colors used in kicad.
* Please: if you change a value, remember these values are carefully chosen
- * to have good results in pcbnew, that uses the ORed value of basic colors
+ * to have good results in Pcbnew, that uses the ORed value of basic colors
* when displaying superimposed objects
* This list must have exactly NBCOLOR items
*/
@@ -133,7 +133,7 @@ bool g_DisableFloatingPointLocalNotation = false;
/**
* Function SetLocaleTo_C_standard
- * because kicad is internationalized, switch internalization to "C" standard
+ * because KiCad is internationalized, switch internalization to "C" standard
* i.e. uses the . (dot) as separator in print/read float numbers
* (some countries (France, Germany ..) use , (comma) as separator)
* This function must be called before read or write ascii files using float
@@ -141,7 +141,7 @@ bool g_DisableFloatingPointLocalNotation = false;
* reading or writing the file
*
* This is wrapper to the C setlocale( LC_NUMERIC, "C" ) function,
- * but could make more easier an optional use of locale in kicad
+ * but could make more easier an optional use of locale in KiCad
*/
void SetLocaleTo_C_standard( void )
{
@@ -151,13 +151,13 @@ void SetLocaleTo_C_standard( void )
/**
* Function SetLocaleTo_Default
- * because kicad is internationalized, switch internalization to default
+ * because KiCad is internationalized, switch internalization to default
* to use the default separator in print/read float numbers
* (. (dot) but some countries (France, Germany ..) use , (comma) as separator)
* This function must be called after a call to SetLocaleTo_C_standard
*
* This is wrapper to the C setlocale( LC_NUMERIC, "" ) function,
- * but could make more easier an optional use of locale in kicad
+ * but could make more easier an optional use of locale in KiCad
*/
void SetLocaleTo_Default( void )
{
@@ -355,7 +355,7 @@ wxString ReturnStringFromValue( EDA_UNITS_T aUnit, int aValue, int aInternal_Uni
double value_to_print;
value_to_print = To_User_Unit( aUnit, aValue, aInternal_Unit );
- /* Yet another 'if pcbnew' :( */
+ /* Yet another 'if Pcbnew' :( */
StringValue.Printf( ( aInternal_Unit > 1000 ) ? wxT( "%.4f" ) :
wxT( "%.3f" ),
value_to_print );
diff --git a/common/common_plotDXF_functions.cpp b/common/common_plotDXF_functions.cpp
index 531fd5a254..85a50b6790 100644
--- a/common/common_plotDXF_functions.cpp
+++ b/common/common_plotDXF_functions.cpp
@@ -1,6 +1,7 @@
-/***********************************/
-/* Kicad: Common plot DXF Routines */
-/***********************************/
+/**
+ * @file common_plotDXF_functions.cpp
+ * @brief KiCad: Common plot DXF Routines.
+ */
#include "fctsys.h"
#include "gr_basic.h"
diff --git a/common/common_plotHPGL_functions.cpp b/common/common_plotHPGL_functions.cpp
index 2a59ae2fb4..0f85c9ecec 100644
--- a/common/common_plotHPGL_functions.cpp
+++ b/common/common_plotHPGL_functions.cpp
@@ -1,6 +1,7 @@
-/************************************/
-/* Kicad: Common plot HPGL Routines */
-/************************************/
+/**
+ * @file common_plotHPGL_functions.cpp
+ * @brief KiCad: Common plot HPGL Routines
+ */
#include "fctsys.h"
#include "gr_basic.h"
diff --git a/common/common_plotPS_functions.cpp b/common/common_plotPS_functions.cpp
index d6ba40c404..ca195ec38d 100644
--- a/common/common_plotPS_functions.cpp
+++ b/common/common_plotPS_functions.cpp
@@ -1,6 +1,7 @@
-/******************************************/
-/* Kicad: Common plot Postscript Routines */
-/******************************************/
+/**
+ * @file common_plotPS_functions.cpp
+ * @brief Kicad: Common plot Postscript Routines
+ */
#include "fctsys.h"
#include "trigo.h"
diff --git a/common/common_plot_functions.cpp b/common/common_plot_functions.cpp
index 5b3a08bbbd..d1156541ae 100644
--- a/common/common_plot_functions.cpp
+++ b/common/common_plot_functions.cpp
@@ -1,6 +1,7 @@
-/******************************************/
-/* Kicad: Common plot Postscript Routines */
-/******************************************/
+/**
+ * @file common_plot_functions.cpp
+ * @brief Kicad: Common plot Postscript Routines
+ */
#include "fctsys.h"
#include "gr_basic.h"
@@ -28,7 +29,7 @@ void EDA_DRAW_FRAME::PlotWorkSheet( PLOTTER* plotter, BASE_SCREEN* screen )
EDA_Colors color;
/* Scale to convert dimension in 1/1000 in into internal units
- * (1/1000 inc for EESchema, 1/10000 for pcbnew. */
+ * (1/1000 inc for Eeschema, 1/10000 for Pcbnew. */
int conv_unit = screen->GetInternalUnits() / 1000;
wxString msg;
wxSize text_size;
diff --git a/common/copy_to_clipboard.cpp b/common/copy_to_clipboard.cpp
index 3a60cfe107..6354734115 100644
--- a/common/copy_to_clipboard.cpp
+++ b/common/copy_to_clipboard.cpp
@@ -37,7 +37,7 @@ void EDA_DRAW_FRAME::CopyToClipboard( wxCommandEvent& event )
/* copy the current page or block to the clipboard ,
* to export drawings to other applications (word processing ...)
- * This is not suitable for copy command within eeschema or pcbnew
+ * This is not suitable for copy command within Eeschema or Pcbnew
*/
bool DrawPageOnClipboard( EDA_DRAW_FRAME* aFrame )
{
diff --git a/common/dialogs/dialog_page_settings.cpp b/common/dialogs/dialog_page_settings.cpp
index 14262ccb61..62acefc5bc 100644
--- a/common/dialogs/dialog_page_settings.cpp
+++ b/common/dialogs/dialog_page_settings.cpp
@@ -1,10 +1,10 @@
-/////////////////////////////////////////////////////////////////////////////
-// Name: dialog_page_settings.cpp
-/////////////////////////////////////////////////////////////////////////////
+/**
+ * @file dialog_page_settings.cpp
+ */
/* The "Page Settings" dialog box created by this file (and setpage.h)
* contains seven checkboxes which *are* shown when that dialog box is
- * invoked in EESchema, but which are *not* shown when that dialog box is
+ * invoked in Eeschema, but which are *not* shown when that dialog box is
* invoked in Pcbnew instead.
*/
diff --git a/common/dlist.cpp b/common/dlist.cpp
index 1b0025ddc0..e802406e84 100644
--- a/common/dlist.cpp
+++ b/common/dlist.cpp
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2008 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 1992-2008 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2008 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/common/drawframe.cpp b/common/drawframe.cpp
index b6dde7881e..8c92cac215 100644
--- a/common/drawframe.cpp
+++ b/common/drawframe.cpp
@@ -675,14 +675,14 @@ void EDA_DRAW_FRAME::UpdateStatusBar()
* Converting from inches to mm can give some coordinates due to
* float point precision rounding errors, like 1.999 or 2.001 so
* round to the nearest drawing precision required by the application.
- */
+ */
if ( g_UserUnit == MILLIMETRES )
{
dXpos = RoundTo0( dXpos, (double)( m_InternalUnits / 10 ) );
dYpos = RoundTo0( dYpos, (double)( m_InternalUnits / 10 ) );
}
- /* The following sadly is an if eeschema/if pcbnew */
+ /* The following sadly is an if Eeschema/if Pcbnew */
wxString absformatter;
wxString locformatter;
switch( g_UserUnit )
diff --git a/common/drawpanel.cpp b/common/drawpanel.cpp
index 5effb28fb4..474ee178a6 100644
--- a/common/drawpanel.cpp
+++ b/common/drawpanel.cpp
@@ -807,7 +807,7 @@ void EDA_DRAW_PANEL::OnMouseWheel( wxMouseEvent& event )
void EDA_DRAW_PANEL::OnMouseEvent( wxMouseEvent& event )
{
/* Used to inhibit a response to a mouse left button release, after a double click
- * (when releasing the left button at the end of the second click. Used in eeschema
+ * (when releasing the left button at the end of the second click. Used in Eeschema
* to inhibit a mouse left release command when switching between hierarchical sheets
* on a double click.
*/
diff --git a/common/drawtxt.cpp b/common/drawtxt.cpp
index 8cf6300861..03a03f6244 100644
--- a/common/drawtxt.cpp
+++ b/common/drawtxt.cpp
@@ -103,7 +103,7 @@ int NegableTextLength( const wxString& aText )
/* Function GetHersheyShapeDescription
* return a pointer to the shape corresponding to unicode value AsciiCode
* Note we use the same font for Bold and Normal texts
- * because kicad handles a variable pen size to do that
+ * because KiCad handles a variable pen size to do that
* that gives better results in XOR draw mode.
*/
static const char* GetHersheyShapeDescription( int AsciiCode )
diff --git a/common/dsnlexer.cpp b/common/dsnlexer.cpp
index 4e5a8b2749..512c542eed 100644
--- a/common/dsnlexer.cpp
+++ b/common/dsnlexer.cpp
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2008 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/common/eda_doc.cpp b/common/eda_doc.cpp
index 037d7d6421..a5ddd91e39 100644
--- a/common/eda_doc.cpp
+++ b/common/eda_doc.cpp
@@ -52,14 +52,14 @@ static const wxFileTypeInfo EDAfallbacks[] =
wxFileTypeInfo( wxT( "text/html" ),
wxT( "wxhtml %s" ),
wxT( "wxhtml %s" ),
- wxT( "html document (from Kicad)" ),
+ wxT( "html document (from KiCad)" ),
wxT( "htm" ),
wxT( "html" ),wxNullPtr ),
wxFileTypeInfo( wxT( "application/sch" ),
wxT( "eeschema %s" ),
wxT( "eeschema -p %s" ),
- wxT( "sch document (from Kicad)" ),
+ wxT( "sch document (from KiCad)" ),
wxT( "sch" ),
wxT( "SCH" ), wxNullPtr ),
diff --git a/common/edaappl.cpp b/common/edaappl.cpp
index e2c1fd784c..6d71aeab19 100644
--- a/common/edaappl.cpp
+++ b/common/edaappl.cpp
@@ -278,7 +278,7 @@ void EDA_APP::InitEDA_Appl( const wxString& aName, EDA_APP_T aId )
m_Id = aId;
m_Checker = new wxSingleInstanceChecker( aName.Lower() + wxT( "-" ) + wxGetUserId() );
- /* Init kicad environment
+ /* Init KiCad environment
* the environment variable KICAD (if exists) gives the kicad path:
* something like set KICAD=d:\kicad
*/
@@ -303,7 +303,7 @@ void EDA_APP::InitEDA_Appl( const wxString& aName, EDA_APP_T aId )
#endif
/* Init parameters for configuration */
- SetVendorName( wxT( "kicad" ) );
+ SetVendorName( wxT( "KiCad" ) );
SetAppName( aName.Lower() );
SetTitle( aName );
m_EDA_Config = new wxConfig();
@@ -363,7 +363,7 @@ void EDA_APP::InitOnLineHelp()
wxHF_PRINT | wxHF_OPEN_FILES
/*| wxHF_SEARCH */ );
m_HtmlCtrl->UseConfig( m_EDA_CommonConfig );
- m_HtmlCtrl->SetTitleFormat( wxT( "Kicad Help" ) );
+ m_HtmlCtrl->SetTitleFormat( wxT( "KiCad Help" ) );
m_HtmlCtrl->AddBook( fullfilename );
}
@@ -597,7 +597,7 @@ void EDA_APP::SetDefaultSearchPaths( void )
fn.RemoveLastDir(); // point to <kicad path>
}
- /* Add kicad template file path to search path list. */
+ /* Add KiCad template file path to search path list. */
fn.AppendDir( wxT( "template" ) );
if( fn.IsDirReadable() )
@@ -784,7 +784,7 @@ void EDA_APP::SetLanguagePath( void )
{
wxFileName fn( m_searchPaths[i], wxEmptyString );
- // Append path for Windows and unix kicad pack install
+ // Append path for Windows and unix KiCad pack install
fn.AppendDir( wxT( "share" ) );
fn.AppendDir( wxT( "internat" ) );
@@ -897,7 +897,7 @@ wxString EDA_APP::GetHelpFile( void )
// Partially fixed, but must be enhanced
- // Create subdir tree for "standard" linux distributions, when kicad comes
+ // Create subdir tree for "standard" linux distributions, when KiCad comes
// from a distribution files are in /usr/share/doc/kicad/help and binaries
// in /usr/bin or /usr/local/bin
subdirs.Add( wxT( "share" ) );
@@ -905,9 +905,9 @@ wxString EDA_APP::GetHelpFile( void )
subdirs.Add( wxT( "kicad" ) );
subdirs.Add( _T( "help" ) );
- // Create subdir tree for linux and Windows kicad pack.
+ // Create subdir tree for linux and Windows KiCad pack.
// Note the pack form under linux is also useful if a user wants to
- // install kicad to a server because there is only one path to mount
+ // install KiCad to a server because there is only one path to mount
// or export (something like /usr/local/kicad).
// files are in <install dir>/kicad/doc/help
// (often /usr/local/kicad/kicad/doc/help)
diff --git a/common/filter_reader.cpp b/common/filter_reader.cpp
index a3367980f0..34bf971999 100644
--- a/common/filter_reader.cpp
+++ b/common/filter_reader.cpp
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/common/footprint_info.cpp b/common/footprint_info.cpp
index abc0d016b6..b2cd08b1f4 100644
--- a/common/footprint_info.cpp
+++ b/common/footprint_info.cpp
@@ -83,7 +83,7 @@ bool FOOTPRINT_LIST::ReadFootprintFiles( wxArrayString & aFootprintsLibNames )
if( strnicmp( line, FOOTPRINT_LIBRARY_HEADER, FOOTPRINT_LIBRARY_HEADER_CNT ) != 0 )
{
wxString msg;
- msg.Printf( _( "<%s> is not a valid Kicad PCB footprint library." ),
+ msg.Printf( _( "<%s> is not a valid KiCad PCB footprint library." ),
GetChars( libname ) );
m_filesInvalid << msg << wxT("\n");
continue;
diff --git a/common/gestfich.cpp b/common/gestfich.cpp
index fd84120fed..ac6cc0c950 100644
--- a/common/gestfich.cpp
+++ b/common/gestfich.cpp
@@ -1,7 +1,7 @@
-/******************************************/
-/* File: gestfich.cpp */
-/* Purpose: Functions for file management */
-/******************************************/
+/**
+ * @file gestfich.cpp
+ * @brief Functions for file management
+ */
// For compilers that support precompilation, includes "wx.h".
#include "fctsys.h"
@@ -16,39 +16,39 @@
#include "wx/filename.h"
-/* List of default paths used to locate help files and kicad library files.
+/* List of default paths used to locate help files and KiCad library files.
*
- * Under windows, kicad search its files from the binary path file (first
+ * Under windows, KiCad search its files from the binary path file (first
* argument when running "main") So for a standard install, default paths
* are not mandatory, but they exist, just in case.
- * kicad is often installed in c:/Program Files/kicad or c:/kicad (or d: or
+ * KiCad is often installed in c:/Program Files/kicad or c:/kicad (or d: or
* e: ... ) and the directory "share" has no meaning under windows.
*
* Under linux, the problem is more complex.
* In fact there are 3 cases:
* 1 - When released in a distribution:
- * binaries are in /usr/bin, kicad libs in /usr/share/kicad/ and doc in
+ * binaries are in /usr/bin, KiCad libs in /usr/share/kicad/ and doc in
* /usr/share/doc/kicad/
* 2 - When compiled by an user:
- * binaries also can be in /usr/local/bin, kicad libs in
+ * binaries also can be in /usr/local/bin, KiCad libs in
* /usr/local/share/kicad/ and doc in /usr/local/share/doc/kicad/
* 3 - When in an "universal tarball" or build for a server:
* all files are in /usr/local/kicad
- * This is mandatory when kicad is installed on a server (in a school for
+ * This is mandatory when KiCad is installed on a server (in a school for
* instance) because one can export /usr/local/kicad and obviously the others
* paths cannot be used (cannot be mounted by the client, because they are
* already used).
*
- * in cases 1 and 2 kicad files cannot be found from the binary path.
- * in case 3 kicad files can be found from the binary path only if this is
- * a kicad binary file which is launched.
+ * in cases 1 and 2 KiCad files cannot be found from the binary path.
+ * in case 3 KiCad files can be found from the binary path only if this is
+ * a KiCad binary file which is launched.
* But if an user creates a symbolic link to the actual binary file to run
- * kicad, the binary path is not good and the defaults paths must be used
+ * KiCad, the binary path is not good and the defaults paths must be used
*
* Note:
- * kicad uses first the bin path lo locate kicad tree.
- * if not found kicad uses the environment variable KICAD to find its files
- * and at last kicad uses the default paths.
+ * KiCad uses first the bin path lo locate KiCad tree.
+ * if not found KiCad uses the environment variable KICAD to find its files
+ * and at last KiCad uses the default paths.
* So we can export (linux and windows) the variable KICAD:
* like export KICAD=/my_path/kicad if /my_path/kicad is not a default path
*/
@@ -74,7 +74,7 @@ static wxString s_HelpPathList[] = {
};
-// Path list for kicad data files
+// Path list for KiCad data files
static wxString s_KicadDataPathList[] = {
#ifdef __WINDOWS__
wxT( "c:/kicad/share/" ),
@@ -98,7 +98,7 @@ static wxString s_KicadDataPathList[] = {
wxT( "end_list" ) // End of list symbol, do not change
};
-// Path list for kicad binary files
+// Path list for KiCad binary files
static wxString s_KicadBinaryPathList[] = {
#ifdef __WINDOWS__
wxT( "c:/kicad/bin/" ),
@@ -378,7 +378,7 @@ wxString FindKicadHelpPath()
}
-/* Search the executable file shortname in kicad binary path
+/* Search the executable file shortname in KiCad binary path
* and return full file name if found or shortname
* kicad binary path is
* kicad/bin
@@ -394,7 +394,7 @@ wxString FindKicadFile( const wxString& shortname )
wxString FullFileName;
/* Test the presence of the file in the directory shortname of
- * the kicad binary path.
+ * the KiCad binary path.
*/
FullFileName = wxGetApp().m_BinDir + shortname;
if( wxFileExists( FullFileName ) )
@@ -452,7 +452,7 @@ int ExecuteFile( wxWindow* frame, const wxString& ExecFile,
}
-/* Return data path common kicad.
+/* Return data path common KiCad.
* If environment variable defined KiCAD (KiCAD = path to kicad)
* Returns <KICAD> /;
* Otherwise returns <path of binaries> / (if "kicad" is in the path name)
@@ -489,7 +489,7 @@ wxString ReturnKicadDatasPath()
data_path = tmp.BeforeLast( '/' ); // id cd ../
data_path += UNIX_STRING_DIR_SEP;
- // Old versions of kicad use kicad/ as default for data
+ // Old versions of KiCad use kicad/ as default for data
// and last versions kicad/share/
// So we search for kicad/share/ first
wxString old_path = data_path;
@@ -504,7 +504,7 @@ wxString ReturnKicadDatasPath()
}
}
- /* find kicad from default path list:
+ /* find KiCad from default path list:
* /usr/local/kicad/ or c:/kicad/
* (see s_KicadDataPathList) */
int ii = 0;
diff --git a/common/gr_basic.cpp b/common/gr_basic.cpp
index e36ec126be..8fd323a501 100644
--- a/common/gr_basic.cpp
+++ b/common/gr_basic.cpp
@@ -26,14 +26,14 @@
* coordinates overflow 16 bits values:
* http://trac.wxwidgets.org/ticket/10446
* Problems can be found under Windows **and** Linux (mainly when drawing arcs)
- * (mainly at low zoom values (2, 1 or 0.5), in pcbnew)
+ * (mainly at low zoom values (2, 1 or 0.5), in Pcbnew)
* some of these problems could be now fixed in recent distributions.
*
* Currently (feb 2009) there are overflow problems when drawing solid (filled)
* polygons under linux without clipping
*
* So before removing clipping functions, be aware these bug (they are not in
- * kicad or wxWidgets) are fixed by testing how are drawn complex lines arcs
+ * KiCad or wxWidgets) are fixed by testing how are drawn complex lines arcs
* and solid polygons under Windows and Linux and remember users can have old
* versions with bugs
*/
diff --git a/common/hotkeys_basic.cpp b/common/hotkeys_basic.cpp
index 85aba2eb9b..52f4fa02a3 100644
--- a/common/hotkeys_basic.cpp
+++ b/common/hotkeys_basic.cpp
@@ -1,8 +1,6 @@
/**
* @file hotkeys_basic.cpp
- */
-
-/* Some functions to handle hotkeys in kicad
+ * @brief Some functions to handle hotkeys in KiCad
*/
#include "fctsys.h"
diff --git a/common/newstroke_font.cpp b/common/newstroke_font.cpp
index 565e910a50..840a68882f 100644
--- a/common/newstroke_font.cpp
+++ b/common/newstroke_font.cpp
@@ -1,10 +1,10 @@
/*
* newstroke_font.cpp - definitions for automatically converted font
*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2010 vladimir uryvaev <vovanius@bk.ru>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/common/pcbcommon.cpp b/common/pcbcommon.cpp
index a6dfbb8bda..b675da8391 100644
--- a/common/pcbcommon.cpp
+++ b/common/pcbcommon.cpp
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2008 Wayne Stambaugh <stambaughw@verizon.net>
- * Copyright (C) 1992-2008 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2008 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -24,7 +24,7 @@
/*
* This file contains the global constants and variables used in the PCB
- * applications PCBNEW, CvPcb, and GervView. The goal of this was to
+ * applications Pcbnew, CvPcb, and GervView. The goal of this was to
* unobfuscate the original header file design that made it very difficult
* to figure out where these variables lived. Ideally, they should be pushed
* back into the application layer.
@@ -83,7 +83,7 @@ wxString g_Shapes3DExtBuffer( wxT( "wrl" ) );
const wxString ModuleFileExtension( wxT( "mod" ) );
/* PCB file name wild card definitions. */
-const wxString ModuleFileWildcard( _( "Kicad footprint library files (*.mod)|*.mod" ) );
+const wxString ModuleFileWildcard( _( "KiCad footprint library files (*.mod)|*.mod" ) );
int g_CurrentVersionPCB = 1;
diff --git a/common/projet_config.cpp b/common/projet_config.cpp
index 4545b4abae..f382a1d48b 100644
--- a/common/projet_config.cpp
+++ b/common/projet_config.cpp
@@ -36,7 +36,7 @@ bool EDA_APP::ReCreatePrjConfig( const wxString& fileName,
m_ProjectConfig = NULL;
}
- /* Check the file name does not a kicad project extension.
+ /* Check the file name does not a KiCad project extension.
* This allows the user to enter a filename without extension
* or use an existing name to create te project file
*/
@@ -67,7 +67,7 @@ bool EDA_APP::ReCreatePrjConfig( const wxString& fileName,
* project file.
*
* TODO: Push the version test up the stack so that when one of the
- * Kicad application version changes, the other applications
+ * KiCad application version changes, the other applications
* settings do not get updated. Practically, this can go away.
* It isn't used anywhere as far as I know (WLS).
*/
diff --git a/common/richio.cpp b/common/richio.cpp
index 95183c499a..774bdd8467 100644
--- a/common/richio.cpp
+++ b/common/richio.cpp
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2011 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/common/sch_item_struct.cpp b/common/sch_item_struct.cpp
index 489b3d7fb0..55c6ba5752 100644
--- a/common/sch_item_struct.cpp
+++ b/common/sch_item_struct.cpp
@@ -45,7 +45,7 @@ SCH_ITEM::SCH_ITEM( const SCH_ITEM& aItem ) :
SCH_ITEM::~SCH_ITEM()
{
// Do not let the connections container go out of scope with any objects or they
- // will be deleted by the container will cause the EESchema to crash. These objects
+ // will be deleted by the container will cause the Eeschema to crash. These objects
// are owned by the sheet object container.
if( !m_connections.empty() )
m_connections.clear();
diff --git a/common/xnode.cpp b/common/xnode.cpp
index cb5e2f566a..f8e05678a8 100644
--- a/common/xnode.cpp
+++ b/common/xnode.cpp
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/cvpcb/autosel.cpp b/cvpcb/autosel.cpp
index 8203f92a64..d9ebe1148f 100644
--- a/cvpcb/autosel.cpp
+++ b/cvpcb/autosel.cpp
@@ -1,6 +1,6 @@
-/**********************/
-/* CVPCB: autosel.cpp */
-/**********************/
+/**
+ * @file autosel.cpp
+ */
/* Routines for automatic selection of modules. */
diff --git a/cvpcb/class_DisplayFootprintsFrame.cpp b/cvpcb/class_DisplayFootprintsFrame.cpp
index d3f28e8fe0..c2c5b58fd6 100644
--- a/cvpcb/class_DisplayFootprintsFrame.cpp
+++ b/cvpcb/class_DisplayFootprintsFrame.cpp
@@ -420,11 +420,12 @@ void DISPLAY_FOOTPRINTS_FRAME::Show3D_Frame( wxCommandEvent& event )
}
-/* Virtual function needed by the PCB_SCREEN class derived from BASE_SCREEN
-* this is a virtual pure function in BASE_SCREEN
-* do nothing in cvpcb
-* could be removed later
-*/
+/**
+ * Virtual function needed by the PCB_SCREEN class derived from BASE_SCREEN
+ * this is a virtual pure function in BASE_SCREEN
+ * do nothing in Cvpcb
+ * could be removed later
+ */
void PCB_SCREEN::ClearUndoORRedoList( UNDO_REDO_CONTAINER&, int )
{
}
diff --git a/cvpcb/class_DisplayFootprintsFrame.h b/cvpcb/class_DisplayFootprintsFrame.h
index a92c552a20..02e5a12c6e 100644
--- a/cvpcb/class_DisplayFootprintsFrame.h
+++ b/cvpcb/class_DisplayFootprintsFrame.h
@@ -64,7 +64,7 @@ public:
void Show3D_Frame( wxCommandEvent& event );
/* SaveCopyInUndoList() virtual
- * currently: do nothing in cvpcb.
+ * currently: do nothing in CvPcb.
* but but be defined because it is a pure virtual in PCB_BASE_FRAME
*/
virtual void SaveCopyInUndoList( BOARD_ITEM* aItemToCopy,
@@ -87,7 +87,7 @@ public:
UNDO_REDO_T aTypeCommand,
const wxPoint& aTransformPoint = wxPoint( 0, 0 ) )
{
- // currently: do nothing in cvpcb.
+ // currently: do nothing in CvPcb.
}
diff --git a/cvpcb/cvframe.cpp b/cvpcb/cvframe.cpp
index eb5652532c..95503932b2 100644
--- a/cvpcb/cvframe.cpp
+++ b/cvpcb/cvframe.cpp
@@ -26,7 +26,7 @@
#define FRAME_MIN_SIZE_Y 300
-// option key to close cvpcb after saving files
+// option key to close CvPcb after saving files
static const wxString KeepCvpcbOpenEntry( wxT( "KeepCvpcbOpen" ) );
static const wxString FootprintDocFileEntry( wxT( "footprints_doc_file" ) );
diff --git a/cvpcb/cvpcb.cpp b/cvpcb/cvpcb.cpp
index d6f46ccc02..b1dc049155 100644
--- a/cvpcb/cvpcb.cpp
+++ b/cvpcb/cvpcb.cpp
@@ -1,6 +1,6 @@
-/*******************/
-/* File: cvpcb.cpp */
-/*******************/
+/**
+ * @file cvpcb.cpp
+ */
#include "fctsys.h"
#include "gr_basic.h"
@@ -28,8 +28,8 @@ const wxString RetroFileExtension( wxT( "stf" ) );
const wxString FootprintAliasFileExtension( wxT( "equ" ) );
// Wildcard for schematic retroannotation (import footprint names in schematic):
-const wxString RetroFileWildcard( _( "Kicad retroannotation files (*.stf)|*.stf" ) );
-const wxString FootprintAliasFileWildcard( _( "Kicad footprint alias files (*.equ)|*.equ" ) );
+const wxString RetroFileWildcard( _( "KiCad retroannotation files (*.stf)|*.stf" ) );
+const wxString FootprintAliasFileWildcard( _( "KiCad footprint alias files (*.equ)|*.equ" ) );
const wxString titleLibLoadError( _( "Library Load Error" ) );
diff --git a/cvpcb/init.cpp b/cvpcb/init.cpp
index 7d9b68f608..bb031c5694 100644
--- a/cvpcb/init.cpp
+++ b/cvpcb/init.cpp
@@ -74,7 +74,7 @@ bool CVPCB_MAINFRAME::ReadNetList()
if( error_level < 0 )
{
- msg.Printf( _( "File <%s> does not appear to be a valid Kicad net list file." ),
+ msg.Printf( _( "File <%s> does not appear to be a valid KiCad net list file." ),
GetChars( m_NetlistFileName.GetFullPath() ) );
::wxMessageBox( msg, _( "File Error" ), wxOK | wxICON_ERROR, this );
m_NetlistFileName.Clear();
diff --git a/cvpcb/loadcmp.cpp b/cvpcb/loadcmp.cpp
index 7691c044cd..fba5a9e678 100644
--- a/cvpcb/loadcmp.cpp
+++ b/cvpcb/loadcmp.cpp
@@ -76,7 +76,7 @@ found in the default search paths." ),
if( strnicmp( Line, FOOTPRINT_LIBRARY_HEADER, FOOTPRINT_LIBRARY_HEADER_CNT ) != 0 )
{
- msg.Printf( _( "<%s> is not a valid Kicad PCB foot print library." ),
+ msg.Printf( _( "<%s> is not a valid KiCad PCB foot print library." ),
GetChars( tmp ) );
wxMessageBox( msg, titleLibLoadError, wxOK | wxICON_ERROR, this );
fclose( file );
diff --git a/cvpcb/menubar.cpp b/cvpcb/menubar.cpp
index 085b39febd..dd7cc5f5be 100644
--- a/cvpcb/menubar.cpp
+++ b/cvpcb/menubar.cpp
@@ -1,6 +1,6 @@
/**
* @file cvpcb/menubar.cpp
- * @brief (Re)Create the menubar for cvpcb
+ * @brief (Re)Create the menubar for CvPcb
*/
#include "fctsys.h"
#include "appl_wxstruct.h"
@@ -13,7 +13,7 @@
/**
- * @brief (Re)Create the menubar for the cvpcb mainframe
+ * @brief (Re)Create the menubar for the CvPcb mainframe
*/
void CVPCB_MAINFRAME::ReCreateMenuBar()
{
diff --git a/cvpcb/readschematicnetlist.cpp b/cvpcb/readschematicnetlist.cpp
index ef152d451a..332997be2a 100644
--- a/cvpcb/readschematicnetlist.cpp
+++ b/cvpcb/readschematicnetlist.cpp
@@ -136,7 +136,7 @@ int CVPCB_MAINFRAME::ReadSchematicNetlist()
return -3;
}
- SetStatusText( _( "Netlist Format: EESchema" ), 0 );
+ SetStatusText( _( "Netlist Format: Eeschema" ), 0 );
/* Read the netlist */
diff --git a/cvpcb/savecmp.cpp b/cvpcb/savecmp.cpp
index 29ae2219cb..8185df9359 100644
--- a/cvpcb/savecmp.cpp
+++ b/cvpcb/savecmp.cpp
@@ -79,7 +79,7 @@ bool CVPCB_MAINFRAME::LoadComponentFile( const wxString& aFileName )
/* Identification of the type of file CmpMod */
if( fgets( Line, 79, source ) == 0 )
{
- msg.Printf( _( " <%s> does not appear to be a valid Kicad component library." ),
+ msg.Printf( _( " <%s> does not appear to be a valid KiCad component library." ),
GetChars( fn.GetFullPath() ) );
wxMessageBox( msg, titleComponentLibErr, wxOK | wxICON_ERROR );
fclose( source );
diff --git a/cvpcb/setvisu.cpp b/cvpcb/setvisu.cpp
index dc190985bd..795fd6218b 100644
--- a/cvpcb/setvisu.cpp
+++ b/cvpcb/setvisu.cpp
@@ -135,8 +135,8 @@ void BOARD::Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, int aDrawMode, const wxPoin
/* dummy_functions:
*
* These functions are used in some classes.
- * they are useful in pcbnew, but have no meaning or are never used
- * in cvpcb or gerbview.
+ * they are useful in Pcbnew, but have no meaning or are never used
+ * in CvPcb or GerbView.
* but they must exist because they appear in some classes.
* Do nothing in CvPcb.
*/
diff --git a/cvpcb/tool_cvpcb.cpp b/cvpcb/tool_cvpcb.cpp
index 87cb9fab66..8302e4c6a0 100644
--- a/cvpcb/tool_cvpcb.cpp
+++ b/cvpcb/tool_cvpcb.cpp
@@ -60,7 +60,7 @@ void CVPCB_MAINFRAME::ReCreateHToolbar()
m_HToolBar->AddTool( ID_CVPCB_CREATE_STUFF_FILE, wxEmptyString,
KiBitmap( export_footprint_names_xpm ),
_( "Create export file (component/footprint list, \
-used by eeschema to fill the footprint field of components)" ) );
+used by Eeschema to fill the footprint field of components)" ) );
m_HToolBar->AddSeparator();
m_HToolBar->AddTool( ID_PCB_DISPLAY_FOOTPRINT_DOC, wxEmptyString,
diff --git a/cvpcb/writenetlistpcbnew.cpp b/cvpcb/writenetlistpcbnew.cpp
index 6a4ae38d3d..9616f0bc96 100644
--- a/cvpcb/writenetlistpcbnew.cpp
+++ b/cvpcb/writenetlistpcbnew.cpp
@@ -58,7 +58,7 @@ static void RemoveDuplicatePins( COMPONENT& component )
/**
- * Create Kicad net list file.
+ * Create KiCad net list file.
*
* @todo: None of the printf() call return values are checked for failure,
* a value less than zero. Check all printf() return values and
diff --git a/eeschema/backanno.cpp b/eeschema/backanno.cpp
index 3c78e3523b..08fd2adbc3 100644
--- a/eeschema/backanno.cpp
+++ b/eeschema/backanno.cpp
@@ -1,7 +1,7 @@
-/****************************************************************
- * EESchema: backanno.cpp
- * (functions for backannotating Footprint info
- ****************************************************************/
+/**
+ * @file backanno.cpp
+ * @brief Functions for backannotating footprint information.
+ */
#include "fctsys.h"
#include "confirm.h"
@@ -17,7 +17,7 @@
#include "netlist.h"
-const wxString BackAnnotateFileWildcard( wxT( "EESchema Back Annotation File (*.stf)|*.stf" ) );
+const wxString BackAnnotateFileWildcard( wxT( "Eeschema Back Annotation File (*.stf)|*.stf" ) );
bool SCH_EDIT_FRAME::ProcessStuffFile( FILE* aFile, bool aSetFieldAttributeToVisible )
diff --git a/eeschema/block.cpp b/eeschema/block.cpp
index 84763e9e36..22cfbd51b9 100644
--- a/eeschema/block.cpp
+++ b/eeschema/block.cpp
@@ -285,7 +285,7 @@ bool SCH_EDIT_FRAME::HandleBlockEnd( wxDC* DC )
block->m_State = STATE_BLOCK_MOVE;
break;
- case BLOCK_FLIP: /* pcbnew only! */
+ case BLOCK_FLIP: /* Pcbnew only! */
break;
case BLOCK_ZOOM: /* Window Zoom */
diff --git a/eeschema/class_drc_erc_item.cpp b/eeschema/class_drc_erc_item.cpp
index 33843629ba..90f4f58191 100644
--- a/eeschema/class_drc_erc_item.cpp
+++ b/eeschema/class_drc_erc_item.cpp
@@ -1,7 +1,7 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/eeschema/class_libentry.h b/eeschema/class_libentry.h
index 32ef0830a5..9dd53db981 100644
--- a/eeschema/class_libentry.h
+++ b/eeschema/class_libentry.h
@@ -56,7 +56,7 @@ class LIB_ALIAS : public EDA_ITEM
* @note - Do not delete the root component. The root component is actually shared by
* all of the aliases associated with it. The component pointer will be delete
* in the destructor of the last alias that shares this component is deleted.
- * Deleting the root component will likely cause EESchema to crash.
+ * Deleting the root component will likely cause Eeschema to crash.
*/
LIB_COMPONENT* root;
diff --git a/eeschema/class_library.cpp b/eeschema/class_library.cpp
index d1531bcecb..2118fdcdf2 100644
--- a/eeschema/class_library.cpp
+++ b/eeschema/class_library.cpp
@@ -474,7 +474,7 @@ bool CMP_LIBRARY::Load( wxString& aErrorMsg )
#if 0 // Note for developers:
// Not sure this warning is very useful: old designs *must* be always loadable
wxLogWarning( wxT( "The component library <%s> header version \
-number is invalid.\n\nIn future versions of EESchema this library may not \
+number is invalid.\n\nIn future versions of Eeschema this library may not \
load correctly. To resolve this problem open the library in the library \
editor and save it. If this library is the project cache library, save \
the current schematic." ),
diff --git a/eeschema/component_references_lister.cpp b/eeschema/component_references_lister.cpp
index c18d40df55..cb88564536 100644
--- a/eeschema/component_references_lister.cpp
+++ b/eeschema/component_references_lister.cpp
@@ -4,11 +4,11 @@
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2011 jean-pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr>
* Copyright (C) 1992-2011 Wayne Stambaugh <stambaughw@verizon.net>
- * Copyright (C) 1992-2011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/eeschema/controle.cpp b/eeschema/controle.cpp
index db2eee445f..c38632aa86 100644
--- a/eeschema/controle.cpp
+++ b/eeschema/controle.cpp
@@ -52,7 +52,7 @@ SCH_ITEM* SCH_EDIT_FRAME::LocateAndShowItem( const wxPoint& aPosition, const KIC
return NULL;
}
- /* Cross probing to pcbnew if a pin or a component is found */
+ /* Cross probing to Pcbnew if a pin or a component is found */
switch( item->Type() )
{
case SCH_FIELD_T:
@@ -84,7 +84,7 @@ SCH_ITEM* SCH_EDIT_FRAME::LocateAndShowItem( const wxPoint& aPosition, const KIC
AppendMsgPanel( LibItem->GetRef( GetSheet() ),
LibItem->GetField( VALUE )->m_Text, DARKCYAN );
- // Cross probing:2 - pin found, and send a locate pin command to pcbnew (highlight net)
+ // Cross probing:2 - pin found, and send a locate pin command to Pcbnew (highlight net)
SendMessageToPCBNEW( Pin, LibItem );
}
diff --git a/eeschema/cross-probing.cpp b/eeschema/cross-probing.cpp
index b2573c0215..8f65994759 100644
--- a/eeschema/cross-probing.cpp
+++ b/eeschema/cross-probing.cpp
@@ -1,6 +1,6 @@
-/*********************/
-/* cross-probing.cpp */
-/*********************/
+/**
+ * @file eeschema/cross-probing.cpp
+ */
#include "fctsys.h"
#include "appl_wxstruct.h"
@@ -16,22 +16,20 @@
#include "sch_component.h"
-/***************************************************************/
-void RemoteCommand( const char* cmdline )
-/***************************************************************/
-
-/** Read a remote command sent by pcbnew (via a socket connection) ,
- * so when user selects a module or pin in pcbnew,
- * eeschema shows that same component or pin.
+/**
+ * Read a remote command sent by Pcbnew (via a socket connection) ,
+ * so when user selects a module or pin in Pcbnew,
+ * Deschema shows that same component or pin.
* The cursor is put on the item
* port KICAD_SCH_PORT_SERVICE_NUMBER (currently 4243)
- * @param cmdline = received command from pcbnew
+ * @param cmdline = received command from Pcbnew
* commands are:
* $PART: "reference" put cursor on component
* $PART: "reference" $REF: "ref" put cursor on reference component
* $PART: "reference" $VAL: "value" put cursor on value component
* $PART: "reference" $PAD: "pin name" put cursor on the component pin
*/
+void RemoteCommand( const char* cmdline )
{
char line[1024];
char* idcmd;
@@ -87,7 +85,7 @@ void RemoteCommand( const char* cmdline )
}
-/** Send a remote command to eeschema via a socket,
+/** Send a remote command to Eeschema via a socket,
* @param objectToSync = item to be located on board (footprint, pad or text)
* @param LibItem = component in lib if objectToSync is a sub item of a component
* Commands are
@@ -102,7 +100,7 @@ void SCH_EDIT_FRAME::SendMessageToPCBNEW( EDA_ITEM* objectToSync, SCH_COMPONENT*
LIB_PIN* Pin = NULL;
char Line[1024];
- /* Cross probing to pcbnew if a pin or a component is found */
+ /* Cross probing to Pcbnew if a pin or a component is found */
switch( objectToSync->Type() )
{
case SCH_FIELD_T:
diff --git a/eeschema/database.cpp b/eeschema/database.cpp
index 6cbbbd9766..bd629c3427 100644
--- a/eeschema/database.cpp
+++ b/eeschema/database.cpp
@@ -1,6 +1,6 @@
-/****************************/
-/* EESchema - database.cpp */
-/****************************/
+/**
+ * @file database.cpp
+ */
#include "fctsys.h"
#include "gr_basic.h"
diff --git a/eeschema/dialogs/annotate_dialog.cpp b/eeschema/dialogs/annotate_dialog.cpp
index cfa70cd56f..691fe2a19f 100644
--- a/eeschema/dialogs/annotate_dialog.cpp
+++ b/eeschema/dialogs/annotate_dialog.cpp
@@ -1,13 +1,10 @@
-/*
-* annotate_dialog.cpp
-*/
-/*
- * annotate_dialog.cpp
- * Annotation dialog functions.
+/**
+ * @file annotate_dialog.cpp
+ * @brief Annotation dialog functions.
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2011 jean-pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr>
* Copyright (C) 1992-2011 Kicad Developers, see change_log.txt for contributors.
diff --git a/eeschema/dialogs/dialog_build_BOM.cpp b/eeschema/dialogs/dialog_build_BOM.cpp
index 6b23f356d6..4f301c7250 100644
--- a/eeschema/dialogs/dialog_build_BOM.cpp
+++ b/eeschema/dialogs/dialog_build_BOM.cpp
@@ -218,7 +218,7 @@ void DIALOG_BUILD_BOM::SavePreferences()
// Determine current settings of "List items" and "Options" checkboxes
// (NOTE: These 6 settings are restored when the dialog box is next
- // invoked, but are *not* still saved after EESchema is next shut down.)
+ // invoked, but are *not* still saved after Eeschema is next shut down.)
s_ListByRef = m_ListCmpbyRefItems->GetValue();
s_ListWithSubCmponents = m_ListSubCmpItems->GetValue();
s_ListByValue = m_ListCmpbyValItems->GetValue();
diff --git a/eeschema/dialogs/dialog_color_config.cpp b/eeschema/dialogs/dialog_color_config.cpp
index 9117d94584..0f814e8ff5 100644
--- a/eeschema/dialogs/dialog_color_config.cpp
+++ b/eeschema/dialogs/dialog_color_config.cpp
@@ -1,5 +1,5 @@
-/* Set up color Layers for EESchema
+/* Set up color Layers for Eeschema
*/
#include "fctsys.h"
diff --git a/eeschema/dialogs/dialog_eeschema_config.cpp b/eeschema/dialogs/dialog_eeschema_config.cpp
index 56ee35447e..e6d6226157 100644
--- a/eeschema/dialogs/dialog_eeschema_config.cpp
+++ b/eeschema/dialogs/dialog_eeschema_config.cpp
@@ -3,7 +3,7 @@
// Purpose:
// Author: jean-pierre Charras
// Created: 17/02/2006 21:14:46
-// Copyright: Kicad Team
+// Copyright: KiCad Team
// Licence: GPL
/////////////////////////////////////////////////////////////////////////////
diff --git a/eeschema/dialogs/dialog_plot_schematic_DXF.cpp b/eeschema/dialogs/dialog_plot_schematic_DXF.cpp
index e611f46d5f..42a83546d8 100644
--- a/eeschema/dialogs/dialog_plot_schematic_DXF.cpp
+++ b/eeschema/dialogs/dialog_plot_schematic_DXF.cpp
@@ -2,10 +2,10 @@
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 Lorenzo Marcantonio
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/eeschema/dialogs/dialog_plot_schematic_HPGL.cpp b/eeschema/dialogs/dialog_plot_schematic_HPGL.cpp
index c9cb6edc4e..3ded186842 100644
--- a/eeschema/dialogs/dialog_plot_schematic_HPGL.cpp
+++ b/eeschema/dialogs/dialog_plot_schematic_HPGL.cpp
@@ -2,10 +2,10 @@
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 Jean-Pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -327,7 +327,7 @@ void DIALOG_PLOT_SCHEMATIC_HPGL::Plot_Schematic_HPGL( bool aPlotAll, int HPGL_Sh
else
PlotSheet = screen->m_CurrentSheetDesc;
- /* 10x because eeschema works in mils, not decimals */
+ /* 10x because Eeschema works in mils, not decimals */
double plot_scale = 10 * (double) PlotSheet->m_Size.x / (double) SheetSize.x;
/* Calculate offsets */
diff --git a/eeschema/dialogs/dialog_plot_schematic_PS.cpp b/eeschema/dialogs/dialog_plot_schematic_PS.cpp
index 89e480644e..13c008690e 100644
--- a/eeschema/dialogs/dialog_plot_schematic_PS.cpp
+++ b/eeschema/dialogs/dialog_plot_schematic_PS.cpp
@@ -2,10 +2,10 @@
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 Jean-Pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/eeschema/edit_bitmap.cpp b/eeschema/edit_bitmap.cpp
index 2c122e9a0d..edae8db5ce 100644
--- a/eeschema/edit_bitmap.cpp
+++ b/eeschema/edit_bitmap.cpp
@@ -1,12 +1,12 @@
-/********************/
-/* edit_bitmap.cpp */
-/********************/
+/**
+ * @file edit_bitmap.cpp
+ */
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2011 jean-pierre.charras
- * Copyright (C) 2011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/eeschema/eeschema.cpp b/eeschema/eeschema.cpp
index ce147bf6f4..6759223091 100644
--- a/eeschema/eeschema.cpp
+++ b/eeschema/eeschema.cpp
@@ -1,6 +1,6 @@
-/***********************************/
-/* eeschema.cpp - module principal */
-/***********************************/
+/**
+ * @file eeschema.cpp
+ */
#include "fctsys.h"
#include "appl_wxstruct.h"
@@ -43,8 +43,8 @@ wxString g_NetCmpExtBuffer( wxT( "cmp" ) );
const wxString SymbolFileExtension( wxT( "sym" ) );
const wxString CompLibFileExtension( wxT( "lib" ) );
-const wxString SymbolFileWildcard( wxT( "Kicad drawing symbol file (*.sym)|*.sym" ) );
-const wxString CompLibFileWildcard( wxT( "Kicad component library file (*.lib)|*.lib" ) );
+const wxString SymbolFileWildcard( wxT( "KiCad drawing symbol file (*.sym)|*.sym" ) );
+const wxString CompLibFileWildcard( wxT( "KiCad component library file (*.lib)|*.lib" ) );
LayerStruct g_LayerDescr; /* layer colors. */
@@ -53,7 +53,7 @@ bool g_EditPinByPinIsOn = false; /* true to do not synchronize pins
* same location */
int g_DrawDefaultLineThickness = 6; /* Default line thickness in
- * EESCHEMA units used to
+ * Eeschema units used to
* draw/plot items having a
* default thickness line value
* (i.e. = 0 ). 0 = single pixel
@@ -62,8 +62,8 @@ int g_DrawDefaultLineThickness = 6; /* Default line thickness in
// Color to draw selected items
int g_ItemSelectetColor = BROWN;
-// Color to draw items flagged invisible, in libedit (they are insisible
-// in eeschema
+// Color to draw items flagged invisible, in libedit (they are invisible
+// in Eeschema
int g_InvisibleItemColor = DARKGRAY;
TRANSFORM DefaultTransform = TRANSFORM( 1, 0, 0, -1 );
@@ -103,7 +103,7 @@ bool EDA_APP::OnInit()
wxFileName filename;
SCH_EDIT_FRAME* frame = NULL;
- InitEDA_Appl( wxT( "EESchema" ), APP_EESCHEMA_T );
+ InitEDA_Appl( wxT( "Eeschema" ), APP_EESCHEMA_T );
if( m_Checker && m_Checker->IsAnotherRunning() )
{
@@ -114,7 +114,7 @@ bool EDA_APP::OnInit()
if( argc > 1 )
filename = argv[1];
- // Init EESchema
+ // Init Eeschema
SeedLayers();
// read current setup and reopen last directory if no filename to open in
@@ -127,15 +127,14 @@ bool EDA_APP::OnInit()
ReadHotkeyConfig( wxT("SchematicFrame"), s_Eeschema_Hokeys_Descr );
// Create main frame (schematic frame) :
- frame = new SCH_EDIT_FRAME( NULL, wxT( "EESchema" ), wxPoint( 0, 0 ), wxSize( 600, 400 ) );
+ frame = new SCH_EDIT_FRAME( NULL, wxT( "Eeschema" ), wxPoint( 0, 0 ), wxSize( 600, 400 ) );
SetTopWindow( frame );
frame->Show( true );
if( CreateServer( frame, KICAD_SCH_PORT_SERVICE_NUMBER ) )
{
- // RemoteCommand is in controle.cpp and is called when PCBNEW
- // sends EESCHEMA a command
+ // RemoteCommand is in controle.cpp and is called when Pcbnew sends Eeschema a command.
SetupServerFunction( RemoteCommand );
}
diff --git a/eeschema/eeschema_id.h b/eeschema/eeschema_id.h
index 34a3238be5..50b1743c4c 100644
--- a/eeschema/eeschema_id.h
+++ b/eeschema/eeschema_id.h
@@ -16,9 +16,9 @@
/**
* Command IDs for the schematic editor.
*
- * Please add IDs that are unique to the schematic editor (EESchema) here and
+ * Please add IDs that are unique to the schematic editor (Eeschema) here and
* not in the global id.h file. This will prevent the entire project from
- * being rebuilt when adding new command to EESchema.
+ * being rebuilt when adding new command to Eeschema.
*/
enum id_eeschema_frm
diff --git a/eeschema/erc.h b/eeschema/erc.h
index f8f33d9d0e..c2906b400f 100644
--- a/eeschema/erc.h
+++ b/eeschema/erc.h
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009 Jea-Pierre.Charras, jaen-pierre.charras@gipsa-lab.inpg.com
- * Copyright (C) 2009 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2009 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/eeschema/find.cpp b/eeschema/find.cpp
index b0d7828076..857458bc88 100644
--- a/eeschema/find.cpp
+++ b/eeschema/find.cpp
@@ -1,6 +1,7 @@
-/****************************************************************/
-/* EESchema: find.cpp (functions for searching a schematic item */
-/****************************************************************/
+/**
+ * @file eeschema/find.cpp
+ * @brief Functions for searching for a schematic item.
+ */
/*
* Search a text (text, value, reference) within a component or
diff --git a/eeschema/general.h b/eeschema/general.h
index 44a23452d4..cac1864b6b 100644
--- a/eeschema/general.h
+++ b/eeschema/general.h
@@ -152,7 +152,7 @@ extern bool g_EditPinByPinIsOn; /* True to prevent displacing
* pins, when they are at the
* same position. */
-extern int g_DrawDefaultLineThickness; /* Default line (in EESCHEMA
+extern int g_DrawDefaultLineThickness; /* Default line (in Eeschema
* units) thickness used to
* draw/plot items having a
* default thickness line
@@ -163,8 +163,7 @@ extern int g_DrawDefaultLineThickness; /* Default line (in EESCHEMA
// Color to draw selected items
extern int g_ItemSelectetColor;
-// Color to draw items flagged invisible, in libedit (they are invisible in
-// eeschema
+// Color to draw items flagged invisible, in libedit (they are invisible in Eeschema
extern int g_InvisibleItemColor;
/* Global Variables */
diff --git a/eeschema/hotkeys.cpp b/eeschema/hotkeys.cpp
index aabea7c908..ae40774274 100644
--- a/eeschema/hotkeys.cpp
+++ b/eeschema/hotkeys.cpp
@@ -1,6 +1,6 @@
-/***************/
-/* hotkeys.cpp */
-/***************/
+/**
+ * @file eeschema/hotkeys.cpp
+ */
#include "fctsys.h"
#include "eeschema_id.h"
@@ -33,7 +33,7 @@
* by the user hotkey list file
* add the HkMyNewEntry pointer in the s_Schematic_Hotkey_List list or the
* s_LibEdit_Hotkey_List list or s_Common_Hotkey_List if the same command is
- * added both in eeschema and libedit)
+ * added both in Eeschema and libedit)
* Add the new code in the switch in OnHotKey() function.
* when the variable itemInEdit is true, an item is currently edited.
* This can be useful if the new function cannot be executed while an item is
@@ -218,7 +218,7 @@ EDA_HOTKEY* s_LibEdit_Hotkey_List[] =
NULL
};
-// list of sections and corresponding hotkey list for eeschema (used to create
+// list of sections and corresponding hotkey list for Eeschema (used to create
// an hotkey config file)
struct EDA_HOTKEY_CONFIG s_Eeschema_Hokeys_Descr[] =
{
diff --git a/eeschema/hotkeys.h b/eeschema/hotkeys.h
index eed341a3c5..fb7ef7637f 100644
--- a/eeschema/hotkeys.h
+++ b/eeschema/hotkeys.h
@@ -45,7 +45,7 @@ enum hotkey_id_commnand {
HK_ADD_NOCONN_FLAG
};
-// List of hotkey descriptors for eeschema
+// List of hotkey descriptors for Eeschema
extern struct EDA_HOTKEY_CONFIG s_Eeschema_Hokeys_Descr[];
// List of hotkey descriptors for the schematic editor only
diff --git a/eeschema/lib_circle.cpp b/eeschema/lib_circle.cpp
index aaafa164e9..c573326a4f 100644
--- a/eeschema/lib_circle.cpp
+++ b/eeschema/lib_circle.cpp
@@ -1,6 +1,7 @@
-/*************************/
-/** class LIB_CIRCLE **/
-/*************************/
+/**
+ * @file lib_circle.cpp
+ * @brief LIB_CIRCLE class definition
+ */
#include "fctsys.h"
#include "gr_basic.h"
@@ -72,7 +73,7 @@ bool LIB_CIRCLE::Load( char* aLine, wxString& aErrorMsg )
/**
* Function HitTest
* tests if the given wxPoint is within the bounds of this object.
- * @param aPosRef A wxPoint to test in eeschema space
+ * @param aPosRef A wxPoint to test in Eeschema space
* @return - true if a hit, else false
*/
bool LIB_CIRCLE::HitTest( const wxPoint& aPosRef )
diff --git a/eeschema/lib_collectors.cpp b/eeschema/lib_collectors.cpp
index 21d1baa1a4..0e538250a8 100644
--- a/eeschema/lib_collectors.cpp
+++ b/eeschema/lib_collectors.cpp
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2011 Wayne Stambaugh <stambaughw@verizon.net>
- * Copyright (C) 2004-2011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2004-2011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/eeschema/lib_collectors.h b/eeschema/lib_collectors.h
index 38937283c9..00fc5724c7 100644
--- a/eeschema/lib_collectors.h
+++ b/eeschema/lib_collectors.h
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2011 Wayne Stambaugh <stambaughw@verizon.net>
- * Copyright (C) 2004-20011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 20011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/eeschema/lib_draw_item.h b/eeschema/lib_draw_item.h
index 6aad4762b2..671b5c9d2f 100644
--- a/eeschema/lib_draw_item.h
+++ b/eeschema/lib_draw_item.h
@@ -94,7 +94,7 @@ protected:
/**
* Shape identification for alternate body styles. Set 0 if the item
* is common to all body styles. This is commonly referred to as
- * DeMorgan style and this is typically how it is used in Kicad.
+ * DeMorgan style and this is typically how it is used in KiCad.
*/
int m_Convert;
diff --git a/eeschema/lib_export.cpp b/eeschema/lib_export.cpp
index de2848fe90..854a11838f 100644
--- a/eeschema/lib_export.cpp
+++ b/eeschema/lib_export.cpp
@@ -1,10 +1,7 @@
-/*****************************/
-/* EESchema - lib_export.cpp */
-/*****************************/
-
-/* Library maintenance routines.
- * Backup modified libraries.
- * Create, edit, and delete components.
+/**
+ * @file lib_export.cpp
+ * @brief Eeschema library maintenance routines to backup modified libraries and
+ * create, edit, and delete components.
*/
#include "fctsys.h"
@@ -135,7 +132,7 @@ void LIB_EDIT_FRAME::OnExportPart( wxCommandEvent& event )
{
msg = fn.GetFullPath() + _( " - OK" );
DisplayInfoMessage( this, _( "This library will not be available \
-until it is loaded by EESchema.\n\nModify the EESchema library configuration \
+until it is loaded by Eeschema.\n\nModify the Eeschema library configuration \
if you want to include it as part of this project." ) );
}
else
diff --git a/eeschema/lib_text.h b/eeschema/lib_text.h
index 095429ffda..128ef19053 100644
--- a/eeschema/lib_text.h
+++ b/eeschema/lib_text.h
@@ -71,7 +71,7 @@ public:
virtual bool HitTest( const wxPoint& aPosition );
/**
- * @param aPosition = a wxPoint to test, in eeschema coordinates
+ * @param aPosition = a wxPoint to test, in Eeschema coordinates
* @param aThreshold = max distance to a segment
* @param aTransform = the transform matrix
* @return true if the point \a aPosition is near a segment
diff --git a/eeschema/libedit.cpp b/eeschema/libedit.cpp
index 59dd71cea0..d244f8b2b9 100644
--- a/eeschema/libedit.cpp
+++ b/eeschema/libedit.cpp
@@ -1,6 +1,7 @@
-/****************************/
-/* EESchema - libedit.cpp */
-/****************************/
+/**
+ * @file libedit.cpp
+ * @brief Eeschema component library editor.
+ */
#include "fctsys.h"
#include "gr_basic.h"
diff --git a/eeschema/libedit_onleftclick.cpp b/eeschema/libedit_onleftclick.cpp
index ea343eb5d2..4a8925b278 100644
--- a/eeschema/libedit_onleftclick.cpp
+++ b/eeschema/libedit_onleftclick.cpp
@@ -1,8 +1,6 @@
-/*****************************************/
-/* EESchema - libedit_onleftclick.cpp */
-/*****************************************/
-
-/* Library editor commands created by a mouse left button simple or double click
+/**
+ * @file libedit_onleftclick.cpp
+ * @brief Eeschema library editor event handler for a mouse left button single or double click.
*/
#include "fctsys.h"
diff --git a/eeschema/libedit_plot_component.cpp b/eeschema/libedit_plot_component.cpp
index 356f1f7453..2bb4cd3b9c 100644
--- a/eeschema/libedit_plot_component.cpp
+++ b/eeschema/libedit_plot_component.cpp
@@ -1,6 +1,6 @@
-/*******************************************/
-/* EESchema - libedit_plot_component.cpp */
-/*******************************************/
+/**
+ * @file libedit_plot_component.cpp
+ */
#include "fctsys.h"
diff --git a/eeschema/libeditframe.cpp b/eeschema/libeditframe.cpp
index c7cd45222e..c432db42b6 100644
--- a/eeschema/libeditframe.cpp
+++ b/eeschema/libeditframe.cpp
@@ -1,8 +1,7 @@
/**
-* EESchema - libeditframe.cpp
-* class LIB_EDIT_FRAME: the component editor frame
-*
-*/
+ * @file libeditframe.cpp
+ * @brief LIB_EDIT_FRAME class is the component library editor frame.
+ */
#include "fctsys.h"
#include "appl_wxstruct.h"
diff --git a/eeschema/load_one_schematic_file.cpp b/eeschema/load_one_schematic_file.cpp
index 8d22b28400..252890732f 100644
--- a/eeschema/load_one_schematic_file.cpp
+++ b/eeschema/load_one_schematic_file.cpp
@@ -1,6 +1,7 @@
-/****************************************/
-/* Module to load/save EESchema files. */
-/****************************************/
+/**
+ * @file load_one_schematic_file.cpp
+ * @brief Code to load and save Eeschema files.
+ */
#include "fctsys.h"
#include "confirm.h"
@@ -66,7 +67,7 @@ bool SCH_EDIT_FRAME::LoadOneEEFile( SCH_SCREEN* aScreen, const wxString& aFullFi
if( !reader.ReadLine()
|| strncmp( (char*)reader + 9, SCHEMATIC_HEAD_STRING, sizeof(SCHEMATIC_HEAD_STRING) - 1 ) != 0 )
{
- MsgDiag = aFullFileName + _( " is NOT an EESchema file!" );
+ MsgDiag = aFullFileName + _( " is NOT an Eeschema file!" );
DisplayError( this, MsgDiag );
return FALSE;
}
@@ -85,16 +86,16 @@ bool SCH_EDIT_FRAME::LoadOneEEFile( SCH_SCREEN* aScreen, const wxString& aFullFi
if( version > EESCHEMA_VERSION )
{
MsgDiag = aFullFileName + _( " was created by a more recent \
-version of EESchema and may not load correctly. Please consider updating!" );
+version of Eeschema and may not load correctly. Please consider updating!" );
DisplayInfoMessage( this, MsgDiag );
}
#if 0
- // Compile it if the new version is unreadable by previous eeschema versions
+ // Compile it if the new version is unreadable by previous Eeschema versions
else if( version < EESCHEMA_VERSION )
{
MsgDiag = aFullFileName + _( " was created by an older version of \
-EESchema. It will be stored in the new file format when you save this file \
+Eeschema. It will be stored in the new file format when you save this file \
again." );
DisplayInfoMessage( this, MsgDiag );
@@ -103,7 +104,7 @@ again." );
if( !reader.ReadLine() || strncmp( reader, "LIBS:", 5 ) != 0 )
{
- MsgDiag = aFullFileName + _( " is NOT an EESchema file!" );
+ MsgDiag = aFullFileName + _( " is NOT an Eeschema file!" );
DisplayError( this, MsgDiag );
return FALSE;
}
@@ -165,7 +166,7 @@ again." );
case 'T': // It is a text item.
if( sscanf( sline, "%s", Name1 ) != 1 )
{
- MsgDiag.Printf( wxT( "EESchema file text load error at line %d" ),
+ MsgDiag.Printf( wxT( "Eeschema file text load error at line %d" ),
reader.LineNumber() );
itemLoaded = false;
}
@@ -181,7 +182,7 @@ again." );
default:
itemLoaded = false;
- MsgDiag.Printf( wxT( "EESchema file undefined object at line %d, aborted" ),
+ MsgDiag.Printf( wxT( "Eeschema file undefined object at line %d, aborted" ),
reader.LineNumber() );
MsgDiag << wxT( "\n" ) << FROM_UTF8( line );
}
@@ -306,7 +307,7 @@ bool ReadSchemaDescr( LINE_READER* aLine, wxString& aMsgDiag, BASE_SCREEN* aScre
if( SheetFormatList[ii] == NULL )
{
- aMsgDiag.Printf( wxT( "EESchema file dimension definition error \
+ aMsgDiag.Printf( wxT( "Eeschema file dimension definition error \
line %d, \aAbort reading file.\n" ),
aLine->LineNumber() );
aMsgDiag << FROM_UTF8( line );
diff --git a/eeschema/menubar.cpp b/eeschema/menubar.cpp
index 28057393fe..e3ce40a5e6 100644
--- a/eeschema/menubar.cpp
+++ b/eeschema/menubar.cpp
@@ -164,7 +164,7 @@ void SCH_EDIT_FRAME::ReCreateMenuBar()
AddMenuItem( fileMenu,
wxID_EXIT,
_( "&Quit" ),
- _( "Quit EESchema" ),
+ _( "Quit Eeschema" ),
KiBitmap( exit_xpm ) );
// Menu Edit:
@@ -399,7 +399,7 @@ void SCH_EDIT_FRAME::ReCreateMenuBar()
AddMenuItem( preferencesMenu,
wxID_PREFERENCES,
_( "&Options" ),
- _( "EESchema preferences" ),
+ _( "Eeschema preferences" ),
KiBitmap( preference_xpm ) );
#endif // __WXMAC__
@@ -479,18 +479,18 @@ void SCH_EDIT_FRAME::ReCreateMenuBar()
// Separator
toolsMenu->AppendSeparator();
- //Run CVPcb
+ //Run CvPcb
AddMenuItem( toolsMenu,
ID_TO_CVPCB,
_( "A&ssign Component Footprints" ),
- _( "Run CVPcb" ),
+ _( "Run CvPcb" ),
KiBitmap( cvpcb_xpm ) );
- // Run PCBNew
+ // Run Pcbnew
AddMenuItem( toolsMenu,
ID_TO_PCB,
_( "&Layout Printed Circuit Board" ),
- _( "Run PCBNew" ),
+ _( "Run Pcbnew" ),
KiBitmap( pcbnew_xpm ) );
@@ -516,8 +516,8 @@ void SCH_EDIT_FRAME::ReCreateMenuBar()
helpMenu->AppendSeparator();
AddMenuItem( helpMenu,
wxID_ABOUT,
- _( "&About EESchema" ),
- _( "About EESchema schematic designer" ),
+ _( "&About Eeschema" ),
+ _( "About Eeschema schematic designer" ),
KiBitmap( info_xpm ) );
// Create the menubar and append all submenus
diff --git a/eeschema/menubar_libedit.cpp b/eeschema/menubar_libedit.cpp
index 33b328a894..a97475a674 100644
--- a/eeschema/menubar_libedit.cpp
+++ b/eeschema/menubar_libedit.cpp
@@ -237,7 +237,7 @@ void LIB_EDIT_FRAME::ReCreateMenuBar()
AddMenuItem( helpMenu,
wxID_HELP,
_( "&Contents" ),
- _( "Open the eeschema manual" ),
+ _( "Open the Eeschema manual" ),
KiBitmap( online_help_xpm ) );
AddMenuItem( helpMenu,
wxID_INDEX,
@@ -245,12 +245,12 @@ void LIB_EDIT_FRAME::ReCreateMenuBar()
_( "Open the \"Getting Started in KiCad\" guide for beginners" ),
KiBitmap( help_xpm ) );
- // About EESchema
+ // About Eeschema
helpMenu->AppendSeparator();
AddMenuItem( helpMenu,
wxID_ABOUT,
- _( "&About EESchema" ),
- _( "About EESchema schematic designer" ),
+ _( "&About Eeschema" ),
+ _( "About Eeschema schematic designer" ),
KiBitmap( info_xpm ) );
// Create the menubar and append all submenus
diff --git a/eeschema/netform.cpp b/eeschema/netform.cpp
index 9743f8fa2f..e6b813e885 100644
--- a/eeschema/netform.cpp
+++ b/eeschema/netform.cpp
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2009 jean-pierre.charras@gipsa-lab.inpg.fr
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -658,8 +658,9 @@ XNODE* EXPORT_HELP::makeGenericDesignHeader()
xdesign->AddChild( node( wxT( "date" ), FROM_UTF8( date )) );
- // which eeschema tool
- xdesign->AddChild( node( wxT( "tool" ), wxGetApp().GetAppName() + wxChar(' ') + GetBuildVersion() ) );
+ // which Eeschema tool
+ xdesign->AddChild( node( wxT( "tool" ), wxGetApp().GetAppName() + wxChar(' ') +
+ GetBuildVersion() ) );
/* @todo might do a list of schematic pages
diff --git a/eeschema/netlist.h b/eeschema/netlist.h
index 6c30323e3e..3d299c2ddd 100644
--- a/eeschema/netlist.h
+++ b/eeschema/netlist.h
@@ -1,13 +1,13 @@
-/***************/
-/* netlist.h */
-/***************/
+/**
+ * @file netlist.h
+ */
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2011 jean-pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr>
* Copyright (C) 1992-2011 Wayne Stambaugh <stambaughw@verizon.net>
- * Copyright (C) 1992-2011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/eeschema/netlist_control.cpp b/eeschema/netlist_control.cpp
index 55897e0bd3..73034d0e8d 100644
--- a/eeschema/netlist_control.cpp
+++ b/eeschema/netlist_control.cpp
@@ -1,10 +1,11 @@
-/**********************************/
-/* Dialog box for netlist outputs */
-/**********************************/
+/**
+ * @file netlist_control.cpp
+ * @brief Dialog box for creating netlists.
+ */
-/* Functions relatives to the dialog creating the netlist for pcbnew.
+/* Functions relative to the dialog creating the netlist for Pcbnew.
* The dialog is a notebook with 4 fixed netlist format:
- * PCBNEW ORCADPCB2 CADSTAR and SPICE
+ * Pcbnew ORCADPCB2 CADSTAR and SPICE
* and up to CUSTOMPANEL_COUNTMAX (see netlist.h) user programmable format
* calling an external converter with convert an intermediate format to the
* user specific format.
diff --git a/eeschema/pinedit.cpp b/eeschema/pinedit.cpp
index 8595088a06..5474c9be9f 100644
--- a/eeschema/pinedit.cpp
+++ b/eeschema/pinedit.cpp
@@ -1,6 +1,7 @@
-/***************************/
-/* EESchema - PinEdit.cpp */
-/***************************/
+/**
+ * @file pinedit.cpp
+ * @brief Eeschema pin edit code.
+ */
#include "fctsys.h"
#include "gr_basic.h"
diff --git a/eeschema/sch_bitmap.cpp b/eeschema/sch_bitmap.cpp
index a671308bf6..92a438bfda 100644
--- a/eeschema/sch_bitmap.cpp
+++ b/eeschema/sch_bitmap.cpp
@@ -1,12 +1,12 @@
-/********************/
-/* sch_bitmap.cpp */
-/********************/
+/**
+ * @file sch_bitmap.cpp
+ */
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2011 jean-pierre.charras
- * Copyright (C) 2011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -152,7 +152,7 @@ bool SCH_BITMAP::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( strnicmp( line, "$Bitmap", 7 ) != 0 )
{
- aErrorMsg.Printf( wxT( "EESchema file bitmap image load error at line %d, aborted" ),
+ aErrorMsg.Printf( wxT( "Eeschema file bitmap image load error at line %d, aborted" ),
aLine.LineNumber() );
aErrorMsg << wxT( "\n" ) << FROM_UTF8( (char*) aLine );
return false;
diff --git a/eeschema/sch_bitmap.h b/eeschema/sch_bitmap.h
index cde1b9690e..05f2bcedd9 100644
--- a/eeschema/sch_bitmap.h
+++ b/eeschema/sch_bitmap.h
@@ -4,10 +4,10 @@
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2011 jean-pierre.charras
- * Copyright (C) 2011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/eeschema/sch_bus_entry.cpp b/eeschema/sch_bus_entry.cpp
index 9d944374fd..d2083ef5ef 100644
--- a/eeschema/sch_bus_entry.cpp
+++ b/eeschema/sch_bus_entry.cpp
@@ -93,7 +93,7 @@ bool SCH_BUS_ENTRY::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( sscanf( line, "%s %s", Name1, Name2 ) != 2 )
{
- aErrorMsg.Printf( wxT( "EESchema file bus entry load error at line %d" ),
+ aErrorMsg.Printf( wxT( "Eeschema file bus entry load error at line %d" ),
aLine.LineNumber() );
aErrorMsg << wxT( "\n" ) << FROM_UTF8( (char*) aLine );
return false;
diff --git a/eeschema/sch_collectors.cpp b/eeschema/sch_collectors.cpp
index aa7c1fd0e0..93d4dc9819 100644
--- a/eeschema/sch_collectors.cpp
+++ b/eeschema/sch_collectors.cpp
@@ -1,8 +1,12 @@
+/**
+ * @file sch_collectors.cpp
+ */
+
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2011 Wayne Stambaugh <stambaughw@verizon.net>
- * Copyright (C) 2004-2011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2004-2011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/eeschema/sch_collectors.h b/eeschema/sch_collectors.h
index da15d37a62..d7c9b6cc51 100644
--- a/eeschema/sch_collectors.h
+++ b/eeschema/sch_collectors.h
@@ -1,8 +1,12 @@
+/**
+ * @file sch_collectors.h
+ */
+
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2011 Wayne Stambaugh <stambaughw@verizon.net>
- * Copyright (C) 2004-20011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 20011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/eeschema/sch_component.cpp b/eeschema/sch_component.cpp
index e11eae846d..a808a418c3 100644
--- a/eeschema/sch_component.cpp
+++ b/eeschema/sch_component.cpp
@@ -993,7 +993,7 @@ bool SCH_COMPONENT::Save( FILE* f ) const
/* If this is a complex hierarchy; save hierarchical references.
* but for simple hierarchies it is not necessary.
* the reference inf is already saved
- * this is useful for old eeschema version compatibility
+ * this is useful for old Eeschema version compatibility
*/
if( m_PathsAndReferences.GetCount() > 1 )
{
@@ -1089,7 +1089,7 @@ bool SCH_COMPONENT::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( sscanf( &line[1], "%s %s", name1, name2 ) != 2 )
{
- aErrorMsg.Printf( wxT( "EESchema Component descr error at line %d, aborted" ),
+ aErrorMsg.Printf( wxT( "Eeschema component description error at line %d, aborted" ),
aLine.LineNumber() );
aErrorMsg << wxT( "\n" ) << FROM_UTF8( line );
return false;
@@ -1239,7 +1239,7 @@ bool SCH_COMPONENT::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( *ptcar != '"' )
{
- aErrorMsg.Printf( wxT( "EESchema file lib field F at line %d, aborted" ),
+ aErrorMsg.Printf( wxT( "Eeschema file library field F at line %d, aborted" ),
aLine.LineNumber() );
return false;
}
diff --git a/eeschema/sch_component.h b/eeschema/sch_component.h
index 386919a0df..780e070eb2 100644
--- a/eeschema/sch_component.h
+++ b/eeschema/sch_component.h
@@ -1,6 +1,7 @@
-/******************************************************/
-/* Definitions for the Component classes for EESchema */
-/******************************************************/
+/**
+ * @file sch_component.h
+ * @brief Definition the SCH_COMPONENT class for Eeschema.
+ */
#ifndef COMPONENT_CLASS_H
#define COMPONENT_CLASS_H
diff --git a/eeschema/sch_field.h b/eeschema/sch_field.h
index 50f66be69b..f18ff20b8d 100644
--- a/eeschema/sch_field.h
+++ b/eeschema/sch_field.h
@@ -1,6 +1,7 @@
-/*************************************************************/
-/* Definitions for the component fields classes for EESchema */
-/*************************************************************/
+/**
+ * @file sch_field.h
+ * @brief Definition of the SCH_FIELD class for Eeschema.
+ */
#ifndef CLASS_SCH_FIELD_H
#define CLASS_SCH_FIELD_H
diff --git a/eeschema/sch_junction.cpp b/eeschema/sch_junction.cpp
index 799895d925..122b33d73a 100644
--- a/eeschema/sch_junction.cpp
+++ b/eeschema/sch_junction.cpp
@@ -68,7 +68,7 @@ bool SCH_JUNCTION::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( sscanf( line, "%s %d %d", name, &m_Pos.x, &m_Pos.y ) != 3 )
{
- aErrorMsg.Printf( wxT( "EESchema file connection load error at line %d, aborted" ),
+ aErrorMsg.Printf( wxT( "Eeschema file connection load error at line %d, aborted" ),
aLine.LineNumber() );
aErrorMsg << wxT( "\n" ) << FROM_UTF8( (char*) aLine );
return false;
diff --git a/eeschema/sch_line.cpp b/eeschema/sch_line.cpp
index b1a3dafe0a..1bbc5963bb 100644
--- a/eeschema/sch_line.cpp
+++ b/eeschema/sch_line.cpp
@@ -154,7 +154,7 @@ bool SCH_LINE::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( sscanf( line, "%s %s", Name1, Name2 ) != 2 )
{
- aErrorMsg.Printf( wxT( "EESchema file segment error at line %d, aborted" ),
+ aErrorMsg.Printf( wxT( "Eeschema file segment error at line %d, aborted" ),
aLine.LineNumber() );
aErrorMsg << wxT( "\n" ) << FROM_UTF8( (char*) aLine );
return false;
@@ -171,7 +171,7 @@ bool SCH_LINE::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( !aLine.ReadLine() || sscanf( (char*) aLine, "%d %d %d %d ",
&m_Start.x, &m_Start.y, &m_End.x, &m_End.y ) != 4 )
{
- aErrorMsg.Printf( wxT( "EESchema file Segment struct error at line %d, aborted" ),
+ aErrorMsg.Printf( wxT( "Eeschema file Segment struct error at line %d, aborted" ),
aLine.LineNumber() );
aErrorMsg << wxT( "\n" ) << FROM_UTF8( (char*) aLine );
return false;
diff --git a/eeschema/sch_no_connect.cpp b/eeschema/sch_no_connect.cpp
index 4a8b054cbf..7c5cc00a14 100644
--- a/eeschema/sch_no_connect.cpp
+++ b/eeschema/sch_no_connect.cpp
@@ -77,7 +77,7 @@ bool SCH_NO_CONNECT::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( sscanf( line, "%s %d %d", name, &m_Pos.x, &m_Pos.y ) != 3 )
{
- aErrorMsg.Printf( wxT( "EESchema file No Connect load error at line %d" ),
+ aErrorMsg.Printf( wxT( "Eeschema file No Connect load error at line %d" ),
aLine.LineNumber() );
aErrorMsg << wxT( "\n" ) << FROM_UTF8( ((char*)aLine) );
return false;
diff --git a/eeschema/sch_polyline.cpp b/eeschema/sch_polyline.cpp
index f62e19ad5f..4cb4db12ad 100644
--- a/eeschema/sch_polyline.cpp
+++ b/eeschema/sch_polyline.cpp
@@ -98,7 +98,7 @@ bool SCH_POLYLINE::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( sscanf( line, "%s %s %d", Name1, Name2, &ii ) != 3 )
{
- aErrorMsg.Printf( wxT( "EESchema file polyline struct error at line %d, aborted" ),
+ aErrorMsg.Printf( wxT( "Eeschema file polyline struct error at line %d, aborted" ),
aLine.LineNumber() );
aErrorMsg << wxT( "\n" ) << FROM_UTF8( (char*) aLine );
return false;
@@ -118,7 +118,7 @@ bool SCH_POLYLINE::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( !aLine.ReadLine() || sscanf( ((char*) aLine), "%d %d", &pt.x, &pt.y ) != 2 )
{
- aErrorMsg.Printf( wxT( "EESchema file polyline struct error at line %d, aborted" ),
+ aErrorMsg.Printf( wxT( "Eeschema file polyline struct error at line %d, aborted" ),
aLine.LineNumber() );
aErrorMsg << wxT( "\n" ) << FROM_UTF8( (char*) aLine );
return false;
diff --git a/eeschema/sch_screen.cpp b/eeschema/sch_screen.cpp
index 6034fc04e0..727ca85b03 100644
--- a/eeschema/sch_screen.cpp
+++ b/eeschema/sch_screen.cpp
@@ -27,7 +27,7 @@
#include <boost/foreach.hpp>
-/* Default EESchema zoom values. Limited to 17 values to keep a decent size
+/* Default Eeschema zoom values. Limited to 17 values to keep a decent size
* to menus
*/
/* Please, note: wxMSW before version 2.9 seems have
diff --git a/eeschema/sch_sheet.cpp b/eeschema/sch_sheet.cpp
index 908c53b76d..e05dd3bd07 100644
--- a/eeschema/sch_sheet.cpp
+++ b/eeschema/sch_sheet.cpp
@@ -189,7 +189,7 @@ bool SCH_SHEET::Load( LINE_READER& aLine, wxString& aErrorMsg )
&m_Pos.x, &m_Pos.y, &m_Size.x, &m_Size.y ) != 4 )
|| ( ((char*)aLine)[0] != 'S' ) )
{
- aErrorMsg.Printf( wxT( " ** EESchema file sheet struct error at line %d, aborted\n" ),
+ aErrorMsg.Printf( wxT( " ** Eeschema file sheet struct error at line %d, aborted\n" ),
aLine.LineNumber() );
aErrorMsg << FROM_UTF8( ((char*)aLine) );
@@ -226,7 +226,7 @@ bool SCH_SHEET::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( *ptcar != '"' )
{
- aErrorMsg.Printf( wxT( "EESchema file sheet label F%d at line %d, aborted\n" ),
+ aErrorMsg.Printf( wxT( "Eeschema file sheet label F%d at line %d, aborted\n" ),
fieldNdx, aLine.LineNumber() );
aErrorMsg << FROM_UTF8( (char*) aLine );
return false;
@@ -237,7 +237,7 @@ bool SCH_SHEET::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( *ptcar == 0 )
{
- aErrorMsg.Printf( wxT( "EESchema file sheet field F at line %d, aborted\n" ),
+ aErrorMsg.Printf( wxT( "Eeschema file sheet field F at line %d, aborted\n" ),
aLine.LineNumber() );
aErrorMsg << FROM_UTF8( (char*) aLine );
return false;
@@ -247,7 +247,7 @@ bool SCH_SHEET::Load( LINE_READER& aLine, wxString& aErrorMsg )
{
if( sscanf( ptcar, "%d", &size ) != 1 )
{
- aErrorMsg.Printf( wxT( "EESchema file sheet Label error line %d, aborted\n" ),
+ aErrorMsg.Printf( wxT( "Eeschema file sheet Label error line %d, aborted\n" ),
aLine.LineNumber() );
aErrorMsg << FROM_UTF8( (char*) aLine );
@@ -284,7 +284,7 @@ bool SCH_SHEET::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( strnicmp( "$End", ((char*)aLine), 4 ) != 0 )
{
- aErrorMsg.Printf( wxT( "**EESchema file end_sheet struct error at line %d, aborted\n" ),
+ aErrorMsg.Printf( wxT( "**Eeschema file end_sheet struct error at line %d, aborted\n" ),
aLine.LineNumber() );
aErrorMsg << FROM_UTF8( ((char*)aLine) );
return false;
diff --git a/eeschema/sch_sheet.h b/eeschema/sch_sheet.h
index c5a1309952..d895a904e3 100644
--- a/eeschema/sch_sheet.h
+++ b/eeschema/sch_sheet.h
@@ -1,6 +1,7 @@
-/********************************************/
-/* Definitions for the EESchema program: */
-/********************************************/
+/**
+ * @file sch_sheet.h
+ * @brief Definition of the SCH_SHEET class for Eeschema.
+ */
#ifndef CLASS_DRAWSHEET_H
#define CLASS_DRAWSHEET_H
diff --git a/eeschema/sch_sheet_path.h b/eeschema/sch_sheet_path.h
index bdc5aafd8e..64d32db651 100644
--- a/eeschema/sch_sheet_path.h
+++ b/eeschema/sch_sheet_path.h
@@ -1,6 +1,7 @@
-/********************************************/
-/* Definitions for the EESchema program: */
-/********************************************/
+/**
+ * @file sch_sheet_path.h
+ * @brief Definition of the SCH_SHEET_PATH and SCH_SHEET_LIST classes for Eeschema.
+ */
#ifndef CLASS_DRAWSHEET_PATH_H
#define CLASS_DRAWSHEET_PATH_H
@@ -25,10 +26,10 @@
* 2 sheets share the same SCH_SCREEN (the same drawings) if they have the
* same filename.
*
- * In Kicad each component and sheet receives (when created) an unique
+ * In KiCad each component and sheet receives (when created) an unique
* identification called Time Stamp. So each sheet has 2 ids: its time stamp
* (that cannot change) and its name ( that can be edited and therefore is
- * not reliable for strong identification). Kicad uses Time Stamp ( a unique
+ * not reliable for strong identification). KiCad uses Time Stamp ( a unique
* 32 bit id), to identify sheets in hierarchies.
* A given sheet in a hierarchy is fully labeled by its path (or sheet path)
* that is the list of time stamp found to access it through the hierarchy
diff --git a/eeschema/sch_sheet_pin.cpp b/eeschema/sch_sheet_pin.cpp
index c425ee0e56..0acffb854d 100644
--- a/eeschema/sch_sheet_pin.cpp
+++ b/eeschema/sch_sheet_pin.cpp
@@ -327,7 +327,7 @@ bool SCH_SHEET_PIN::Load( LINE_READER& aLine, wxString& aErrorMsg )
int r = sscanf( cp, "%d %d %d", &m_Pos.x, &m_Pos.y, &size );
if( r != 3 )
{
- aErrorMsg.Printf( wxT( "EESchema file sheet hierarchical label error at line %d.\n" ),
+ aErrorMsg.Printf( wxT( "Eeschema file sheet hierarchical label error at line %d.\n" ),
aLine.LineNumber() );
aErrorMsg << FROM_UTF8( line );
diff --git a/eeschema/sch_text.cpp b/eeschema/sch_text.cpp
index 82d3f1663d..7620f63502 100644
--- a/eeschema/sch_text.cpp
+++ b/eeschema/sch_text.cpp
@@ -459,14 +459,14 @@ bool SCH_TEXT::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( ii < 4 )
{
- aErrorMsg.Printf( wxT( "EESchema file text load error at line %d" ),
+ aErrorMsg.Printf( wxT( "Eeschema file text load error at line %d" ),
aLine.LineNumber() );
return false;
}
if( !aLine.ReadLine() )
{
- aErrorMsg.Printf( wxT( "EESchema file text load error at line %d" ),
+ aErrorMsg.Printf( wxT( "Eeschema file text load error at line %d" ),
aLine.LineNumber() );
return false;
}
@@ -478,7 +478,7 @@ bool SCH_TEXT::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( text == NULL )
{
- aErrorMsg.Printf( wxT( "EESchema file text load error at line %d" ),
+ aErrorMsg.Printf( wxT( "Eeschema file text load error at line %d" ),
aLine.LineNumber() );
return false;
}
@@ -811,14 +811,14 @@ bool SCH_LABEL::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( ii < 4 )
{
- aErrorMsg.Printf( wxT( "EESchema file label load error at line %d" ),
+ aErrorMsg.Printf( wxT( "Eeschema file label load error at line %d" ),
aLine.LineNumber() );
return false;
}
if( !aLine.ReadLine() )
{
- aErrorMsg.Printf( wxT( "EESchema file label load error atline %d" ),
+ aErrorMsg.Printf( wxT( "Eeschema file label load error atline %d" ),
aLine.LineNumber() );
return false;
}
@@ -830,7 +830,7 @@ bool SCH_LABEL::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( text == NULL )
{
- aErrorMsg.Printf( wxT( "EESchema file label load error at line %d" ),
+ aErrorMsg.Printf( wxT( "Eeschema file label load error at line %d" ),
aLine.LineNumber() );
return false;
}
@@ -984,14 +984,14 @@ bool SCH_GLOBALLABEL::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( ii < 4 )
{
- aErrorMsg.Printf( wxT( "EESchema file global label load error at line %d" ),
+ aErrorMsg.Printf( wxT( "Eeschema file global label load error at line %d" ),
aLine.LineNumber() );
return false;
}
if( !aLine.ReadLine() )
{
- aErrorMsg.Printf( wxT( "EESchema file global label load error at line %d" ),
+ aErrorMsg.Printf( wxT( "Eeschema file global label load error at line %d" ),
aLine.LineNumber() );
return false;
}
@@ -1003,7 +1003,7 @@ bool SCH_GLOBALLABEL::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( text == NULL )
{
- aErrorMsg.Printf( wxT( "EESchema file global label load error at line %d" ),
+ aErrorMsg.Printf( wxT( "Eeschema file global label load error at line %d" ),
aLine.LineNumber() );
return false;
}
@@ -1416,14 +1416,14 @@ bool SCH_HIERLABEL::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( ii < 4 )
{
- aErrorMsg.Printf( wxT( "EESchema file hierarchical label load error at line %d" ),
+ aErrorMsg.Printf( wxT( "Eeschema file hierarchical label load error at line %d" ),
aLine.LineNumber() );
return false;
}
if( !aLine.ReadLine() )
{
- aErrorMsg.Printf( wxT( "EESchema file hierarchical label load error at line %d" ),
+ aErrorMsg.Printf( wxT( "Eeschema file hierarchical label load error at line %d" ),
aLine.LineNumber() );
return false;
}
@@ -1435,7 +1435,7 @@ bool SCH_HIERLABEL::Load( LINE_READER& aLine, wxString& aErrorMsg )
if( text == NULL )
{
- aErrorMsg.Printf( wxT( "EESchema file hierarchical label load error at line %d" ),
+ aErrorMsg.Printf( wxT( "Eeschema file hierarchical label load error at line %d" ),
aLine.LineNumber() );
return false;
}
diff --git a/eeschema/sch_text.h b/eeschema/sch_text.h
index 819d51fb99..51b548ea55 100644
--- a/eeschema/sch_text.h
+++ b/eeschema/sch_text.h
@@ -1,6 +1,7 @@
-/********************************************/
-/* Definitions for the EESchema program: */
-/********************************************/
+/**
+ * @file sch_text.h
+ * @brief Definitions of the SCH_TEXT class and derivatives for Eeschema.
+ */
#ifndef CLASS_TEXT_LABEL_H
#define CLASS_TEXT_LABEL_H
diff --git a/eeschema/schematic_undo_redo.cpp b/eeschema/schematic_undo_redo.cpp
index d2b7fda7ae..8ec79c7fb6 100644
--- a/eeschema/schematic_undo_redo.cpp
+++ b/eeschema/schematic_undo_redo.cpp
@@ -1,6 +1,7 @@
-/************************************************************/
-/* eeschema: undo and redo functions for schematic editor */
-/************************************************************/
+/**
+ * @file schematic_undo_redo.cpp
+ * @brief Eeschema undo and redo functions for schematic editor.
+ */
#include "fctsys.h"
#include "class_drawpanel.h"
diff --git a/eeschema/selpart.cpp b/eeschema/selpart.cpp
index 8464285be3..bb8aab8389 100644
--- a/eeschema/selpart.cpp
+++ b/eeschema/selpart.cpp
@@ -1,6 +1,6 @@
-/**************************/
-/* EESchema - selpart.cpp */
-/**************************/
+/**
+ * @file selpart.cpp
+ */
#include "fctsys.h"
#include "gr_basic.h"
diff --git a/eeschema/symbdraw.cpp b/eeschema/symbdraw.cpp
index 08fc58cc2e..138d6ca8a1 100644
--- a/eeschema/symbdraw.cpp
+++ b/eeschema/symbdraw.cpp
@@ -1,8 +1,7 @@
-/*********************************************************************/
-/* EESchema - symbdraw.cpp */
-/* Create, move .. graphic shapes used to build and draw a component */
-/* (lines, arcs .. */
-/*********************************************************************/
+/**
+ * @file symbdraw.cpp
+ * @brief Create, move .. graphic shapes used to build and draw a component (lines, arcs ..)
+ */
#include "fctsys.h"
#include "gr_basic.h"
diff --git a/eeschema/template_fieldnames.cpp b/eeschema/template_fieldnames.cpp
index 5ac03dc409..c32e9a42ad 100644
--- a/eeschema/template_fieldnames.cpp
+++ b/eeschema/template_fieldnames.cpp
@@ -13,7 +13,7 @@ wxString TEMPLATE_FIELDNAME::GetDefaultFieldName( int aFieldNdx )
static const wxString fixedNames[] = {
_( "Reference" ), // The component reference, R1, C1, etc.
_( "Value" ), // The component value + name
- _( "Footprint" ), // The footprint for use with PCBNEW
+ _( "Footprint" ), // The footprint for use with Pcbnew
_( "Datasheet" ), // Link to a datasheet for component
};
diff --git a/eeschema/tool_sch.cpp b/eeschema/tool_sch.cpp
index cd3e3af1ec..7f95cdb305 100644
--- a/eeschema/tool_sch.cpp
+++ b/eeschema/tool_sch.cpp
@@ -131,10 +131,10 @@ void SCH_EDIT_FRAME::ReCreateHToolbar()
m_HToolBar->AddTool( ID_TO_CVPCB, wxEmptyString, KiBitmap( cvpcb_xpm ),
- _( "Run CVPcb - Associate components and footprints" ) );
+ _( "Run CvPcb to associate components and footprints" ) );
m_HToolBar->AddTool( ID_TO_PCB, wxEmptyString, KiBitmap( pcbnew_xpm ),
- _( "Run PCBNew - Layout printed circuit board" ) );
+ _( "Run Pcbnew to layout printed circuit board" ) );
m_HToolBar->AddTool( ID_BACKANNO_ITEMS, wxEmptyString, KiBitmap( import_footprint_names_xpm ),
_( "Back annotate component foot prints" ) );
diff --git a/eeschema/transform.h b/eeschema/transform.h
index f0562eeea5..9edb3c52b8 100644
--- a/eeschema/transform.h
+++ b/eeschema/transform.h
@@ -1,9 +1,12 @@
+/**
+ * @file transform.h
+ */
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2010 Wayne Stambaugh <stambaughw@verizon.net>
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/eeschema/viewlib_frame.cpp b/eeschema/viewlib_frame.cpp
index d96800b354..57e35ba49b 100644
--- a/eeschema/viewlib_frame.cpp
+++ b/eeschema/viewlib_frame.cpp
@@ -58,7 +58,7 @@ END_EVENT_TABLE()
/*
- * This emulates the zoom menu entries found in the other Kicad applications.
+ * This emulates the zoom menu entries found in the other KiCad applications.
* The library viewer does not have any menus so add an accelerator table to
* the main frame.
*/
diff --git a/eeschema/viewlibs.cpp b/eeschema/viewlibs.cpp
index 5399d2a822..109f5a6281 100644
--- a/eeschema/viewlibs.cpp
+++ b/eeschema/viewlibs.cpp
@@ -1,6 +1,6 @@
-/****************************/
-/* EESchema - viewlibs.cpp */
-/****************************/
+/**
+ * @file viewlibs.cpp
+ */
#include "fctsys.h"
#include "gr_basic.h"
diff --git a/gerbview/block.cpp b/gerbview/block.cpp
index 7d5b735461..1bca89217f 100644
--- a/gerbview/block.cpp
+++ b/gerbview/block.cpp
@@ -1,12 +1,13 @@
-/**********************************/
-/* Block operations: displacement */
-/**********************************/
+/**
+ * @file gerbview/block.cpp
+ * @brief Block operations: displacement.
+ */
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 <Jean-Pierre Charras>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/gerbview/class_GERBER.cpp b/gerbview/class_GERBER.cpp
index 31ea8aca3a..f7dc01df83 100644
--- a/gerbview/class_GERBER.cpp
+++ b/gerbview/class_GERBER.cpp
@@ -1,12 +1,13 @@
-/** @file class_GERBER.cpp
+/**
+ * @file class_GERBER.cpp
* a GERBER class handle for a given layer info about used D_CODES and how the layer is drawn
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 <Jean-Pierre Charras>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/gerbview/class_GERBER.h b/gerbview/class_GERBER.h
index 7302000c21..d1e4499953 100644
--- a/gerbview/class_GERBER.h
+++ b/gerbview/class_GERBER.h
@@ -30,11 +30,11 @@ class D_CODE;
* Some parameters can change along a file and are not layer specific: they are stored
* in GERBER_ITEM items, when instancied.
*
- * In Gerbview, to handle these parameters, there are 2 classes:
+ * In GerbView, to handle these parameters, there are 2 classes:
* GERBER_IMAGE : the main class containing most of parameters and data to plot a graphic layer
* Some of them can change along the file
* There is one GERBER_IMAGE per file and one graphic layer per file or GERBER_IMAGE
- * Gerbview does not read and merge 2 gerber file in one graphic layer:
+ * GerbView does not read and merge 2 gerber file in one graphic layer:
* I believe this is not possible due to the constraints in Image parameters.
* GERBER_LAYER : containing the subset of parameters that is layer speficic
* A GERBER_IMAGE must include one GERBER_LAYER to define all parameters to plot a file.
diff --git a/gerbview/class_am_param.cpp b/gerbview/class_am_param.cpp
index 65feb88597..b7315e9fab 100644
--- a/gerbview/class_am_param.cpp
+++ b/gerbview/class_am_param.cpp
@@ -1,13 +1,13 @@
-/*****************/
-/* am_param.cpp */
-/*****************/
+/**
+ * @file class_am_param.cpp
+ */
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 Jean-Pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr>
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/gerbview/class_am_param.h b/gerbview/class_am_param.h
index d396cfd1d8..48ca662d41 100644
--- a/gerbview/class_am_param.h
+++ b/gerbview/class_am_param.h
@@ -1,13 +1,13 @@
-/*****************/
-/* am_param.h */
-/*****************/
+/**
+ * @file class_am_param.h
+ */
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 Jean-Pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr>
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/gerbview/class_aperture_macro.cpp b/gerbview/class_aperture_macro.cpp
index d241675eea..79cfd2963d 100644
--- a/gerbview/class_aperture_macro.cpp
+++ b/gerbview/class_aperture_macro.cpp
@@ -1,14 +1,13 @@
-/****************************/
-/* class_aperture_macro.cpp */
-/****************************/
-
+/**
+ * @file class_aperture_macro.cpp
+ */
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 Jean-Pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr>
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -49,7 +48,7 @@ extern int scale( double aCoord, bool isMetric ); // defined it rs274d
* Function mapPt
* translates a point from the aperture macro coordinate system to our
* deci-mils coordinate system.
- * @return wxPoint - The gerbview coordinate system vector.
+ * @return wxPoint - The GerbView coordinate system vector.
*/
static wxPoint mapPt( double x, double y, bool isMetric )
{
diff --git a/gerbview/class_aperture_macro.h b/gerbview/class_aperture_macro.h
index 8f91ba94a2..a20cf129a5 100644
--- a/gerbview/class_aperture_macro.h
+++ b/gerbview/class_aperture_macro.h
@@ -1,16 +1,16 @@
-/**************************/
-/* class_aperture_macro.h */
-/**************************/
+/**
+ * @file class_aperture_macro.h
+ */
#ifndef _APERTURE_MACRO_H_
#define _APERTURE_MACRO_H_
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 Jean-Pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr>
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/gerbview/class_gerber_draw_item.cpp b/gerbview/class_gerber_draw_item.cpp
index db25ca1d4b..2e798a1583 100644
--- a/gerbview/class_gerber_draw_item.cpp
+++ b/gerbview/class_gerber_draw_item.cpp
@@ -1,12 +1,12 @@
-/*************************************
-* file class_gerber_draw_item.cpp
-*************************************/
+/**
+ * @file class_gerber_draw_item.cpp
+ */
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 <Jean-Pierre Charras>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/gerbview/class_gerber_draw_item.h b/gerbview/class_gerber_draw_item.h
index 6a41501c05..1f422d29a3 100644
--- a/gerbview/class_gerber_draw_item.h
+++ b/gerbview/class_gerber_draw_item.h
@@ -1,15 +1,15 @@
-/*****************************/
-/* class_gerber_draw_item.h */
-/*****************************/
+/**
+ * @file class_gerber_draw_item.h
+ */
#ifndef CLASS_GERBER_DRAW_ITEM_H
#define CLASS_GERBER_DRAW_ITEM_H
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 <Jean-Pierre Charras>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/gerbview/class_gerbview_layer_widget.cpp b/gerbview/class_gerbview_layer_widget.cpp
index aee403118c..4abe922d68 100644
--- a/gerbview/class_gerbview_layer_widget.cpp
+++ b/gerbview/class_gerbview_layer_widget.cpp
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004-2010 Jean-Pierre Charras, jean-pierre.charras@gpisa-lab.inpg.fr
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -24,9 +24,10 @@
*/
-/*********************************************************/
-/* class_gerbview_layer_widget.cpp - gerbview layers manager. */
-/*********************************************************/
+/**
+ * @file class_gerbview_layer_widget.cpp
+ * @brief GerbView layers manager.
+ */
#include "fctsys.h"
#include "common.h"
@@ -45,7 +46,7 @@
* Class 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.
+ * menu which is specific to Pcbnew's needs.
*/
@@ -56,7 +57,7 @@ GERBER_LAYER_WIDGET::GERBER_LAYER_WIDGET( GERBVIEW_FRAME* aParent, wxWindow* aFo
{
ReFillRender();
- // Update default tabs labels for gerbview
+ // Update default tabs labels for GerbView
SetLayersManagerTabsText( );
//-----<Popup menu>-------------------------------------------------
diff --git a/gerbview/class_gerbview_layer_widget.h b/gerbview/class_gerbview_layer_widget.h
index fba4d8b4fd..e11814a3b8 100644
--- a/gerbview/class_gerbview_layer_widget.h
+++ b/gerbview/class_gerbview_layer_widget.h
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004-2010 Jean-Pierre Charras, jean-pierre.charras@gpisa-lab.inpg.fr
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -37,7 +37,7 @@
* Class 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.
+ * menu which is specific to Pcbnew's needs.
*/
class GERBER_LAYER_WIDGET : public LAYER_WIDGET
{
diff --git a/gerbview/dcode.h b/gerbview/dcode.h
index f2d134e02f..daed654bc8 100644
--- a/gerbview/dcode.h
+++ b/gerbview/dcode.h
@@ -1,13 +1,13 @@
-/**************/
-/* dcode.h */
-/**************/
+/**
+ * @file dcode.h
+ */
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 Jean-Pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr>
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/gerbview/dialogs/dialog_print_using_printer.cpp b/gerbview/dialogs/dialog_print_using_printer.cpp
index 2dc4589957..785fca0f98 100644
--- a/gerbview/dialogs/dialog_print_using_printer.cpp
+++ b/gerbview/dialogs/dialog_print_using_printer.cpp
@@ -400,7 +400,7 @@ void DIALOG_PRINT_USING_PRINTER::OnPrintPreview( wxCommandEvent& event )
SetLayerMaskFromListSelection();
// If no layer selected, we have no plot. prompt user if it happens
- // because he could think there is a bug in pcbnew:
+ // because he could think there is a bug in Pcbnew:
if( s_Parameters.m_PrintMaskLayer == 0 )
{
DisplayError( this, _( "No layer selected" ) );
@@ -430,7 +430,7 @@ void DIALOG_PRINT_USING_PRINTER::OnPrintButtonClick( wxCommandEvent& event )
SetPrintParameters( );
// If no layer selected, we have no plot. prompt user if it happens
- // because he could think there is a bug in pcbnew:
+ // because he could think there is a bug in Pcbnew:
if( s_Parameters.m_PrintMaskLayer == 0 )
{
DisplayError( this, _( "No layer selected" ) );
diff --git a/gerbview/dialogs/gerbview_dialog_display_options_frame.cpp b/gerbview/dialogs/gerbview_dialog_display_options_frame.cpp
index 5850c77aa9..ac7c28e7fb 100644
--- a/gerbview/dialogs/gerbview_dialog_display_options_frame.cpp
+++ b/gerbview/dialogs/gerbview_dialog_display_options_frame.cpp
@@ -1,6 +1,6 @@
/*
* file gerbview_dialog_display_options_frame.cpp
- * Set the display options for Gerbview
+ * Set the display options for GerbView
*/
diff --git a/gerbview/draw_gerber_screen.cpp b/gerbview/draw_gerber_screen.cpp
index f267bc047e..db2de288a1 100644
--- a/gerbview/draw_gerber_screen.cpp
+++ b/gerbview/draw_gerber_screen.cpp
@@ -109,7 +109,7 @@ void GERBVIEW_FRAME::RedrawActiveWindow( wxDC* DC, bool EraseBg )
/*
- * Redraw All gerbview layers, using a buffered mode or not
+ * Redraw All GerbView layers, using a buffered mode or not
*/
void BOARD::Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, int aDrawMode, const wxPoint& aOffset )
{
@@ -218,7 +218,7 @@ void BOARD::Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, int aDrawMode, const wxPoin
else if( aDrawMode == GR_OR )
{
// On Linux with a large screen, this version is much faster and without
- // flicker, but gives a PCBNEW look where layer colors blend together.
+ // flicker, but gives a Pcbnew look where layer colors blend together.
// Plus it works only because the background color is black. But it may
// be more useable for some. The difference is due in part because of
// the cpu cycles needed to create the monochromatic bitmap above, and
@@ -404,7 +404,7 @@ void GERBVIEW_FRAME::DrawItemsDCodeID( wxDC* aDC, int aDrawMode )
/* Virtual fonction needed by the PCB_SCREEN class derived from BASE_SCREEN
* this is a virtual pure function in BASE_SCREEN
- * do nothing in gerbview
+ * do nothing in GerbView
* could be removed later
*/
void PCB_SCREEN::ClearUndoORRedoList( UNDO_REDO_CONTAINER&, int )
@@ -415,8 +415,8 @@ void PCB_SCREEN::ClearUndoORRedoList( UNDO_REDO_CONTAINER&, int )
/* dummy_functions
*
* These functions are used in some classes.
- * they are useful in pcbnew, but have no meaning or are never used
- * in cvpcb or gerbview.
+ * they are useful in Pcbnew, but have no meaning or are never used
+ * in CvPcb or GerbView.
* but they must exist because they appear in some classes, and here, no nothing.
*/
diff --git a/gerbview/events_called_functions.cpp b/gerbview/events_called_functions.cpp
index d54867d7f1..03d546cb92 100644
--- a/gerbview/events_called_functions.cpp
+++ b/gerbview/events_called_functions.cpp
@@ -1,6 +1,6 @@
/**
* @file events_called_functions.cpp
- * @brief Gerbview command event functions.
+ * @brief GerbView command event functions.
*/
#include "fctsys.h"
diff --git a/gerbview/excellon_read_drill_file.cpp b/gerbview/excellon_read_drill_file.cpp
index c316b405bf..85e1e8aefa 100644
--- a/gerbview/excellon_read_drill_file.cpp
+++ b/gerbview/excellon_read_drill_file.cpp
@@ -1,15 +1,15 @@
/**
* @file excellon_read_drill_file.cpp
- * Functions to read drill files (EXCELLON format) created by PcbNew
+ * Functions to read drill files (EXCELLON format) created by Pcbnew
* These files use only a subset of EXCELLON commands.
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2011 Jean-Pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr>
- * Copyright (C) 1992-2011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -30,7 +30,7 @@
*/
/*
- * Here is a sample of drill files created by pcbnew, in decimal format:
+ * Here is a sample of drill files created by Pcbnew, in decimal format:
* (Note: coordinates formats are same as Gerber, and T commands are near Gerber D commands).
* M48
* ;DRILL file {PCBnew (2011-03-14 BZR 2894)-testing} date 15/03/2011 14:23:22
@@ -152,7 +152,7 @@ static EXCELLON_CMD excellon_G_CmdList[] =
bool GERBVIEW_FRAME::Read_EXCELLON_File( const wxString& aFullFileName )
{
wxString msg;
- int layer = getActiveLayer(); // current layer used in gerbview
+ int layer = getActiveLayer(); // current layer used in GerbView
if( g_GERBER_List[layer] == NULL )
{
diff --git a/gerbview/export_to_pcbnew.cpp b/gerbview/export_to_pcbnew.cpp
index b27d48da24..098bc0909c 100644
--- a/gerbview/export_to_pcbnew.cpp
+++ b/gerbview/export_to_pcbnew.cpp
@@ -1,6 +1,6 @@
/**
* @file export_to_pcbnew.cpp
- * @brief Export the layers to pcbnew.
+ * @brief Export the layers to Pcbnew.
*/
#include "fctsys.h"
@@ -60,7 +60,7 @@ GBR_TO_PCB_EXPORTER::~GBR_TO_PCB_EXPORTER()
-/* Export data in pcbnew format
+/* Export data in Pcbnew format
* remember Pcbnew uses a Y reversed axis, so we must negate all Y coordinates
*/
void GERBVIEW_FRAME::ExportDataInPcbnewFormat( wxCommandEvent& event )
@@ -101,7 +101,7 @@ void GERBVIEW_FRAME::ExportDataInPcbnewFormat( wxCommandEvent& event )
return;
/* Install a dialog frame to choose the mapping
- * between gerber layers and pcbnew layers
+ * between gerber layers and Pcbnew layers
*/
LAYERS_MAP_DIALOG* dlg = new LAYERS_MAP_DIALOG( this );
int ok = dlg->ShowModal();
@@ -196,7 +196,7 @@ bool GBR_TO_PCB_EXPORTER::WriteGeneralDescrPcb( )
/* Routine to save the board
* @param frame = pointer to the main frame
* @param File = FILE * pointer to an already opened file
- * @param LayerLookUpTable = look up table: pcbnew layer for each gerber layer
+ * @param LayerLookUpTable = look up table: Pcbnew layer for each gerber layer
* @return 1 if OK, 0 if fail
*/
bool GBR_TO_PCB_EXPORTER::ExportPcb( int* LayerLookUpTable )
diff --git a/gerbview/files.cpp b/gerbview/files.cpp
index 1f0ce4faf6..141eec6d1a 100644
--- a/gerbview/files.cpp
+++ b/gerbview/files.cpp
@@ -142,7 +142,7 @@ bool GERBVIEW_FRAME::LoadGerberFiles( const wxString& aFullFileName )
currentPath = filename.GetPath();
}
- // Read gerber files: each file is loaded on a new gerbview layer
+ // Read gerber files: each file is loaded on a new GerbView layer
int layer = getActiveLayer();
for( unsigned ii = 0; ii < filenamesList.GetCount(); ii++ )
@@ -225,7 +225,7 @@ bool GERBVIEW_FRAME::LoadExcellonFiles( const wxString& aFullFileName )
currentPath = filename.GetPath();
}
- // Read gerber files: each file is loaded on a new gerbview layer
+ // Read gerber files: each file is loaded on a new GerbView layer
int layer = getActiveLayer();
for( unsigned ii = 0; ii < filenamesList.GetCount(); ii++ )
diff --git a/gerbview/gerbview_config.cpp b/gerbview/gerbview_config.cpp
index 3ef61bc0f0..d2aeced043 100644
--- a/gerbview/gerbview_config.cpp
+++ b/gerbview/gerbview_config.cpp
@@ -1,6 +1,6 @@
/**
* @file gerbview_config.cpp
- * @brief Gerbview configuration.
+ * @brief GerbView configuration.
*/
#include "fctsys.h"
@@ -39,7 +39,7 @@ void GERBVIEW_FRAME::Process_Config( wxCommandEvent& event )
case ID_PREFERENCES_HOTKEY_SHOW_CURRENT_LIST:
- // Display current hotkey list for eeschema.
+ // Display current hotkey list for GerbView.
DisplayHotkeyList( this, s_Gerbview_Hokeys_Descr );
break;
@@ -51,15 +51,15 @@ void GERBVIEW_FRAME::Process_Config( wxCommandEvent& event )
/*
- * Return the Gerbview applications settings list.
- * (list of parameters that must be saved in Gerbview parameters)
+ * Return the GerbView applications settings list.
+ * (list of parameters that must be saved in GerbView parameters)
*
* This replaces the old statically define list that had the project
* file settings and the application settings mixed together. This
* was confusing and caused some settings to get saved and loaded
* incorrectly. Currently, only the settings that are needed at start
* up by the main window are defined here. There are other locally used
- * settings scattered thoughout the EESchema source code. If you need
+ * settings scattered thoughout the GerbView source code. If you need
* to define a configuration setting that need to be loaded at run time,
* this is the place to define it.
*
diff --git a/gerbview/gerbview_frame.cpp b/gerbview/gerbview_frame.cpp
index df42cc8dd9..69e55a4cb8 100644
--- a/gerbview/gerbview_frame.cpp
+++ b/gerbview/gerbview_frame.cpp
@@ -449,7 +449,7 @@ void GERBVIEW_FRAME::Liste_D_Codes()
/*
* Function UpdateTitleAndInfo
* displays the short filename (if exists) of the selected layer
- * on the caption of the main gerbview window
+ * on the caption of the main GerbView window
* displays image name and the last layer name (found in the gerber file: LN <name> command)
* in the status bar
* Note layer name can change when reading a gerber file, and the layer name is the last found.
diff --git a/gerbview/gerbview_frame.h b/gerbview/gerbview_frame.h
index 6cf6197188..8c464e4630 100644
--- a/gerbview/gerbview_frame.h
+++ b/gerbview/gerbview_frame.h
@@ -23,7 +23,7 @@ class GERBER_DRAW_ITEM;
/**
* Class GERBVIEW_FRAME
- * is the main window used in gerbview.
+ * is the main window used in GerbView.
*/
class GERBVIEW_FRAME : public PCB_BASE_FRAME
@@ -238,7 +238,7 @@ public: GERBVIEW_FRAME( wxWindow* father, const wxString& title,
/**
* Function UpdateTitleAndInfo
* displays the short filename (if exists) of the selected layer
- * on the caption of the main gerbview window
+ * on the caption of the main GerbView window
* and some other parameters
* Name of the layer (found in the gerber file: LN <name> command) in the status bar
* Name of the Image (found in the gerber file: IN <name> command) in the status bar
@@ -248,23 +248,23 @@ public: GERBVIEW_FRAME( wxWindow* father, const wxString& title,
/**
* Function GetConfigurationSettings
- * Populates the Gerbview applications settings list.
- * (list of parameters that must be saved in Gerbview parameters)
+ * Populates the GerbView applications settings list.
+ * (list of parameters that must be saved in GerbView parameters)
* Currently, only the settings that are needed at start
* up by the main window are defined here. There are other locally used
- * settings scattered thoughout the Gerbview source code (mainle in dialogs).
+ * settings scattered thoughout the GerbView source code (mainle in dialogs).
* If you need to define a configuration setting that need to be loaded at run time,
* this is the place to define it.
*/
PARAM_CFG_ARRAY& GetConfigurationSettings( void );
/**
- * Load applications settings specific to the PCBNew.
+ * Load applications settings specific to the Pcbnew.
*
* This overrides the base class PCB_BASE_FRAME::LoadSettings() to
* handle settings specific common to the PCB layout application. It
* calls down to the base class to load settings common to all PCB type
- * drawing frames. Please put your application settings for PCBNew here
+ * drawing frames. Please put your application settings for Pcbnew here
* to avoid having application settings loaded all over the place.
*/
virtual void LoadSettings();
@@ -275,7 +275,7 @@ public: GERBVIEW_FRAME( wxWindow* father, const wxString& title,
* This overrides the base class PCB_BASE_FRAME::SaveSettings() to
* save settings specific to the PCB layout application main window. It
* calls down to the base class to save settings common to all PCB type
- * drawing frames. Please put your application settings for PCBNew here
+ * drawing frames. Please put your application settings for Pcbnew here
* to avoid having application settings saved all over the place.
*/
virtual void SaveSettings();
@@ -357,7 +357,7 @@ public: GERBVIEW_FRAME( wxWindow* father, const wxString& title,
/**
* Function Block_Delete
* deletes all tracks and segments within the selected block.
- * Defined separately in pcbnew and gerbview
+ * Defined separately in Pcbnew and GerbView
*
* @param DC A device context to draw on.
*/
@@ -368,7 +368,7 @@ public: GERBVIEW_FRAME( wxWindow* father, const wxString& title,
* moves all tracks and segments within the selected block.
* New location is determined by the current offset from the selected
* block's original location.
- * Defined separately in pcbnew and gerbview
+ * Defined separately in Pcbnew and GerbView
*
* @param DC A device context to draw on.
*/
@@ -379,7 +379,7 @@ public: GERBVIEW_FRAME( wxWindow* father, const wxString& title,
* copies-and-moves all tracks and segments within the selected block.
* New location is determined by the current offset from the selected
* block's original location.
- * Defined separately in pcbnew and gerbview
+ * Defined separately in Pcbnew and GerbView
*
* @param DC A device context to draw on.
*/
@@ -499,7 +499,7 @@ public: GERBVIEW_FRAME( wxWindow* father, const wxString& title,
void ExportDataInPcbnewFormat( wxCommandEvent& event );
/* SaveCopyInUndoList() virtual
- * currently: do nothing in gerbview.
+ * currently: do nothing in GerbView.
* but must be defined because it is a pure virtual in PCB_BASE_FRAME
*/
virtual void SaveCopyInUndoList( BOARD_ITEM* aItemToCopy,
@@ -519,7 +519,7 @@ public: GERBVIEW_FRAME( wxWindow* father, const wxString& title,
UNDO_REDO_T aTypeCommand,
const wxPoint& aTransformPoint = wxPoint( 0, 0 ) )
{
- // currently: do nothing in gerbview.
+ // currently: do nothing in GerbView.
}
/** Virtual function PrintPage
diff --git a/gerbview/gerbview_id.h b/gerbview/gerbview_id.h
index 79bb525377..6a92e0112b 100644
--- a/gerbview/gerbview_id.h
+++ b/gerbview/gerbview_id.h
@@ -6,9 +6,9 @@
/**
* Command IDs for the printed circuit board editor.
*
- * Please add IDs that are unique to the printed circuit board editor (PCBNew)
- * here and not in the global id.h file. This will prevent the entire project
- * from being rebuilt when adding new commands to the PCBNew.
+ * Please add IDs that are unique to the gerber file viewer (GerbView) here and not in
+ * the global id.h file. This will prevent the entire project from being rebuilt when
+ * adding new commands to the GerbView.
*/
enum gerbview_ids
diff --git a/gerbview/hotkeys.cpp b/gerbview/hotkeys.cpp
index 5164bd2deb..08250ecb60 100644
--- a/gerbview/hotkeys.cpp
+++ b/gerbview/hotkeys.cpp
@@ -62,7 +62,8 @@ EDA_HOTKEY* s_Gerbview_Hotkey_List[] = {
};
-// list of sections and corresponding hotkey list for pcbnew (used to create an hotkey config file)
+// list of sections and corresponding hotkey list for GerbView (used to create an hotkey
+// config file)
struct EDA_HOTKEY_CONFIG s_Gerbview_Hokeys_Descr[] =
{
{ &g_CommonSectionTag, s_Gerbview_Hotkey_List, NULL },
diff --git a/gerbview/hotkeys.h b/gerbview/hotkeys.h
index 30a7bafac8..c159e97a46 100644
--- a/gerbview/hotkeys.h
+++ b/gerbview/hotkeys.h
@@ -17,7 +17,7 @@ enum hotkey_id_commnand {
HK_SWITCH_LAYER_TO_PREVIOUS
};
-// List of hotkey descriptors for pcbnew
+// List of hotkey descriptors for GerbView.
extern struct EDA_HOTKEY_CONFIG s_Gerbview_Hokeys_Descr[];
#endif // KOTKEYS_H
diff --git a/gerbview/menubar.cpp b/gerbview/menubar.cpp
index 16ac2024f5..0d84e95bd6 100644
--- a/gerbview/menubar.cpp
+++ b/gerbview/menubar.cpp
@@ -10,9 +10,7 @@
#include "gerbview_id.h"
#include "hotkeys.h"
-/**
- * @brief (Re)Create the menubar for the gerbview frame
- */
+
void GERBVIEW_FRAME::ReCreateMenuBar( void )
{
// Create and try to get the current menubar
@@ -98,11 +96,11 @@ void GERBVIEW_FRAME::ReCreateMenuBar( void )
// Separator
fileMenu->AppendSeparator();
- // Export to pcbnew
+ // Export to Pcbnew
AddMenuItem( fileMenu,
ID_GERBVIEW_EXPORT_TO_PCBNEW,
_( "Export to &Pcbnew" ),
- _( "Export data in pcbnew format" ),
+ _( "Export data in Pcbnew format" ),
KiBitmap( export_xpm ) );
// Separator
@@ -204,11 +202,11 @@ void GERBVIEW_FRAME::ReCreateMenuBar( void )
_( "Open the Gerbview handbook" ),
KiBitmap( help_xpm ) );
- // About gerbview
+ // About GerbView
AddMenuItem( helpMenu,
wxID_ABOUT,
_( "&About GerbView" ),
- _( "About gerbview gerber and drill viewer" ),
+ _( "About GerbView gerber and drill viewer" ),
KiBitmap( online_help_xpm ) );
// Append menus to the menubar
diff --git a/gerbview/options.cpp b/gerbview/options.cpp
index dfe556947d..81ff43a3f9 100644
--- a/gerbview/options.cpp
+++ b/gerbview/options.cpp
@@ -1,9 +1,6 @@
-/************************/
-/* File options.cpp */
-/************************/
-
-/*
- * Set some general options of Gerbview
+/**
+ * @file options.cpp
+ * @brief Set some general options of GerbView.
*/
diff --git a/gerbview/readgerb.cpp b/gerbview/readgerb.cpp
index 6e41d33d28..c1f9cb7c03 100644
--- a/gerbview/readgerb.cpp
+++ b/gerbview/readgerb.cpp
@@ -18,13 +18,13 @@ bool GERBVIEW_FRAME::Read_GERBER_File( const wxString& GERBER_FullFileName,
const wxString& D_Code_FullFileName )
{
int G_command = 0; // command number for G commands like G04
- int D_commande = 0; // command number for D commands like D02
+ int D_commande = 0; // command number for D commands like D02
char line[GERBER_BUFZ];
wxString msg;
char* text;
- int layer; /* current layer used in gerbview */
+ int layer; /* current layer used in GerbView */
layer = getActiveLayer();
diff --git a/gerbview/rs274d.cpp b/gerbview/rs274d.cpp
index 5c6c700d90..81f26e6f39 100644
--- a/gerbview/rs274d.cpp
+++ b/gerbview/rs274d.cpp
@@ -35,7 +35,7 @@
* see rs274xrevd_e.pdf pages 47 and 48
* Unfortunately page 47 said G74 disable G02 or G03
* and page 48 said G01 must be used to disable G02 or G03.
- * Currently Gerbview disable G02 or G03 after a G74 command (tests using 2 gerber files).
+ * Currently GerbView disable G02 or G03 after a G74 command (tests using 2 gerber files).
* G75 enable 360 degrees circular interpolation
* G90 mode absolute coordinates
*
diff --git a/gerbview/rs274x.cpp b/gerbview/rs274x.cpp
index 7d51996103..5be2448276 100644
--- a/gerbview/rs274x.cpp
+++ b/gerbview/rs274x.cpp
@@ -24,7 +24,7 @@ extern double ReadDouble( char*& text, bool aSkipSeparator = true );
// Also:
// Image is what you must plot (the entire data of the file).
// Layer is just a set of data blocks with their parameters. An image can have more than one
-// layer so a gerber layer is not like a board layer or the graphic layers used in Gerbview
+// layer so a gerber layer is not like a board layer or the graphic layers used in GerbView
// to show a file.
enum RS274X_PARAMETERS {
// Directive parameters: single usage recommended
@@ -454,7 +454,7 @@ bool GERBER_IMAGE::ExecuteRS274XCommand( int command,
case KNOCKOUT:
m_Iterpolation = GERB_INTERPOL_LINEAR_1X; // Start a new Gerber layer
- msg = _( "RS274X: Command KNOCKOUT ignored by Gerbview" ) ;
+ msg = _( "RS274X: Command KNOCKOUT ignored by GerbView" ) ;
ReportMessage( msg );
break;
diff --git a/gerbview/select_layers_to_pcb.cpp b/gerbview/select_layers_to_pcb.cpp
index 1805404372..805974b94c 100644
--- a/gerbview/select_layers_to_pcb.cpp
+++ b/gerbview/select_layers_to_pcb.cpp
@@ -137,16 +137,16 @@ void LAYERS_MAP_DIALOG::initDialog()
{
// Each Gerber layer has an associated static text string (to
// identify that layer), a button (for invoking a child dialog
- // box to change which pcbnew layer that the Gerber layer is
+ // box to change which Pcbnew layer that the Gerber layer is
// mapped to), and a second static text string (to depict which
- // pcbnew layer that the Gerber layer has been mapped to). Each
+ // Pcbnew layer that the Gerber layer has been mapped to). Each
// of those items are placed into the left hand column, middle
// column, and right hand column (respectively) of the Flexgrid
// sizer, and the color of the second text string is set to
// fuchsia or blue (to respectively indicate whether the Gerber
- // layer has been mapped to a pcbnew layer or is not being
+ // layer has been mapped to a Pcbnew layer or is not being
// exported at all). (Experimentation has shown that if a text
- // control is used to depict which pcbnew layer that each Gerber
+ // control is used to depict which Pcbnew layer that each Gerber
// layer is mapped to (instead of a static text string), then
// those controls do not behave in a fully satisfactory manner
// in the Linux version. Even when the read-only attribute is
@@ -188,9 +188,9 @@ void LAYERS_MAP_DIALOG::initDialog()
flexColumnBoxSizer->Add( Button, 0,
wxALIGN_LEFT | wxALIGN_CENTER_VERTICAL );
- // Provide another text string to specify which pcbnew layer that this
+ // Provide another text string to specify which Pcbnew layer that this
// Gerber layer is initially mapped to, and set the initial text to
- // specify the appropriate pcbnew layer, and set the foreground color
+ // specify the appropriate Pcbnew layer, and set the foreground color
// of the text to fuchsia (to indicate that the layer is being exported).
item_ID = ID_TEXT_0 + ii;
@@ -199,7 +199,7 @@ void LAYERS_MAP_DIALOG::initDialog()
// without it being truncated. Then specify that size as the minimum
// size for all of these text strings. (If this minimum size is not
// determined in this fashion, then it is possible for the display of
- // one or more of these strings to be truncated after different pcbnew
+ // one or more of these strings to be truncated after different Pcbnew
// layers are selected.)
if( ii == 0 )
{
diff --git a/gerbview/toolbars_gerber.cpp b/gerbview/toolbars_gerber.cpp
index 8f61722b41..49e153a6d1 100644
--- a/gerbview/toolbars_gerber.cpp
+++ b/gerbview/toolbars_gerber.cpp
@@ -161,7 +161,7 @@ void GERBVIEW_FRAME::ReCreateOptToolbar( void )
KiBitmap( show_dcodenumber_xpm ),
_( "Show dcode number" ), wxITEM_CHECK );
- // tools to select draw mode in gerbview
+ // tools to select draw mode in GerbView
m_OptionsToolBar->AddSeparator();
m_OptionsToolBar->AddTool( ID_TB_OPTIONS_SHOW_GBR_MODE_0, wxEmptyString,
KiBitmap( gbr_select_mode0_xpm ),
diff --git a/include/appl_wxstruct.h b/include/appl_wxstruct.h
index 8f8ebdd0c8..348a7b0bba 100644
--- a/include/appl_wxstruct.h
+++ b/include/appl_wxstruct.h
@@ -1,6 +1,6 @@
/**
* @file appl_wxstruct.h
- * @brief Base class implementation for all Kicad applications.
+ * @brief Base class implementation for all KiCad applications.
*/
#ifndef APPL_WXSTRUCT_H
@@ -30,7 +30,7 @@ class wxHtmlHelpController;
/**
* Class EDA_APP
- * is the base class representing all of Kicad applications.
+ * is the base class representing all of KiCad applications.
*/
class EDA_APP : public wxApp
{
@@ -51,7 +51,7 @@ public:
wxString m_CurrentOptionFile;
wxString m_CurrentOptionFileDateAndTime;
- wxString m_BinDir; /* Kicad executable path.*/
+ wxString m_BinDir; /* KiCad executable path.*/
wxString m_KicadEnv; /* environment variable KICAD */
bool m_Env_Defined; // TRUE if environment KICAD is defined.
@@ -138,9 +138,9 @@ public: EDA_APP();
/**
* Function SetLanguageIdentifier
* sets in .m_LanguageId member the wxWidgets language identifier Id from
- * the kicad menu id (internal menu identifier).
+ * the KiCad menu id (internal menu identifier).
*
- * @param menu_id The kicad menuitem id (returned by Menu Event, when
+ * @param menu_id The KiCad menuitem id (returned by Menu Event, when
* clicking on a menu item)
*/
void SetLanguageIdentifier( int menu_id );
@@ -149,7 +149,7 @@ public: EDA_APP();
/**
* Function InitOnLineHelp
- * initializes Kicad's online help.
+ * initializes KiCad's online help.
*/
void InitOnLineHelp();
@@ -224,7 +224,7 @@ public: EDA_APP();
bool Load_Only_if_New );
/**
- * Creates or recreates the kicad project file. (filename.pro)
+ * Creates or recreates the KiCad project file. (filename.pro)
* Initialize:
* G_Prj_Config
* G_Prj_Config_LocalFilename
@@ -251,7 +251,7 @@ public: EDA_APP();
* Function GetHelpFile
* get the help file path.
* <p>
- * Return the Kicad help file with path. The base paths defined in
+ * Return the KiCad help file with path. The base paths defined in
* m_searchPaths are tested for a valid file. The path returned can
* be relative depending on the paths added to m_searchPaths. See the
* documentation for wxPathList for more information. If the help file
@@ -281,7 +281,7 @@ public: EDA_APP();
/**
* Function FindLibraryPath
- * Kicad saves user defined library files that are not in the standard
+ * KiCad saves user defined library files that are not in the standard
* library search path list with the full file path. Calling the library
* search path list with a user library file will fail. This helper method
* solves that problem.
diff --git a/include/base_struct.h b/include/base_struct.h
index 276b842f70..c44536151e 100644
--- a/include/base_struct.h
+++ b/include/base_struct.h
@@ -1,6 +1,6 @@
/**
* @file base_struct.h
- * @brief Basic classes for most kicad items.
+ * @brief Basic classes for most KiCad items.
*/
#ifndef BASE_STRUCT_H
@@ -48,7 +48,7 @@ enum KICAD_T {
TYPE_BOARD_ITEM_LIST, // a list of board items
// Schematic draw Items. The order of these items effects the sort order.
- // It is currenlty ordered to mimic the old EESchema locate behavior where
+ // It is currenlty ordered to mimic the old Eeschema locate behavior where
// the smallest item is the selected item.
SCH_MARKER_T,
SCH_JUNCTION_T,
@@ -95,7 +95,7 @@ enum KICAD_T {
LIB_FIELD_T,
/*
- * For Gerbview: items type:
+ * For GerbView: items type:
*/
TYPE_GERBER_DRAW_ITEM,
@@ -151,8 +151,8 @@ public:
* Class 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)
- * and also kicad needs some specific method.
+ * and are working only if dimensions are >= 0 (not always the case in KiCad)
+ * and also KiCad needs some specific method.
* so I prefer this more suitable class
*/
class EDA_RECT
@@ -296,7 +296,7 @@ class DHEAD;
/**
* Class EDA_ITEM
- * is a base class for most all the kicad significant classes, used in
+ * is a base class for most all the KiCad significant classes, used in
* schematics and boards.
*/
diff --git a/include/class_bitmap_base.h b/include/class_bitmap_base.h
index 8a53674154..725dbab522 100644
--- a/include/class_bitmap_base.h
+++ b/include/class_bitmap_base.h
@@ -4,10 +4,10 @@
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2011 jean-pierre.charras
- * Copyright (C) 2011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -34,7 +34,7 @@
#include "sch_item_struct.h"
/**
- * This class handle bitmap images in kicad.
+ * This class handle bitmap images in KiCad.
* It is not intended to be used alone, but inside an other class,
* so all methods are protected ( or private )
* It is used in SCH_BITMAP class (and other in futute)
@@ -52,7 +52,7 @@ private:
wxBitmap* m_bitmap; // the bitmap used to draw/plot image
double m_pixelScaleFactor; // The scaling factor of the bitmap
// to convert the bitmap size (in pixels)
- // to internal Kicad units
+ // to internal KiCad units
// Usually does not change
diff --git a/include/class_board_design_settings.h b/include/class_board_design_settings.h
index 20801aedc2..af7b255f73 100644
--- a/include/class_board_design_settings.h
+++ b/include/class_board_design_settings.h
@@ -71,7 +71,7 @@ public:
*/
bool IsLayerVisible( int aLayerIndex ) const
{
- // @@IMB: Altough Pcbnew uses only 29, Gerbview uses all 32 layers
+ // @@IMB: Altough Pcbnew uses only 29, GerbView uses all 32 layers
if( aLayerIndex < 0 || aLayerIndex >= 32 )
return false;
diff --git a/include/class_board_item.h b/include/class_board_item.h
index bba089fe91..ba45fc1360 100644
--- a/include/class_board_item.h
+++ b/include/class_board_item.h
@@ -32,8 +32,8 @@ enum Track_Shapes {
* Class 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.
- * The corresponding class in EESCHEMA is SCH_ITEM.
+ * found in Pcbnew or other programs that use class BOARD and its contents.
+ * The corresponding class in Eeschema is SCH_ITEM.
*/
class BOARD_ITEM : public EDA_ITEM
{
diff --git a/include/class_collector.h b/include/class_collector.h
index f74d341aa5..bffaf089c9 100644
--- a/include/class_collector.h
+++ b/include/class_collector.h
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2008 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2004-2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2004-2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/include/class_colors_design_settings.h b/include/class_colors_design_settings.h
index 6c31cd24ad..86bc5f5f6e 100644
--- a/include/class_colors_design_settings.h
+++ b/include/class_colors_design_settings.h
@@ -1,7 +1,7 @@
-/****************************************************/
-/* class_colors_design_settings.h */
-/* handle colors used to draw all items or layers */
-/****************************************************/
+/**
+ * @file class_colors_design_settings.h
+ * @brief Handle colors used to draw all items or layers.
+ */
#ifndef _COLORS_DESIGN_SETTING_H
#define _COLORS_DESIGN_SETTING_H
@@ -9,15 +9,14 @@
#define LAYERSCOLORSBUFFERSIZE 32
#define ITEMSCOLORSBUFFERSIZE 32
-/* Class for handle list of color settings for designs
-* in Eeschema, Pcbnew and gerbview
-*/
+/* Class for handle list of color settings for designs in Eeschema, Pcbnew and GerbView
+ */
class COLORS_DESIGN_SETTINGS
{
public:
// Color options for screen display of the Printed Board and schematic:
- // Common to Eeschema, Pcbnew, Gerbview
+ // Common to Eeschema, Pcbnew, GerbView
int m_LayersColors[LAYERSCOLORSBUFFERSIZE]; ///< Layer colors (tracks and graphic items)
// Common to Eeschema, Pcbnew
diff --git a/include/class_drawpanel.h b/include/class_drawpanel.h
index 8bfea41f82..a7d666f67a 100644
--- a/include/class_drawpanel.h
+++ b/include/class_drawpanel.h
@@ -105,7 +105,7 @@ public:
/**
* Function DrawAuxiliaryAxis
- * Draw the Auxiliary Axis, used in pcbnew which as origin coordinates
+ * Draw the Auxiliary Axis, used in Pcbnew which as origin coordinates
* for gerber and excellon files
* @param aDC = current Device Context
* @param aDrawMode = draw mode (GR_COPY, GR_OR ..)
@@ -114,7 +114,7 @@ public:
/**
* Function DrawGridAxis
- * Draw on auxiliary axis, used in pcbnew to show grid origin, when
+ * Draw on auxiliary axis, used in Pcbnew to show grid origin, when
* the grid origin is set by user, and is not (0,0)
* @param aDC = current Device Context
* @param aDrawMode = draw mode (GR_COPY, GR_OR ..)
diff --git a/include/class_drc_item.h b/include/class_drc_item.h
index 587be67b9a..3fb45c3afc 100644
--- a/include/class_drc_item.h
+++ b/include/class_drc_item.h
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007 Dick Hollenbeck, dick@softplc.com
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/include/class_sch_screen.h b/include/class_sch_screen.h
index 21f2db2dc5..62347d0ef6 100644
--- a/include/class_sch_screen.h
+++ b/include/class_sch_screen.h
@@ -1,6 +1,7 @@
-/********************************************/
-/* Definitions for the EESchema program: */
-/********************************************/
+/**
+ * @file class_sch_screen.h
+ * @brief Definitions for the Eeschema program SCH_SCREEN class.
+ */
#ifndef CLASS_SCREEN_H
#define CLASS_SCREEN_H
diff --git a/include/class_undoredo_container.h b/include/class_undoredo_container.h
index 044311ce8e..0711218dc2 100644
--- a/include/class_undoredo_container.h
+++ b/include/class_undoredo_container.h
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009 jean-pierre.charras@gipsa-lab.inpg.fr
* Copyright (C) 2011 Wayne Stambaugh <stambaughw@verizon.net>
- * Copyright (C) 2009 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2009 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -39,7 +39,7 @@ class PICKED_ITEMS_LIST;
* New item
* Deleted item
* Modified item
- * there is also a specific case in eeschema, when wires are modified
+ * there is also a specific case in Eeschema, when wires are modified
* If an item is modified, a copy of the "old" item parameters value is held.
* When an item is deleted or added (new item) the pointer points the item, and there is
* no other copy.
@@ -68,7 +68,7 @@ enum UNDO_REDO_T {
UR_ROTATED, // Rotated item (counterclockwise), undo by rotating it
UR_ROTATED_CLOCKWISE, // Rotated item (clockwise), undo by rotating it
UR_FLIPPED, // flipped (board items only), undo by flipping it
- UR_WIRE_IMAGE, // Specific to eeschema: handle wires changes
+ UR_WIRE_IMAGE, // Specific to Eeschema for handling wires changes.
UR_MODEDIT, // Specific to the module editor (modedit creates a full copy of
// the current module when changed)
UR_LIBEDIT, // Specific to the component editor (libedit creates a full copy
diff --git a/include/colors.h b/include/colors.h
index e1dfc5e99c..e413053c6f 100644
--- a/include/colors.h
+++ b/include/colors.h
@@ -88,12 +88,12 @@ extern StructColors ColorRefs[NBCOLOR];
/**
* Function MakeColour
- * returns a wxWidgets wxColor from a KICAD color index with alpha value.
+ * returns a wxWidgets wxColor from a KiCad color index with alpha value.
* Note that alpha support is not available on every wxWidgets platform. On
* such platform the behavior is the same as for wxALPHA_OPAQUE and that
* means the alpha value has no effect and will be ignored. wxGtk 2.8.4 is
* not supporting alpha.
- * @return wxColour - given a KICAD color index with alpha value
+ * @return wxColour - given a KiCad color index with alpha value
*/
static inline wxColour MakeColour( int aColor )
{
diff --git a/include/common.h b/include/common.h
index 46e011a98b..69e9c8a058 100644
--- a/include/common.h
+++ b/include/common.h
@@ -175,7 +175,7 @@ extern int g_GhostColor;
/**
* Function SetLocaleTo_C_standard
- * because kicad is internationalized, switch internalization to "C" standard
+ * because KiCad is internationalized, switch internalization to "C" standard
* i.e. uses the . (dot) as separator in print/read float numbers
* (some countries (France, Germany ..) use , (comma) as separator)
* This function must be called before read or write ascii files using float
@@ -183,20 +183,20 @@ extern int g_GhostColor;
* reading or writing the file
*
* This is wrapper to the C setlocale( LC_NUMERIC, "C" ) function,
- * but could make more easier an optional use of locale in kicad
+ * but could make more easier an optional use of locale in KiCad
*/
void SetLocaleTo_C_standard( void );
/**
* Function SetLocaleTo_Default
- * because kicad is internationalized, switch internalization to default
+ * because KiCad is internationalized, switch internalization to default
* to use the default separator in print/read float numbers
* (. (dot) but some countries (France, Germany ..) use , (comma) as
* separator)
* This function must be called after a call to SetLocaleTo_C_standard
*
* This is wrapper to the C setlocale( LC_NUMERIC, "" ) function,
- * but could make more easier an optional use of locale in kicad
+ * but could make more easier an optional use of locale in KiCad
*/
void SetLocaleTo_Default( void );
diff --git a/include/eda_dde.h b/include/eda_dde.h
index 4cac87f58b..fbde3b56a7 100644
--- a/include/eda_dde.h
+++ b/include/eda_dde.h
@@ -1,30 +1,37 @@
-/////////////////////////////////////////////////////////////////////////////
-// Name: eda_dde.h
-// Purpose: DDE server & client
-/////////////////////////////////////////////////////////////////////////////
+/**
+ * @file eda_dde.h
+ * @brief DDE server & client.
+ */
-#define wxServer wxSocketServer
-#define wxClient wxSocketClient
+#ifndef _EDA_DDE_H_
+#define _EDA_DDE_H_
#include <wx/socket.h>
+#define wxServer wxSocketServer
+#define wxClient wxSocketClient
#define WinEDA_Server wxSocketServer
-// TCP/IP ports used by PCBNEW and EESCHEMA respectively.
-#define KICAD_PCB_PORT_SERVICE_NUMBER 4242 ///< PCBNEW listens on this port for commands from EESCHEMA
-#define KICAD_SCH_PORT_SERVICE_NUMBER 4243 ///< EESCHEMA listens on this port for commands from PCBNEW
+// TCP/IP ports used by Pcbnew and Eeschema respectively.
+
+///< Pcbnew listens on this port for commands from Eeschema
+#define KICAD_PCB_PORT_SERVICE_NUMBER 4242
+
+///< Eeschema listens on this port for commands from Pcbnew
+#define KICAD_SCH_PORT_SERVICE_NUMBER 4243
#define MSG_TO_PCB KICAD_PCB_PORT_SERVICE_NUMBER
#define MSG_TO_SCH KICAD_SCH_PORT_SERVICE_NUMBER
- /********************/
- /* autres fonctions */
- /********************/
+/********************/
+/* autres fonctions */
+/********************/
WinEDA_Server * CreateServer( wxWindow * window, int port );
bool SendCommand( int port, const char* cmdline );
void SetupServerFunction( void (*remotefct) (const char* remotecmd) );
+#endif // _EDA_DDE_H_
diff --git a/include/filter_reader.h b/include/filter_reader.h
index f5de1f966e..a3d980d1d3 100644
--- a/include/filter_reader.h
+++ b/include/filter_reader.h
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/include/gestfich.h b/include/gestfich.h
index fcff27b3b4..f3c328410d 100644
--- a/include/gestfich.h
+++ b/include/gestfich.h
@@ -45,7 +45,7 @@ wxString EDA_FileSelector( const wxString& Title,
/* Return file name without path or extension.
*
- * If the path is in the default kicad path, ./ is prepended to the
+ * If the path is in the default KiCad path, ./ is prepended to the
* file name. If the file name has the default extension, the file
* name is returned without an extension.
*/
@@ -65,11 +65,11 @@ void AddDelimiterString( wxString& string );
wxString FindKicadHelpPath();
-/* Return the kicad common data path. */
+/* Return the KiCad common data path. */
wxString ReturnKicadDatasPath();
-/* Search the executable file shortname in kicad binary path and return
+/* Search the executable file shortname in KiCad binary path and return
* full file name if found or shortname */
wxString FindKicadFile( const wxString& shortname );
diff --git a/include/hotkeys_basic.h b/include/hotkeys_basic.h
index 5985ba9c18..3698429006 100644
--- a/include/hotkeys_basic.h
+++ b/include/hotkeys_basic.h
@@ -1,8 +1,6 @@
/**
* @file hotkeys_basic.h
- */
-
-/* Some functions to handle hotkeys in kicad
+ * @brief Some functions to handle hotkeys in KiCad
*/
#ifndef HOTKEYS_BASIC_H
diff --git a/include/id.h b/include/id.h
index d089838cc9..1887e3ce48 100644
--- a/include/id.h
+++ b/include/id.h
@@ -5,7 +5,7 @@
#define MAX_ITEMS_IN_PICKER 15 ///< max no. items in the popup menu for item selection
/**
- * Common command IDs shared by more than one of the kicad applications.
+ * Common command IDs shared by more than one of the KiCad applications.
*
* Only place command IDs used in base window class event tables or shared
* across multple applications such as the zoom, grid, and language IDs.
@@ -196,7 +196,7 @@ enum main_id
ID_EDA_SOCKET_EVENT_SERV,
ID_EDA_SOCKET_EVENT,
- /* Command IDs common to PCBNew and cvpcb. */
+ /* Command IDs common to Pcbnew and CvPcb. */
ID_PCB_DISPLAY_FOOTPRINT_DOC,
// Common to all
@@ -206,7 +206,7 @@ enum main_id
ID_TB_OPTIONS_SHOW_POLAR_COORD,
ID_TB_OPTIONS_SHOW_GRID,
- // Common to pcbnew, cvpcb
+ // Common to Pcbnew and CvPcb
ID_TB_OPTIONS_SHOW_MODULE_TEXT_SKETCH,
ID_TB_OPTIONS_SHOW_MODULE_EDGE_SKETCH,
ID_TB_OPTIONS_SHOW_PADS_SKETCH,
diff --git a/include/kicad_device_context.h b/include/kicad_device_context.h
index 82caee0b51..72f9662903 100644
--- a/include/kicad_device_context.h
+++ b/include/kicad_device_context.h
@@ -1,10 +1,10 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009 jean-pierre.charras@gipsa-lab.inpg.fr
* Copyright (C) 2011 Wayne Stambaugh <stambaughw@verizon.net>
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -25,7 +25,7 @@
*/
/**
- * a helper to handle the real device context used in kicad
+ * a helper to handle the real device context used in KiCad
* @file kicad_device_context.h
*/
@@ -139,7 +139,7 @@ private:
#include <wx/dcgraph.h>
#endif
-// Macro used to declare a device context in kicad:
+// Macro used to declare a device context in KiCad:
#if USE_WX_GRAPHICS_CONTEXT
//#pragma message( "INSTALL_DC is wxClientDC with wxGCDC" )
#define INSTALL_DC( name, parent ) \
diff --git a/include/kicad_msvc.h b/include/kicad_msvc.h
index 5d01947834..8dbfc1fba7 100644
--- a/include/kicad_msvc.h
+++ b/include/kicad_msvc.h
@@ -1,6 +1,7 @@
-/******************************************************************/
-/* kicad_msvc.h : used to compile kicad with Microsoft Visual C++ */
-/******************************************************************/
+/**
+ * @file kicad_msvc.h
+ * @brief Code used to compile KiCad with Microsoft Visual C++
+ */
// __MSVC__ must be defined
diff --git a/include/layers_id_colors_and_visibility.h b/include/layers_id_colors_and_visibility.h
index 6abd2614f2..ca35fcf0bd 100644
--- a/include/layers_id_colors_and_visibility.h
+++ b/include/layers_id_colors_and_visibility.h
@@ -1,6 +1,7 @@
-/**************************************************************/
-/* pcbstruct.h : some classes and definitions used in pcbnew */
-/**************************************************************/
+/**
+ * @file layers_id_colors_and_visibility.h
+ * @brief Classes and definitions used in Pcbnew.
+ */
#ifndef _LAYERS_ID_AND_VISIBILITY_H_
#define _LAYERS_ID_AND_VISIBILITY_H_
diff --git a/include/newstroke_font.h b/include/newstroke_font.h
index ef0739138f..0778e285b3 100644
--- a/include/newstroke_font.h
+++ b/include/newstroke_font.h
@@ -1,10 +1,10 @@
/*
* newstroke_font.h - header for automatically converted font
*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2010 vladimir uryvaev <vovanius@bk.ru>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/include/online_help.h b/include/online_help.h
index 97aab04fc7..94ac63171b 100644
--- a/include/online_help.h
+++ b/include/online_help.h
@@ -1,12 +1,13 @@
-/******************************************************/
-/* definitions relatives to the online help for kicad */
-/******************************************************/
+/**
+ * @file online_help.h
+ * @brief Definitions for online help for KiCad.
+ */
#ifndef ONLINE_HELP_H
#define ONLINE_HELP_H
/*
- * Kicad uses HTML or PDF file format in the online help (help command)
+ * KiCad uses HTML or PDF file format in the online help (help command)
* Comment one of these 2 lines
*/
diff --git a/include/pcbstruct.h b/include/pcbstruct.h
index d8f23b4941..6bd0bc1c5d 100644
--- a/include/pcbstruct.h
+++ b/include/pcbstruct.h
@@ -1,6 +1,6 @@
/**
* @file pcbstruct.h
- * @brief Classes and definitions used in pcbnew.
+ * @brief Classes and definitions used in Pcbnew.
*/
#ifndef PCBSTRUCT_H
diff --git a/include/richio.h b/include/richio.h
index 7d648b5ef8..edb479644d 100644
--- a/include/richio.h
+++ b/include/richio.h
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/include/sch_item_struct.h b/include/sch_item_struct.h
index c744c57ad8..f8212b54a4 100644
--- a/include/sch_item_struct.h
+++ b/include/sch_item_struct.h
@@ -67,7 +67,7 @@ public:
* 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.
- * The corresponding class in PCBNEW is BOARD_ITEM.
+ * The corresponding class in Pcbnew is BOARD_ITEM.
*/
class SCH_ITEM : public EDA_ITEM
{
@@ -175,7 +175,7 @@ public:
* SCH_ITEM do not have any text to search.
*
* @todo - This should probably be pushed down to EDA_ITEM so that
- * searches can be done on all of the Kicad applications that use
+ * searches can be done on all of the KiCad applications that use
* objects derived from EDA_ITEM.
*
* @param aSearchData - The search criteria.
diff --git a/include/wxBasePcbFrame.h b/include/wxBasePcbFrame.h
index a2ae1403e5..5ba9ea69e0 100644
--- a/include/wxBasePcbFrame.h
+++ b/include/wxBasePcbFrame.h
@@ -1,6 +1,6 @@
/**
* @file wxBasePcbFrame.h
- * @brief Classes used in pcbnew, cvpcb and gerbview.
+ * @brief Classes used in Pcbnew, CvPcb and GerbView.
*/
#ifndef WX_BASE_PCB_FRAME_H
@@ -33,7 +33,7 @@ class GENERAL_COLLECTORS_GUIDE;
/**
* class PCB_BASE_FRAME
- * basic PCB main window class for PCBNew, Gerbview, and CvPcb footprint viewer.
+ * basic PCB main window class for Pcbnew, Gerbview, and CvPcb footprint viewer.
*/
class PCB_BASE_FRAME : public EDA_DRAW_FRAME
{
@@ -79,7 +79,7 @@ public:
BOARD* GetBoard()
{
- wxASSERT( m_Pcb ); // phasing out m_Pcb for gerbview
+ wxASSERT( m_Pcb ); // phasing out m_Pcb for GerbView
return m_Pcb;
}
@@ -418,7 +418,7 @@ public:
* create one output files one per board layer in the RS274X format.
* <p>
* The units are in inches and in the format 3.4 with the leading zeros omitted.
- * Coordinates are absolute value. The 3.4 format is used because the native PCBNew
+ * Coordinates are absolute value. The 3.4 format is used because the native Pcbnew
* units are 1/10000 inch.
* </p>
*/
diff --git a/include/wxEeschemaStruct.h b/include/wxEeschemaStruct.h
index 945203ac4d..11fb9851cc 100644
--- a/include/wxEeschemaStruct.h
+++ b/include/wxEeschemaStruct.h
@@ -73,7 +73,7 @@ enum ANNOTATE_OPTION_T {
/**
- * Schematic editor (EESchema) main window.
+ * Schematic editor (Eeschema) main window.
*/
class SCH_EDIT_FRAME : public EDA_DRAW_FRAME
{
@@ -145,10 +145,10 @@ public:
/**
* Function GetProjectFileParameters
- * returns the project file parameter list for EESchema.
+ * returns the project file parameter list for Eeschema.
*
*<p?
- * Populate the project file parameter array specific to EESchema if it hasn't
+ * Populate the project file parameter array specific to Eeschema if it hasn't
* already been populated and return a reference to the array to the caller.
* Creating the parameter list at run time has the advantage of being able to
* define local variables. The old method of statically building the array at
@@ -165,7 +165,7 @@ public:
/**
* Function LoadProjectFile
- * soads the Kicad project file (*.pro) settings specific to EESchema.
+ * soads the KiCad project file (*.pro) settings specific to Eeschema.
*
* @param aFileName The project file name to load.
* @param aForceReread Force the project file to be reread if true.
@@ -234,7 +234,7 @@ public:
* the application settings mixed together. This was confusing and caused some settings
* to get saved and loaded incorrectly. Currently, only the settings that are needed at
* start up by the main window are defined here. There are other locally used settings
- * scattered throughout the EESchema source code. If you need to define a configuration
+ * scattered throughout the Eeschema source code. If you need to define a configuration
* setting that need to be loaded at run time, this is the place to define it.
* </p>
*/
@@ -282,7 +282,7 @@ public:
* <p>
* The search is first performed at the nearest grid position to \a aPosition. If no
* item if found on grid, then \a aPosition is tested for any items. If the item found
- * can be cross probed, a message is send to PCBNew and the selected item is highlighted
+ * can be cross probed, a message is send to Pcbnew and the selected item is highlighted
* in PCB editor.
* </p>
* @param aPosition The wxPoint on the schematic to search.
@@ -332,7 +332,7 @@ public:
const wxString& text_to_find,
bool mouseWarp );
- /* Cross probing with pcbnew */
+ /* Cross probing with Pcbnew */
void SendMessageToPCBNEW( EDA_ITEM* objectToSync, SCH_COMPONENT* LibItem );
/* netlist generation */
@@ -533,7 +533,7 @@ public:
* Function ProcessStuffFile
* gets footprint info from each line in the Stuff File by Ref Desg
*
- * Read a "stuff" file created by cvpcb.
+ * Read a "stuff" file created by CvPcb.
* That file has lines like:
* comp = "C1" module = "CP6"
* comp = "C2" module = "C1"
diff --git a/include/wxPcbStruct.h b/include/wxPcbStruct.h
index 28a00f8263..089ae7a9a6 100644
--- a/include/wxPcbStruct.h
+++ b/include/wxPcbStruct.h
@@ -43,9 +43,9 @@ class BOARD_ITEM;
/**
* class PCB_EDIT_FRAME
- * the main frame for PCBNew
+ * the main frame for Pcbnew
*
- * See also class PCB_BASE_FRAME(): Basic class for PCBNew and Gerbview.
+ * See also class PCB_BASE_FRAME(): Basic class for Pcbnew and GerbView.
*/
class PCB_EDIT_FRAME : public PCB_BASE_FRAME
{
@@ -66,8 +66,8 @@ protected:
DRC* m_drc; ///< the DRC controller, see drc.cpp
- PARAM_CFG_ARRAY m_projectFileParams; ///< List of PCBNew project file settings.
- PARAM_CFG_ARRAY m_configSettings; ///< List of PCBNew configuration settings.
+ PARAM_CFG_ARRAY m_projectFileParams; ///< List of Pcbnew project file settings.
+ PARAM_CFG_ARRAY m_configSettings; ///< List of Pcbnew configuration settings.
wxString m_lastNetListRead; ///< Last net list read with relative path.
@@ -245,9 +245,9 @@ public:
/**
* Function GetProjectFileParameters
- * returns the project file parameter list for PCBNew.
+ * returns the project file parameter list for Pcbnew.
* <p>
- * Populate the project file parameter array specific to PCBNew if it hasn't
+ * Populate the project file parameter array specific to Pcbnew if it hasn't
* already been populated and return a reference to the array to the caller.
* Creating the parameter list at run time has the advantage of being able
* to define local variables. The old method of statically building the array
@@ -269,14 +269,14 @@ public:
/**
* Function GetConfigurationSettings
- * returns the PCBNew applications settings list.
+ * returns the Pcbnew applications settings list.
*
* This replaces the old statically define list that had the project
* file settings and the application settings mixed together. This
* was confusing and caused some settings to get saved and loaded
* incorrectly. Currently, only the settings that are needed at start
* up by the main window are defined here. There are other locally used
- * settings are scattered throughout the PCBNew source code. If you need
+ * settings are scattered throughout the Pcbnew source code. If you need
* to define a configuration setting that need to be loaded at run time,
* this is the place to define it.
*
@@ -289,24 +289,24 @@ public:
/**
* Function LoadSettings
- * loads applications settings specific to PCBNew.
+ * loads applications settings specific to Pcbnew.
*
* This overrides the base class PCB_BASE_FRAME::LoadSettings() to
* handle settings specific common to the PCB layout application. It
* calls down to the base class to load settings common to all PCB type
- * drawing frames. Please put your application settings for PCBNew here
+ * drawing frames. Please put your application settings for Pcbnew here
* to avoid having application settings loaded all over the place.
*/
virtual void LoadSettings();
/**
* Function SaveSettings
- * saves applications settings common to PCBNew.
+ * saves applications settings common to Pcbnew.
*
* This overrides the base class PCB_BASE_FRAME::SaveSettings() to
* save settings specific to the PCB layout application main window. It
* calls down to the base class to save settings common to all PCB type
- * drawing frames. Please put your application settings for PCBNew here
+ * drawing frames. Please put your application settings for Pcbnew here
* to avoid having application settings saved all over the place.
*/
virtual void SaveSettings();
@@ -654,7 +654,7 @@ public:
/**
* Function LoadOnePcbFile
- * loads a Kicad board (.brd) from \a aFileName.
+ * loads a KiCad board (.brd) from \a aFileName.
*
* @param aFileName - File name including path. If empty, a file dialog will
* be displayed.
@@ -710,7 +710,7 @@ public:
/**
* Function RecreateBOMFileFromBoard
* Recreates a .cmp file from the current loaded board
- * this is the same as created by cvpcb.
+ * this is the same as created by CvPcb.
* can be used if this file is lost
*/
void RecreateCmpFileFromBoard( wxCommandEvent& aEvent );
@@ -1312,8 +1312,7 @@ public:
* Function SendMessageToEESCHEMA
* sends a message to the schematic editor so that it may move its cursor
* to a part with the same reference as the objectToSync
- * @param objectToSync The object whose reference is used to synchronize
- * eeschema.
+ * @param objectToSync The object whose reference is used to synchronize Eeschema.
*/
void SendMessageToEESCHEMA( BOARD_ITEM* objectToSync );
diff --git a/include/wxstruct.h b/include/wxstruct.h
index 0141736e9b..b9cd31cbc2 100644
--- a/include/wxstruct.h
+++ b/include/wxstruct.h
@@ -77,7 +77,7 @@ enum id_toolbar {
/**
* Class EDA_BASE_FRAME
- * is the base frame for deriving all Kicad main window classes. This class is not
+ * is the base frame for deriving all KiCad main window classes. This class is not
* intended to be used directly.
*/
class EDA_BASE_FRAME : public wxFrame
@@ -125,7 +125,7 @@ public:
/**
* Function OnSelectPreferredEditor
- * Open a dialog to select the editor that will used in Kicad
+ * Open a dialog to select the editor that will used in KiCad
* to edit or display files (reports ... )
* The full filename editor is saved in configuration (global params)
*/
@@ -236,8 +236,8 @@ public:
/**
* Class EDA_DRAW_FRAME
- * is the base class for create windows for drawing purpose. The eeschema, pcbnew and
- * gerbview main windows are just a few examples of classes derived from EDA_DRAW_FRAME.
+ * is the base class for create windows for drawing purpose. The Eeschema, Pcbnew and
+ * GerbView main windows are just a few examples of classes derived from EDA_DRAW_FRAME.
*/
class EDA_DRAW_FRAME : public EDA_BASE_FRAME
{
@@ -251,7 +251,7 @@ public:
EDA_TOOLBAR* m_AuxVToolBar; // Auxiliary Vertical (right side)
// Toolbar
EDA_TOOLBAR* m_OptionsToolBar; // Options Toolbar (left side)
- EDA_TOOLBAR* m_AuxiliaryToolBar; // Auxiliary Toolbar used in pcbnew
+ EDA_TOOLBAR* m_AuxiliaryToolBar; // Auxiliary Toolbar used in Pcbnew
wxComboBox* m_SelGridBox; // Choice box to choose the grid size
wxComboBox* m_SelZoomBox; // Choice box to choose the zoom value
@@ -264,8 +264,8 @@ public:
// horizontal toolbar
int m_InternalUnits; // Internal units count in 1 inch
- // = 1000 for eeschema, = 10000
- // for PCBnew and Gerbview
+ // = 1000 for Eeschema, = 10000
+ // for Pcbnew and GerbView
bool m_Draw_Axis; // TRUE to show X and Y axis
bool m_Draw_Grid_Axis; // TRUE to show grid axis.
@@ -273,7 +273,7 @@ public:
bool m_Print_Sheet_Ref; // TRUE to print frame references
bool m_Draw_Auxiliary_Axis; /* TRUE to show auxiliary axis.
- * Used in pcbnew: the auxiliary
+ * Used in Pcbnew: the auxiliary
* axis is the origin of
* coordinates for drill, gerber
* and component position files
@@ -367,7 +367,7 @@ public:
/* These 4 functions provide a basic way to show/hide grid
* and /get/set grid color.
- * These parameters are saved in kicad config for each main frame
+ * These parameters are saved in KiCad config for each main frame
*/
/**
* Function IsGridVisible() , virtual
@@ -580,7 +580,7 @@ public:
*
* @param textUpper - The message upper text.
* @param textLower - The message lower text.
- * @param color - A color ID from the Kicad color list (see colors.h).
+ * @param color - A color ID from the KiCad color list (see colors.h).
* @param pad - Number of spaces to pad between messages (default = 4).
*/
void AppendMsgPanel( const wxString& textUpper, const wxString& textLower,
@@ -717,7 +717,7 @@ public:
*
* @param textUpper - The message upper text.
* @param textLower - The message lower text.
- * @param color - A color ID from the Kicad color list (see colors.h).
+ * @param color - A color ID from the KiCad color list (see colors.h).
* @param pad - Number of spaces to pad between messages (default = 4).
*/
void AppendMessage( const wxString& textUpper, const wxString& textLower,
@@ -729,7 +729,7 @@ public:
/**
* Class EDA_TOOLBAR
- * is the base class for deriving Kicad tool bars.
+ * is the base class for deriving KiCad tool bars.
*/
class EDA_TOOLBAR : public wxAuiToolBar
{
@@ -910,10 +910,10 @@ static inline void AddMenuItem( wxMenu* aMenu,
/**
- * Specialization of the wxAuiPaneInfo class for Kicad panels.
+ * Specialization of the wxAuiPaneInfo class for KiCad panels.
*
* Documentation for wxAui is poor at this time. The following notes spring from errors made in
- * previous kicad implementations:
+ * previous KiCad implementations:
*
* wxAuiPaneInfo.ToolbarPane() and .Defaults() are used to clear and then prepare the objects so
* only use them once at the beginning of configuration..
@@ -938,7 +938,7 @@ public:
/**
* Function HorizontalToolbarPane
- * Change *this to a horizontal toolbar for kicad.
+ * Change *this to a horizontal toolbar for KiCad.
*/
EDA_PANEINFO& HorizontalToolbarPane()
{
@@ -956,7 +956,7 @@ public:
/**
* Function VerticalToolbarPane
- * Change *this to a vertical toolbar for kicad.
+ * Change *this to a vertical toolbar for KiCad.
*/
EDA_PANEINFO& VerticalToolbarPane()
{
@@ -974,7 +974,7 @@ public:
/**
* Function MessageToolbarPane
- * Change *this to a message pane for kicad.
+ * Change *this to a message pane for KiCad.
*
*/
EDA_PANEINFO& MessageToolbarPane()
@@ -990,7 +990,7 @@ public:
/**
* Function LayersToolbarPane
- * Change *this to a layers toolbar for kicad.
+ * Change *this to a layers toolbar for KiCad.
*/
EDA_PANEINFO& LayersToolbarPane()
{
@@ -1000,10 +1000,10 @@ public:
/**
* Function InfoToolbarPane
- * Change *this to a information panel for for kicad.
+ * Change *this to a information panel for for KiCad.
*
* Info panes are used for vertical display of information next to the center pane.
- * Used in cvpcb and libviewer primarily
+ * Used in CvPcb and the library viewer primarily.
*/
EDA_PANEINFO& InfoToolbarPane()
{
diff --git a/include/xnode.h b/include/xnode.h
index 7fd3413e40..828d9a6c1d 100644
--- a/include/xnode.h
+++ b/include/xnode.h
@@ -2,10 +2,10 @@
#define _XATTR_H_
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCAd Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/kicad/class_treeproject_item.cpp b/kicad/class_treeproject_item.cpp
index 29100b70f7..7704a8d300 100644
--- a/kicad/class_treeproject_item.cpp
+++ b/kicad/class_treeproject_item.cpp
@@ -1,8 +1,8 @@
-/*
- * file class_treeproject_item.cpp
+/**
+ * @file class_treeproject_item.cpp
*
* Class TREEPROJECT_ITEM is a derived class from wxTreeItemData that
- * store info about a file or directory shown in the Kicad tree project files
+ * store info about a file or directory shown in the KiCad tree project files
*/
#include "fctsys.h"
diff --git a/kicad/class_treeprojectfiles.cpp b/kicad/class_treeprojectfiles.cpp
index a9e9dfe469..3a6874f7db 100644
--- a/kicad/class_treeprojectfiles.cpp
+++ b/kicad/class_treeprojectfiles.cpp
@@ -1,6 +1,6 @@
-/*
- * file class_treeprojectfiles.cpp
- * this is the wxTreeCtrl that shows a Kicad tree project files
+/**
+ * @file class_treeprojectfiles.cpp
+ * this is the wxTreeCtrl that shows a KiCad tree project files
*/
#include "fctsys.h"
diff --git a/kicad/commandframe.cpp b/kicad/commandframe.cpp
index 4f59cb8506..7d3aa9b185 100644
--- a/kicad/commandframe.cpp
+++ b/kicad/commandframe.cpp
@@ -20,11 +20,11 @@ RIGHT_KM_FRAME::RIGHT_KM_FRAME( KICAD_MANAGER_FRAME* parent ) :
m_ButtonsListPosition.y = m_ButtonSeparation;
m_ButtonLastPosition = m_ButtonsListPosition;
- // Add bitmap buttons to launch Kicad utilities:
+ // Add bitmap buttons to launch KiCad utilities:
CreateCommandToolbar();
m_ButtonsPanelHeight = m_ButtonsListPosition.y + m_bitmapButtons_maxHeigth + 10;
- // Add the wxTextCtrl showaing all messages from Kicad:
+ // Add the wxTextCtrl showaing all messages from KiCad:
m_MessagesBox = new wxTextCtrl( this, wxID_ANY, wxEmptyString,
wxDefaultPosition, wxDefaultSize,
wxTE_MULTILINE | wxSUNKEN_BORDER | wxTE_READONLY );
@@ -63,20 +63,20 @@ END_EVENT_TABLE()
/**
* Function CreateCommandToolbar
- * create the buttons to call eescheman cvpcb, pcbnew and gerbview
+ * create the buttons to call Eeschema CvPcb, Pcbnew and GerbView
*/
void RIGHT_KM_FRAME::CreateCommandToolbar( void )
{
wxBitmapButton* btn;
btn = AddBitmapButton( ID_TO_EESCHEMA, KiBitmap( icon_eeschema_xpm ) );
- btn->SetToolTip( _( "EESchema (Schematic editor)" ) );
+ btn->SetToolTip( _( "Eeschema (Schematic editor)" ) );
btn = AddBitmapButton( ID_TO_CVPCB, KiBitmap( icon_cvpcb_xpm ) );
- btn->SetToolTip( _( "CVpcb (Components to modules)" ) );
+ btn->SetToolTip( _( "CvPcb (Components to modules)" ) );
btn = AddBitmapButton( ID_TO_PCB, KiBitmap( icon_pcbnew_xpm ) );
- btn->SetToolTip( _( "PCBnew (PCB editor)" ) );
+ btn->SetToolTip( _( "Pcbnew (PCB editor)" ) );
btn = AddBitmapButton( ID_TO_GERBVIEW, KiBitmap( icon_gerbview_xpm ) );
btn->SetToolTip( _( "GerbView (Gerber viewer)" ) );
diff --git a/kicad/files-io.cpp b/kicad/files-io.cpp
index 61c221df64..cf16ff2498 100644
--- a/kicad/files-io.cpp
+++ b/kicad/files-io.cpp
@@ -30,7 +30,7 @@ void KICAD_MANAGER_FRAME::OnFileHistory( wxCommandEvent& event )
{
wxString fn;
- fn = GetFileFromHistory( event.GetId(), _( "Kicad project file" ) );
+ fn = GetFileFromHistory( event.GetId(), _( "KiCad project file" ) );
if( fn != wxEmptyString )
{
diff --git a/kicad/kicad.cpp b/kicad/kicad.cpp
index 13ef1dab59..292dd1b0a2 100644
--- a/kicad/kicad.cpp
+++ b/kicad/kicad.cpp
@@ -1,6 +1,6 @@
/**
* @file kicad.cpp
- * @brief Main kicad library manager file
+ * @brief Main KiCad library manager file
*/
#include "fctsys.h"
diff --git a/kicad/kicad.h b/kicad/kicad.h
index c53b4ac650..4090a051c5 100644
--- a/kicad/kicad.h
+++ b/kicad/kicad.h
@@ -23,11 +23,11 @@ class TREE_PROJECT_FRAME;
/**
- * Command IDs for Kicad.
+ * Command IDs for KiCad.
*
* Please add IDs that are unique to Kicad here and not in the global id.h
* file. This will prevent the entire project from being rebuilt when adding
- * new commands to Kicad.
+ * new commands to KiCad.
*/
enum id_kicad_frm {
@@ -56,7 +56,7 @@ enum id_kicad_frm {
/* class KICAD_MANAGER_FRAME
- * This is the main kicad frame
+ * This is the main KiCad frame
*/
class KICAD_MANAGER_FRAME : public EDA_BASE_FRAME
{
@@ -133,7 +133,7 @@ public: KICAD_MANAGER_FRAME( wxWindow* parent, const wxString& title,
/**
* Function LoadSettings
- * loads the Kicad main frame specific configuration settings.
+ * loads the KiCad main frame specific configuration settings.
*
* Don't forget to call this base method from any derived classes or the
* settings will not get loaded.
@@ -142,7 +142,7 @@ public: KICAD_MANAGER_FRAME( wxWindow* parent, const wxString& title,
/**
* Function SaveSettings
- * saves the Kicad main frame specific configuration settings.
+ * saves the KiCad main frame specific configuration settings.
*
* Don't forget to call this base method from any derived classes or the
* settings will not get saved.
@@ -174,7 +174,7 @@ class RIGHT_KM_FRAME : public wxSashLayoutWindow
public:
wxTextCtrl* m_MessagesBox;
private:
- KICAD_MANAGER_FRAME* m_Parent; // a wxTextCtrl to displays messages frm Kicad
+ KICAD_MANAGER_FRAME* m_Parent; // a wxTextCtrl to displays messages frm KiCad
int m_ButtonsPanelHeight;
wxPanel* m_ButtPanel;
int m_ButtonSeparation; // button distance in pixels
diff --git a/kicad/mainframe.cpp b/kicad/mainframe.cpp
index 32097e2f3b..87234bcf76 100644
--- a/kicad/mainframe.cpp
+++ b/kicad/mainframe.cpp
@@ -1,6 +1,7 @@
-/***************************************************************/
-/* mainframe.cpp - KICAD_MANAGER_FRAME is the kicad main frame */
-/***************************************************************/
+/**
+ * @file kicad/mainframe.cpp
+ * @brief KICAD_MANAGER_FRAME is the KiCad main frame.
+ */
#ifdef __GNUG__
#pragma implementation
diff --git a/kicad/menubar.cpp b/kicad/menubar.cpp
index a29de403a2..940facb356 100644
--- a/kicad/menubar.cpp
+++ b/kicad/menubar.cpp
@@ -228,7 +228,7 @@ void KICAD_MANAGER_FRAME::ReCreateMenuBar()
AddMenuItem( helpMenu,
wxID_HELP,
_( "&Contents" ),
- _( "Open the Kicad handbook" ),
+ _( "Open the KiCad handbook" ),
KiBitmap( online_help_xpm ) );
AddMenuItem( helpMenu,
@@ -244,7 +244,7 @@ void KICAD_MANAGER_FRAME::ReCreateMenuBar()
AddMenuItem( helpMenu,
wxID_ABOUT,
_( "&About KiCad" ),
- _( "About kicad project manager" ),
+ _( "About KiCad project manager" ),
KiBitmap( info_xpm ) );
// Create the menubar and append all submenus
diff --git a/kicad/prjconfig.cpp b/kicad/prjconfig.cpp
index 68a5d14c26..e671788b88 100644
--- a/kicad/prjconfig.cpp
+++ b/kicad/prjconfig.cpp
@@ -15,7 +15,7 @@
static const wxString GeneralGroupName( wxT( "/general" ) );
-/* Kicad project file entry names. */
+/* KiCad project file entry names. */
static const wxString SchematicRootNameEntry( wxT( "RootSch" ) );
static const wxString BoardFileNameEntry( wxT( "BoardNm" ) );
@@ -98,7 +98,7 @@ void KICAD_MANAGER_FRAME::OnLoadProject( wxCommandEvent& event )
}
}
- wxLogDebug( wxT( "Loading Kicad project file: " ) + m_ProjectFileName.GetFullPath() );
+ wxLogDebug( wxT( "Loading KiCad project file: " ) + m_ProjectFileName.GetFullPath() );
/* Check if project file exists and if it is not noname.pro */
wxString filename = m_ProjectFileName.GetFullName();
@@ -108,7 +108,7 @@ void KICAD_MANAGER_FRAME::OnLoadProject( wxCommandEvent& event )
if( !m_ProjectFileName.FileExists() && !filename.IsSameAs( nameless_prj ) )
{
- DisplayError( this, _( "Kicad project file <" ) +
+ DisplayError( this, _( "KiCad project file <" ) +
m_ProjectFileName.GetFullPath() + _( "> not found" ) );
return;
}
diff --git a/kicad/tree_project_frame.cpp b/kicad/tree_project_frame.cpp
index d8d97ba4f3..14229f5897 100644
--- a/kicad/tree_project_frame.cpp
+++ b/kicad/tree_project_frame.cpp
@@ -57,7 +57,7 @@ const wxChar* s_AllowedExtensionsToList[] =
/* TODO: Check if these file extension and wildcard definitions are used
- * in any of the other Kicad programs and move them into the common
+ * in any of the other KiCad programs and move them into the common
* library as required. */
/* File extension definitions. */
@@ -118,7 +118,7 @@ TREE_PROJECT_FRAME::TREE_PROJECT_FRAME( KICAD_MANAGER_FRAME* parent ) :
m_Filters.push_back( s_AllowedExtensionsToList[ii] );
}
- m_Filters.push_back( wxT( "^no kicad files found" ) );
+ m_Filters.push_back( wxT( "^no KiCad files found" ) );
for( int i = 0; i < TREE_MAX; i++ )
m_ContextMenus.push_back( new wxMenu() );
@@ -542,7 +542,7 @@ bool TREE_PROJECT_FRAME::AddFile( const wxString& aName,
if( !addFile )
return false;
- // only show the schematic if it is a top level schematic. eeschema
+ // only show the schematic if it is a top level schematic. Eeschema
// cannot open a schematic and display it properly unless it starts
// at the top of the hierarchy. The schematic is top level only if
// there is a line in the header saying:
diff --git a/kicad/tree_project_frame.h b/kicad/tree_project_frame.h
index c1eab4ad5c..dca3f49262 100644
--- a/kicad/tree_project_frame.h
+++ b/kicad/tree_project_frame.h
@@ -1,12 +1,12 @@
-/*
- * file tree_project_frame.h
-*/
+/**
+ * @file tree_project_frame.h
+ */
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2009 Jean-Pierre Charras, jean-pierre.charras@gipsa-lab.inpg.fr
- * Copyright (C) 1992-2009 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2009 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/board_undo_redo.cpp b/pcbnew/board_undo_redo.cpp
index dc07082014..e2e730bc86 100644
--- a/pcbnew/board_undo_redo.cpp
+++ b/pcbnew/board_undo_redo.cpp
@@ -81,9 +81,9 @@ BOARD_ITEM* DuplicateStruct( BOARD_ITEM* aItem );
* This is a function unsed by PutDataInPreviousState to be sure an item was not deleted
* since an undo or redo.
* This could be possible:
- * - if a call to SaveCopyInUndoList was forgotten in pcbnew
+ * - if a call to SaveCopyInUndoList was forgotten in Pcbnew
* - in zones outlines, when a change in one zone merges this zone with an other
- * This function avoids a pcbnew crash
+ * This function avoids a Pcbnew crash
* @param aPcb = board to test
* @param aItem = item to find
*/
diff --git a/pcbnew/class_board.cpp b/pcbnew/class_board.cpp
index cfb2ec277b..d96ed9b3d4 100644
--- a/pcbnew/class_board.cpp
+++ b/pcbnew/class_board.cpp
@@ -20,7 +20,7 @@
#include "class_marker_pcb.h"
-/* This is an odd place for this, but cvpcb won't link if it is
+/* This is an odd place for this, but CvPcb won't link if it is
* in class_board_item.cpp like I first tried it.
*/
wxPoint BOARD_ITEM::ZeroOffset( 0, 0 );
@@ -326,7 +326,7 @@ wxString BOARD::GetDefaultLayerName( int aLayerNumber )
{
const wxChar* txt;
- // These are only default layer names. For PCBNEW, the copper names
+ // These are only default layer names. For Pcbnew the copper names
// may be over-ridden in the BOARD (*.brd) file.
// Use a switch to explicitly show the mapping more clearly
diff --git a/pcbnew/class_board.h b/pcbnew/class_board.h
index 5ae4c2d763..0eba6b2158 100644
--- a/pcbnew/class_board.h
+++ b/pcbnew/class_board.h
@@ -135,7 +135,7 @@ protected:
/**
* Class BOARD
- * holds information pertinent to a PCBNEW printed circuit board.
+ * holds information pertinent to a Pcbnew printed circuit board.
*/
class BOARD : public BOARD_ITEM
{
@@ -990,7 +990,7 @@ public:
* @param aCurrArea = the zone to process
* @param bMessageBoxInt == true, shows message when clipping occurs.
* @param bMessageBoxArc == true, shows message when clipping can't be done due to arcs.
- * @param bRetainArcs = true to handle arcs (not really used in kicad)
+ * @param bRetainArcs = true to handle arcs (not really used in KiCad)
* @return :
* -1 if arcs intersect other sides, so polygon can't be clipped
* 0 if no intersecting sides
diff --git a/pcbnew/class_board_design_settings.cpp b/pcbnew/class_board_design_settings.cpp
index 059134ac4f..1950c32978 100644
--- a/pcbnew/class_board_design_settings.cpp
+++ b/pcbnew/class_board_design_settings.cpp
@@ -72,14 +72,14 @@ void BOARD_DESIGN_SETTINGS::SetVisibleAlls()
void BOARD_DESIGN_SETTINGS::SetVisibleLayers( int aMask )
{
- // Although Pcbnew uses only 29, Gerbview uses all 32 layers
+ // Although Pcbnew uses only 29, GerbView uses all 32 layers
m_VisibleLayers = aMask & m_EnabledLayers & FULL_LAYERS;
}
void BOARD_DESIGN_SETTINGS::SetLayerVisibility( int aLayerIndex, bool aNewState )
{
- // Altough Pcbnew uses only 29, Gerbview uses all 32 layers
+ // Altough Pcbnew uses only 29, GerbView uses all 32 layers
if( aLayerIndex < 0 || aLayerIndex >= 32 )
return;
diff --git a/pcbnew/class_drc_item.cpp b/pcbnew/class_drc_item.cpp
index 0d990a1f49..6f883c2190 100644
--- a/pcbnew/class_drc_item.cpp
+++ b/pcbnew/class_drc_item.cpp
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007 Dick Hollenbeck, dick@softplc.com
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/class_netclass.cpp b/pcbnew/class_netclass.cpp
index 3eda529677..2f10f27553 100644
--- a/pcbnew/class_netclass.cpp
+++ b/pcbnew/class_netclass.cpp
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2009 Jean-Pierre Charras, jean-pierre.charras@inpg.fr
- * Copyright (C) 2009 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2009 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/class_netclass.h b/pcbnew/class_netclass.h
index 635bf50a48..8dc981b4c6 100644
--- a/pcbnew/class_netclass.h
+++ b/pcbnew/class_netclass.h
@@ -3,11 +3,11 @@
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
* Copyright (C) 2009 Jean-Pierre Charras, jean-pierre.charras@inpg.fr
- * Copyright (C) 2009 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2009 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/class_netinfo.h b/pcbnew/class_netinfo.h
index 1041932f2e..5cd186ace0 100644
--- a/pcbnew/class_netinfo.h
+++ b/pcbnew/class_netinfo.h
@@ -173,7 +173,7 @@ private:
// Used for fast comparisons in ratsnest and DRC computations.
wxString m_Netname; // Full net name like /mysheet/mysubsheet/vout
- // used by eeschema
+ // used by Eeschema
wxString m_ShortNetname; // short net name, like vout from
// /mysheet/mysubsheet/vout
diff --git a/pcbnew/class_pad.h b/pcbnew/class_pad.h
index 84caa0abdc..43e0686ae6 100644
--- a/pcbnew/class_pad.h
+++ b/pcbnew/class_pad.h
@@ -66,7 +66,7 @@ public:
class D_PAD : public BOARD_CONNECTED_ITEM
{
private:
- wxString m_Netname; // Full net name like /mysheet/mysubsheet/vout used by eeschema
+ wxString m_Netname; // Full net name like /mysheet/mysubsheet/vout used by Eeschema
wxString m_ShortNetname; // short net name, like vout from /mysheet/mysubsheet/vout
diff --git a/pcbnew/class_pad_draw_functions.cpp b/pcbnew/class_pad_draw_functions.cpp
index d3c844a15a..a776fa0cfe 100644
--- a/pcbnew/class_pad_draw_functions.cpp
+++ b/pcbnew/class_pad_draw_functions.cpp
@@ -339,9 +339,9 @@ void D_PAD::Draw( EDA_DRAW_PANEL* aPanel, wxDC* aDC, int aDraw_mode, const wxPoi
SetAlpha( &color, 170 );
/* Get the pad clearance. This has a meaning only for Pcbnew.
- * for Cvpcb (and Gerbview) GetClearance() creates debug errors because
+ * for CvPcb (and GerbView) GetClearance() creates debug errors because
* there is no net classes so a call to GetClearance() is made only when
- * needed (never needed in Cvpcb nor in Gerbview)
+ * needed (never needed in CvPcb nor in GerbView)
*/
drawInfo.m_PadClearance = DisplayIsol ? GetClearance() : 0;
diff --git a/pcbnew/class_pcb_layer_widget.cpp b/pcbnew/class_pcb_layer_widget.cpp
index 3b2dff067b..1a699bd949 100644
--- a/pcbnew/class_pcb_layer_widget.cpp
+++ b/pcbnew/class_pcb_layer_widget.cpp
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004-2010 Jean-Pierre Charras, jean-pierre.charras@gpisa-lab.inpg.fr
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -50,7 +50,7 @@
* Class PCB_LAYER_WIDGET
* is here to implement the abtract 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.
+ * menu which is specific to Pcbnew's needs.
*/
@@ -60,7 +60,7 @@ PCB_LAYER_WIDGET::PCB_LAYER_WIDGET( PCB_EDIT_FRAME* aParent, wxWindow* aFocusOwn
{
ReFillRender();
- // Update default tabs labels for gerbview
+ // Update default tabs labels for GerbView
SetLayersManagerTabsText( );
//-----<Popup menu>-------------------------------------------------
diff --git a/pcbnew/class_pcb_layer_widget.h b/pcbnew/class_pcb_layer_widget.h
index c861ca10a2..9e31ebb588 100644
--- a/pcbnew/class_pcb_layer_widget.h
+++ b/pcbnew/class_pcb_layer_widget.h
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004-2010 Jean-Pierre Charras, jean-pierre.charras@gpisa-lab.inpg.fr
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/class_text_mod.cpp b/pcbnew/class_text_mod.cpp
index b42b4ac7ad..178cb99f43 100644
--- a/pcbnew/class_text_mod.cpp
+++ b/pcbnew/class_text_mod.cpp
@@ -75,7 +75,7 @@ bool TEXTE_MODULE::Save( FILE* aFile ) const
MODULE* parent = (MODULE*) GetParent();
int orient = m_Orient;
- // Due to the pcbnew history, m_Orient is saved in screen value
+ // Due to the Pcbnew history, m_Orient is saved in screen value
// but it is handled as relative to its parent footprint
if( parent )
orient += parent->m_Orient;
@@ -130,7 +130,7 @@ int TEXTE_MODULE::ReadDescr( LINE_READER* aReader )
m_Type = type;
- // Due to the pcbnew history, .m_Orient is saved in screen value
+ // Due to the Pcbnew history, .m_Orient is saved in screen value
// but it is handled as relative to its parent footprint
m_Orient -= ( (MODULE*) m_Parent )->m_Orient;
diff --git a/pcbnew/class_track.cpp b/pcbnew/class_track.cpp
index ff68eb74ac..4b162ea43b 100644
--- a/pcbnew/class_track.cpp
+++ b/pcbnew/class_track.cpp
@@ -984,7 +984,7 @@ void TRACK::DisplayInfo( EDA_DRAW_FRAME* frame )
// Display basic infos
DisplayInfoBase( frame );
- // Display full track length (in pcbnew)
+ // Display full track length (in Pcbnew)
if( frame->m_Ident == PCB_FRAME )
{
int trackLen = 0;
@@ -1050,7 +1050,7 @@ void TRACK::DisplayInfoBase( EDA_DRAW_FRAME* frame )
frame->AppendMsgPanel( _( "Type" ), msg, DARKCYAN );
- // Display Net Name (in pcbnew)
+ // Display Net Name (in Pcbnew)
if( frame->m_Ident == PCB_FRAME )
{
NETINFO_ITEM* net = board->FindNet( GetNet() );
diff --git a/pcbnew/classpcb.cpp b/pcbnew/classpcb.cpp
index b0ca565dfa..4929251145 100644
--- a/pcbnew/classpcb.cpp
+++ b/pcbnew/classpcb.cpp
@@ -1,7 +1,8 @@
-/****************************************************************/
-/* member functions of classes used in pcbnew (see pcbstruct.h) */
-/* except for tracks (see class_track.cpp) */
-/****************************************************************/
+/**
+ * @file classpcb.cpp
+ * @brief Member functions of classes used in Pcbnew (see pcbstruct.h)
+ * except for tracks (see class_track.cpp).
+ */
#include "fctsys.h"
#include "common.h"
@@ -14,13 +15,13 @@
#include "pcbnew_id.h"
-/* Default pcbnew zoom values.
+/* Default Pcbnew zoom values.
* Limited to 19 values to keep a decent size to menus
* 15 it better but does not allow a sufficient number of values
* roughtly a 1.5 progression.
* The last 2 values is handy when somebody uses a library import of a module
* (or foreign data) which has a bad coordinate
- * Also useful in Gerbview for this reason.
+ * Also useful in GerbView for this reason.
* Zoom 5 and 10 can create artefacts when drawing (integer overflow in low level graphic
* functions )
*/
diff --git a/pcbnew/collectors.cpp b/pcbnew/collectors.cpp
index 2cfa116771..d0140d3a4a 100644
--- a/pcbnew/collectors.cpp
+++ b/pcbnew/collectors.cpp
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2008 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2004-2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2004-2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/collectors.h b/pcbnew/collectors.h
index 11b227d9c5..9bfc53494f 100644
--- a/pcbnew/collectors.h
+++ b/pcbnew/collectors.h
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2008 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2004-2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2004-2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/cross-probing.cpp b/pcbnew/cross-probing.cpp
index fa17307e47..fdfcedcc2c 100644
--- a/pcbnew/cross-probing.cpp
+++ b/pcbnew/cross-probing.cpp
@@ -1,13 +1,12 @@
-/*****************************************************************/
-/* Cross probing function: handle communication to/from eeschema */
-/*****************************************************************/
+/**
+ * @file pcbnew/cross-probing.cpp
+ * @brief Cross probing functions to handle communication to andfrom Eeschema.
+ */
-/* cross-probing.cpp */
-
-/** Handle messages between pcbnew and eeschema via a socket,
- * the port number is
- * KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242) (eeschema to pcbnew)
- * KICAD_SCH_PORT_SERVICE_NUMBER (currently 4243) (pcbnew to eeschema)
+/**
+ * Handle messages between Pcbnew and Eeschema via a socket, the port numbers are
+ * KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242) (Eeschema to Pcbnew)
+ * KICAD_SCH_PORT_SERVICE_NUMBER (currently 4243) (Pcbnew to Eeschema)
* Note: these ports must be enabled for firewall protection
*/
@@ -26,9 +25,10 @@
#include "protos.h"
-/** Read a remote command send by eeschema via a socket,
- * port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242)
- * @param cmdline = received command from eeschema
+/**
+ * Read a remote command send by Eeschema via a socket,
+ * port KICAD_PCB_PORT_SERVICE_NUMBER (currently 4242)
+ * @param cmdline = received command from Eeschema
* Commands are
* $PART: "reference" put cursor on component
* $PIN: "pin name" $PART: "reference" put cursor on the footprint pin
@@ -133,7 +133,8 @@ void RemoteCommand( const char* cmdline )
}
-/** Send a remote command to eeschema via a socket,
+/**
+ * Send a remote command to Eeschema via a socket,
* @param objectToSync = item to be located on schematic (module, pin or text)
* Commands are
* $PART: "reference" put cursor on component anchor
diff --git a/pcbnew/debug_kbool_key_file_fct.cpp b/pcbnew/debug_kbool_key_file_fct.cpp
index 84cb1d8171..c902550e72 100644
--- a/pcbnew/debug_kbool_key_file_fct.cpp
+++ b/pcbnew/debug_kbool_key_file_fct.cpp
@@ -46,7 +46,7 @@ void CreateKeyFile()
fprintf( kdebugFile, "LASTACC {%s}; # last access time\n",sDate_Time );
fprintf( kdebugFile, "LIBNAME trial;\n" );
- fprintf( kdebugFile, "UNITS;\n# Internal pcbnew units are in 0.0001 inch\n" );
+ fprintf( kdebugFile, "UNITS;\n# Internal Pcbnew units are in 0.0001 inch\n" );
fprintf( kdebugFile, "USERUNITS 1; PHYSUNITS 1;\n\n" );
}
else
diff --git a/pcbnew/dialogs/dialog_copper_zones.cpp b/pcbnew/dialogs/dialog_copper_zones.cpp
index f5ae98c7bd..35ce0d4fb4 100644
--- a/pcbnew/dialogs/dialog_copper_zones.cpp
+++ b/pcbnew/dialogs/dialog_copper_zones.cpp
@@ -301,7 +301,7 @@ bool DIALOG_COPPER_ZONE::AcceptOptions( bool aPromptForErrors, bool aUseExportab
ReturnValueFromString( g_UserUnit, txtvalue, m_Parent->m_InternalUnits );
// Test if this is a reasonnable value for this parameter
- // A too large value can hang pcbnew
+ // A too large value can hang Pcbnew
#define CLEARANCE_MAX_VALUE 5000 // in 1/10000 inch
if( m_Zone_Setting->m_ZoneClearance > CLEARANCE_MAX_VALUE )
{
diff --git a/pcbnew/dialogs/dialog_design_rules.cpp b/pcbnew/dialogs/dialog_design_rules.cpp
index 778dbc48aa..8cd8ff62ad 100644
--- a/pcbnew/dialogs/dialog_design_rules.cpp
+++ b/pcbnew/dialogs/dialog_design_rules.cpp
@@ -1,13 +1,13 @@
-/////////////////////////////////////////////////////////////////////////////
-// Name: dialog_design_rules.cpp
-/////////////////////////////////////////////////////////////////////////////
+/**
+ * @file dialog_design_rules.cpp
+ */
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004-2009 Jean-Pierre Charras, jean-pierre.charras@gpisa-lab.inpg.fr
* Copyright (C) 2009 Dick Hollenbeck, dick@softplc.com
- * Copyright (C) 2009 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2009 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/dialogs/dialog_gendrill.cpp b/pcbnew/dialogs/dialog_gendrill.cpp
index 0ca32f45c6..9e26de309c 100644
--- a/pcbnew/dialogs/dialog_gendrill.cpp
+++ b/pcbnew/dialogs/dialog_gendrill.cpp
@@ -1,12 +1,12 @@
/**
-** @file dialog_gendrill.cpp
-*/
+ * @file dialog_gendrill.cpp
+ */
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 Jean_Pierre Charras <jp.charras@ujf-grenoble.fr>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/dialogs/dialog_gendrill.h b/pcbnew/dialogs/dialog_gendrill.h
index 7d0b584c96..404c2cfb55 100644
--- a/pcbnew/dialogs/dialog_gendrill.h
+++ b/pcbnew/dialogs/dialog_gendrill.h
@@ -3,10 +3,10 @@
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 Jean_Pierre Charras <jp.charras@ujf-grenoble.fr>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/dialogs/dialog_global_edit_tracks_and_vias.h b/pcbnew/dialogs/dialog_global_edit_tracks_and_vias.h
index 0fa7f30c10..2183f90a74 100644
--- a/pcbnew/dialogs/dialog_global_edit_tracks_and_vias.h
+++ b/pcbnew/dialogs/dialog_global_edit_tracks_and_vias.h
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2009 Jean-Pierre Charras, jean-pierre.charras@gipsa-lab.inpg.fr
- * Copyright (C) 1992-2009 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2009 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/dialogs/dialog_graphic_items_options.h b/pcbnew/dialogs/dialog_graphic_items_options.h
index 7956086b5e..c00a4720ad 100644
--- a/pcbnew/dialogs/dialog_graphic_items_options.h
+++ b/pcbnew/dialogs/dialog_graphic_items_options.h
@@ -1,11 +1,12 @@
-/////////////////////////////////////////////////////////////////////////////
-// Name: dialog_graphic_items_options.h
-//////////////////////////////////////////////////////////////////////////////*
+/**
+ * @file dialog_graphic_items_options.h
+ */
+
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 <Jean-Pierre Charras> jean-pierre.charras@gipsa-lab.inpg.fr
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/dialogs/dialog_layers_setup.cpp b/pcbnew/dialogs/dialog_layers_setup.cpp
index c16ecaeb64..7bd85a5dc8 100644
--- a/pcbnew/dialogs/dialog_layers_setup.cpp
+++ b/pcbnew/dialogs/dialog_layers_setup.cpp
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009 Isaac Marino Bavaresco, isaacbavaresco@yahoo.com.br
* Copyright (C) 2009 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2009 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2009 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/dialogs/dialog_orient_footprints.cpp b/pcbnew/dialogs/dialog_orient_footprints.cpp
index 606e321a6a..1e5dc148eb 100644
--- a/pcbnew/dialogs/dialog_orient_footprints.cpp
+++ b/pcbnew/dialogs/dialog_orient_footprints.cpp
@@ -2,10 +2,10 @@
* @file DIALOG_ORIENT_FOOTPRINTS.cpp
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 Jean_Pierre Charras <jp.charras@ujf-grenoble.fr>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/dialogs/dialog_pcb_text_properties.cpp b/pcbnew/dialogs/dialog_pcb_text_properties.cpp
index e09a34aca7..5b05d90aee 100644
--- a/pcbnew/dialogs/dialog_pcb_text_properties.cpp
+++ b/pcbnew/dialogs/dialog_pcb_text_properties.cpp
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004-2010 Jean-Pierre Charras <jean-pierre.charras@gpisa-lab.inpg.fr>
- * Copyright (C) 2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/dialogs/dialog_pcbnew_config_libs_and_paths.cpp b/pcbnew/dialogs/dialog_pcbnew_config_libs_and_paths.cpp
index d2cfa1b5f6..145f38f6f9 100644
--- a/pcbnew/dialogs/dialog_pcbnew_config_libs_and_paths.cpp
+++ b/pcbnew/dialogs/dialog_pcbnew_config_libs_and_paths.cpp
@@ -5,7 +5,7 @@
// Licence: GPL
/////////////////////////////////////////////////////////////////////////////
-/* Handle the pcbnew library config (library list, and default lib path)
+/* Handle the Pcbnew library config (library list, and default lib path)
*/
#include "fctsys.h"
diff --git a/pcbnew/dialogs/dialog_print_using_printer.cpp b/pcbnew/dialogs/dialog_print_using_printer.cpp
index 53400e9bdc..27bd634b2c 100644
--- a/pcbnew/dialogs/dialog_print_using_printer.cpp
+++ b/pcbnew/dialogs/dialog_print_using_printer.cpp
@@ -329,7 +329,7 @@ int DIALOG_PRINT_USING_PRINTER::SetLayerMaskFromListSelection()
}
}
- // In pcbnew: force the EDGE layer to be printed or not with the other layers
+ // In Pcbnew force the EDGE layer to be printed or not with the other layers
m_ExcludeEdgeLayer = m_Exclude_Edges_Pcb->IsChecked();
if( m_ExcludeEdgeLayer )
s_Parameters.m_Flags = 0;
@@ -491,7 +491,7 @@ void DIALOG_PRINT_USING_PRINTER::OnPrintPreview( wxCommandEvent& event )
SetLayerMaskFromListSelection();
// If no layer selected, we have no plot. prompt user if it happens
- // because he could think there is a bug in pcbnew:
+ // because he could think there is a bug in Pcbnew:
if( s_Parameters.m_PrintMaskLayer == 0 )
{
DisplayError( this, _( "No layer selected" ) );
@@ -521,7 +521,7 @@ void DIALOG_PRINT_USING_PRINTER::OnPrintButtonClick( wxCommandEvent& event )
SetPrintParameters( );
// If no layer selected, we have no plot. prompt user if it happens
- // because he could think there is a bug in pcbnew:
+ // because he could think there is a bug in Pcbnew:
if( s_Parameters.m_PrintMaskLayer == 0 )
{
DisplayError( this, _( "No layer selected" ) );
diff --git a/pcbnew/drc.cpp b/pcbnew/drc.cpp
index f9b065b55b..4a7eecc429 100644
--- a/pcbnew/drc.cpp
+++ b/pcbnew/drc.cpp
@@ -1,10 +1,10 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004-2007 Jean-Pierre Charras, jean-pierre.charras@gipsa-lab.inpg.fr
* Copyright (C) 2007 Dick Hollenbeck, dick@softplc.com
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/drc_clearance_test_functions.cpp b/pcbnew/drc_clearance_test_functions.cpp
index 448855c7a6..3df9f7e92c 100644
--- a/pcbnew/drc_clearance_test_functions.cpp
+++ b/pcbnew/drc_clearance_test_functions.cpp
@@ -1,13 +1,13 @@
/**
- *@file drc_clearance_test_functions.cpp
+ * @file drc_clearance_test_functions.cpp
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004-2007 Jean-Pierre Charras, jean-pierre.charras@gipsa-lab.inpg.fr
* Copyright (C) 2007 Dick Hollenbeck, dick@softplc.com
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/drc_marker_functions.cpp b/pcbnew/drc_marker_functions.cpp
index dbacf718e7..b4fce4aa37 100644
--- a/pcbnew/drc_marker_functions.cpp
+++ b/pcbnew/drc_marker_functions.cpp
@@ -1,12 +1,13 @@
-/*
- * drc_marker_functions.cpp
+/**
+ * @file drc_marker_functions.cpp
*/
+
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2010 Dick Hollenbeck, dick@softplc.com
* Copyright (C) 2004-2010 Jean-Pierre Charras, jean-pierre.charras@gipsa-lab.inpg.fr
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/drc_stuff.h b/pcbnew/drc_stuff.h
index 010bca81c9..2ed4b1ff56 100644
--- a/pcbnew/drc_stuff.h
+++ b/pcbnew/drc_stuff.h
@@ -3,10 +3,10 @@
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007 Dick Hollenbeck, dick@softplc.com
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/export_gencad.cpp b/pcbnew/export_gencad.cpp
index 858eb74ff4..62de5070a3 100644
--- a/pcbnew/export_gencad.cpp
+++ b/pcbnew/export_gencad.cpp
@@ -893,15 +893,19 @@ void FootprintWriteShape( FILE* file, MODULE* module )
{ // Arcs are defined counter clockwise (positive trigonometric)
// from the start point to the end point (0 to 360 degrees)
wxPoint arcStart, arcEnd;
+
// edge->m_Start0 is the arc center relative to the shape position
// edge->m_End0 is the arc start point relative to the shape position
arcStart = edge->m_End0;
- // calculate arcEnd arc end point relative to the shape position, in pcbnew
+
+ // calculate arcEnd arc end point relative to the shape position, in Pcbnew
// coordinates
arcEnd = arcStart;
RotatePoint( &arcEnd, edge->m_Start0, -edge->m_Angle );
- // due to difference between pcbnew and gencad, swap arc start and arc end
+
+ // due to difference between Pcbnew and gencad, swap arc start and arc end
EXCHG(arcEnd, arcStart);
+
// print arc shape:
fprintf( file, "ARC %d %d %d %d %d %d\n",
arcStart.x, y_axis_sign * arcStart.y, // Start point
diff --git a/pcbnew/export_vrml.cpp b/pcbnew/export_vrml.cpp
index 1d1d95c574..fce4b09f97 100644
--- a/pcbnew/export_vrml.cpp
+++ b/pcbnew/export_vrml.cpp
@@ -1130,7 +1130,7 @@ static void export_vrml_module( BOARD* aPcb, MODULE* aModule,
fprintf( aOutputFile, " translation %g %g %g\n",
(double) (offsetx + aModule->m_Pos.x),
- - (double)(offsety + aModule->m_Pos.y), // Y axis is reversed in pcbnew
+ - (double)(offsety + aModule->m_Pos.y), // Y axis is reversed in Pcbnew
offsetz + layer_z[aModule->GetLayer()] );
fprintf( aOutputFile,
" children [\n Inline {\n url \"%s\"\n } ]\n",
@@ -1227,7 +1227,7 @@ bool PCB_EDIT_FRAME::ExportVRML_File( const wxString & aFullFileName,
ChangeIllegalCharacters( name, false );
fprintf( output_file, "#VRML V2.0 utf8\n"
"WorldInfo {\n"
- " title \"%s - Generated by PCBNEW\"\n"
+ " title \"%s - Generated by Pcbnew\"\n"
"}\n", TO_UTF8( name ) );
/* The would be in decimils and not in meters, as the standard wants.
diff --git a/pcbnew/files.cpp b/pcbnew/files.cpp
index bdd52da23d..8ca20fdb4b 100644
--- a/pcbnew/files.cpp
+++ b/pcbnew/files.cpp
@@ -202,12 +202,12 @@ the changes?" ) ) )
if ( ver > g_CurrentVersionPCB )
{
DisplayInfoMessage( this, _( "This file was created by a more recent \
-version of PCBnew and may not load correctly. Please consider updating!" ) );
+version of Pcbnew and may not load correctly. Please consider updating!" ) );
}
else if ( ver < g_CurrentVersionPCB )
{
DisplayInfoMessage( this, _( "This file was created by an older \
-version of PCBnew. It will be stored in the new file format when you save \
+version of Pcbnew. It will be stored in the new file format when you save \
this file again." ) );
}
@@ -292,11 +292,11 @@ this file again." ) );
m_Draw3DFrame->NewDisplay();
#if 0 && defined(DEBUG)
- // note this freezes up pcbnew when run under the kicad project
- // manager. runs fine from command prompt. This is because the kicad
- // project manager redirects stdout of the child pcbnew process to itself,
+ // note this freezes up Pcbnew when run under the KiCad project
+ // manager. runs fine from command prompt. This is because the KiCad
+ // project manager redirects stdout of the child Pcbnew process to itself,
// but never reads from that pipe, and that in turn eventually blocks
- // the pcbnew program when the pipe it is writing to gets full.
+ // the Pcbnew program when the pipe it is writing to gets full.
// Output the board object tree to stdout, but please run from command prompt:
GetBoard()->Show( 0, std::cout );
diff --git a/pcbnew/find.cpp b/pcbnew/find.cpp
index ae3ab53683..0424a359d8 100644
--- a/pcbnew/find.cpp
+++ b/pcbnew/find.cpp
@@ -1,6 +1,7 @@
-/********************************************/
-/* PCBNEW - Find dialog box implementation. */
-/********************************************/
+/**
+ * @file pcbnew/find.cpp
+ * @brief Pcbnew find dialog box implementation.
+ */
#include "fctsys.h"
diff --git a/pcbnew/gen_modules_placefile.cpp b/pcbnew/gen_modules_placefile.cpp
index bdc692a8df..311fe3869b 100644
--- a/pcbnew/gen_modules_placefile.cpp
+++ b/pcbnew/gen_modules_placefile.cpp
@@ -221,7 +221,7 @@ void PCB_EDIT_FRAME::GenModulesPosition( wxCommandEvent& event )
fputs( line, fpBack );
Title = wxGetApp().GetAppName() + wxT( " " ) + GetBuildVersion();
- sprintf( line, "### Printed by PcbNew version %s\n", TO_UTF8( Title ) );
+ sprintf( line, "### Printed by Pcbnew version %s\n", TO_UTF8( Title ) );
fputs( line, fpFront );
if( doBoardBack )
@@ -365,7 +365,7 @@ void PCB_EDIT_FRAME::GenModuleReport( wxCommandEvent& event )
fputs( line, rptfile );
wxString Title = wxGetApp().GetAppName() + wxT( " " ) + GetBuildVersion();
- sprintf( line, "## Created by PcbNew version %s\n", TO_UTF8( Title ) );
+ sprintf( line, "## Created by Pcbnew version %s\n", TO_UTF8( Title ) );
fputs( line, rptfile );
fputs( "## Unit = inches, Angle = deg.\n", rptfile );
diff --git a/pcbnew/gendrill.cpp b/pcbnew/gendrill.cpp
index 19801fb6ea..af21f12cf0 100644
--- a/pcbnew/gendrill.cpp
+++ b/pcbnew/gendrill.cpp
@@ -1,15 +1,13 @@
/**
- *@file gendrill.cpp
+ * @file gendrill.cpp
+ * @brief Functions to create EXCELLON drill files and report files.
*/
-/*************************************************************/
-/* Functions to create EXCELLON drill files and report files */
-/*************************************************************/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 Jean_Pierre Charras <jp.charras@ujf-grenoble.fr>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/gendrill.h b/pcbnew/gendrill.h
index c22d6915d8..38ed73d905 100644
--- a/pcbnew/gendrill.h
+++ b/pcbnew/gendrill.h
@@ -4,10 +4,10 @@
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2010 Jean_Pierre Charras <jp.charras@ujf-grenoble.fr>
- * Copyright (C) 1992-2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/gpcb_exchange.cpp b/pcbnew/gpcb_exchange.cpp
index 5d4640fc49..0ed42808a5 100644
--- a/pcbnew/gpcb_exchange.cpp
+++ b/pcbnew/gpcb_exchange.cpp
@@ -158,7 +158,7 @@ bool MODULE::Read_GPCB_Descr( const wxString& CmpFullFileName )
#define OLD_GPCB_UNIT_CONV 10
#define NEW_GPCB_UNIT_CONV 0.1
FILE* cmpfile;
- double conv_unit = NEW_GPCB_UNIT_CONV; // GPCB unit = 0.01 mils and pcbnew 0.1
+ double conv_unit = NEW_GPCB_UNIT_CONV; // GPCB unit = 0.01 mils and Pcbnew 0.1
// Old version unit = 1 mil, so conv_unit is 10 or 0.1
bool success = true;
char* Line;
@@ -291,7 +291,7 @@ bool MODULE::Read_GPCB_Descr( const wxString& CmpFullFileName )
if( params[0].CmpNoCase( wxT( "ElementArc" ) ) == 0 ) // Arc descr
{ // format: ElementArc [X Y Width Height StartAngle DeltaAngle Thickness]
- // pcbnew does know ellipse so we must have Width = Height
+ // Pcbnew does know ellipse so we must have Width = Height
DrawSegm = new EDGE_MODULE( this );
DrawSegm->SetLayer( SILKSCREEN_N_FRONT );
DrawSegm->m_Shape = S_ARC;
@@ -312,14 +312,14 @@ bool MODULE::Read_GPCB_Descr( const wxString& CmpFullFileName )
ibuf[ii] = 0;
}
- int radius = (ibuf[2] + ibuf[3]) / 4; // for and arc: ibuf[3] = ibuf[4]. pcbnew does not know ellipses
+ int radius = (ibuf[2] + ibuf[3]) / 4; // for and arc: ibuf[3] = ibuf[4]. Pcbnew does not know ellipses
wxPoint centre;
centre.x = wxRound( ibuf[0] * conv_unit );
centre.y = wxRound( ibuf[1] * conv_unit );
DrawSegm->m_Start0 = centre;
int start_angle = ibuf[4] * 10; // Pcbnew uses 0.1 degrees as units
start_angle -= 1800; // Use normal X axis as reference
- DrawSegm->m_Angle = ibuf[5] * 10; // Angle value is clockwise in gpcb and pcbnew
+ DrawSegm->m_Angle = ibuf[5] * 10; // Angle value is clockwise in gpcb and Pcbnew
DrawSegm->m_End0.x = wxRound( radius * conv_unit );
DrawSegm->m_End0.y = 0;
RotatePoint( &DrawSegm->m_End0, -start_angle );// Calculate start point coordinate of arc
diff --git a/pcbnew/hotkeys.cpp b/pcbnew/hotkeys.cpp
index fcfc0fe809..fe3f1ce5d9 100644
--- a/pcbnew/hotkeys.cpp
+++ b/pcbnew/hotkeys.cpp
@@ -200,7 +200,7 @@ EDA_HOTKEY* common_Hotkey_List[] =
NULL
};
-// List of hotkey descriptors for pcbnew
+// List of hotkey descriptors for Pcbnew
EDA_HOTKEY* board_edit_Hotkey_List[] =
{
&HkTrackDisplayMode, &HkDelete,
@@ -234,7 +234,7 @@ EDA_HOTKEY* module_edit_Hotkey_List[] = {
NULL
};
-// list of sections and corresponding hotkey list for pcbnew
+// list of sections and corresponding hotkey list for Pcbnew
// (used to create an hotkey config file, and edit hotkeys )
struct EDA_HOTKEY_CONFIG g_Pcbnew_Editor_Hokeys_Descr[] = {
{ &g_CommonSectionTag, common_Hotkey_List, L"Common keys" },
diff --git a/pcbnew/ioascii.cpp b/pcbnew/ioascii.cpp
index 731d4eafd6..61000c0212 100644
--- a/pcbnew/ioascii.cpp
+++ b/pcbnew/ioascii.cpp
@@ -1,6 +1,6 @@
/**
* @file ioascii.cpp
- * @brief Routines for reading and saving of structures in ASCII file common to Pcbnew and CVPCB.
+ * @brief Routines for reading and saving of structures in ASCII file common to Pcbnew and CvPcb.
*/
#include "fctsys.h"
@@ -680,7 +680,7 @@ static int WriteSetup( FILE* aFile, PCB_EDIT_FRAME* aFrame, BOARD* aBoard )
}
}
- // Save current default track width, for compatibility with older pcbnew version;
+ // Save current default track width, for compatibility with older Pcbnew version;
fprintf( aFile, "TrackWidth %d\n", aBoard->GetCurrentTrackWidth() );
// Save custom tracks width list (the first is not saved here: this is the netclass value
@@ -695,7 +695,7 @@ static int WriteSetup( FILE* aFile, PCB_EDIT_FRAME* aFrame, BOARD* aBoard )
fprintf( aFile, "DrawSegmWidth %d\n", aBoard->GetBoardDesignSettings()->m_DrawSegmentWidth );
fprintf( aFile, "EdgeSegmWidth %d\n", aBoard->GetBoardDesignSettings()->m_EdgeSegmentWidth );
- // Save current default via size, for compatibility with older pcbnew version;
+ // Save current default via size, for compatibility with older Pcbnew version;
fprintf( aFile, "ViaSize %d\n", netclass_default->GetViaDiameter() );
fprintf( aFile, "ViaDrill %d\n", netclass_default->GetViaDrill() );
fprintf( aFile, "ViaMinSize %d\n", aBoard->GetBoardDesignSettings()->m_ViasMinSize );
diff --git a/pcbnew/layer_widget.cpp b/pcbnew/layer_widget.cpp
index f6a27396ed..3d1d05d088 100644
--- a/pcbnew/layer_widget.cpp
+++ b/pcbnew/layer_widget.cpp
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -67,7 +67,7 @@ static const char * clear_xpm[] = {
/* XPM
* This bitmap can be used to show a not selected layer
- * with special property (mainly not selected layers not in use in Gerbview)
+ * with special property (mainly not selected layers not in use in GerbView)
*/
static const char * clear_alternate_xpm[] = {
"10 14 4 1",
@@ -117,7 +117,7 @@ static const char * rightarrow_xpm[] = {
/* XPM
* This bitmap can be used to show the selected layer
- * with special property (mainly a layer in use in Gerbview)
+ * with special property (mainly a layer in use in GerbView)
*/
static const char * rightarrow_alternate_xpm[] = {
"10 14 5 1",
diff --git a/pcbnew/layer_widget.h b/pcbnew/layer_widget.h
index 5d9d395139..64350a75b9 100644
--- a/pcbnew/layer_widget.h
+++ b/pcbnew/layer_widget.h
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -117,7 +117,7 @@ protected:
* @return true if bitmaps shown in Render layer list
* are alternate bitmaps, or false if they are "normal" bitmaps
* This is a virtual function because Pcbnew uses normal bitmaps
- * but Gerbview uses both bitmaps
+ * but GerbView uses both bitmaps
* (alternate bitmaps to show layers in use, normal fo others)
*/
virtual bool useAlternateBitmap(int aRow) { return false; }
diff --git a/pcbnew/librairi.cpp b/pcbnew/librairi.cpp
index e5afeb939e..2932f40e4b 100644
--- a/pcbnew/librairi.cpp
+++ b/pcbnew/librairi.cpp
@@ -39,7 +39,7 @@
const wxString ModExportFileExtension( wxT( "emp" ) );
-static const wxString ModExportFileWildcard( _( "Kicad foot print export files (*.emp)|*.emp" ) );
+static const wxString ModExportFileWildcard( _( "KiCad foot print export files (*.emp)|*.emp" ) );
MODULE* FOOTPRINT_EDIT_FRAME::Import_Module()
@@ -502,7 +502,7 @@ bool PCB_BASE_FRAME::Save_Module_In_Library( const wxString& aLibName,
if( ! input_lib.IsLibrary() )
{
fclose( lib_module );
- msg.Printf( _( "File %s is not an EESchema library" ), GetChars( aLibName ) );
+ msg.Printf( _( "File %s is not an Eeschema library" ), GetChars( aLibName ) );
DisplayError( this, msg );
return false;
}
diff --git a/pcbnew/loadcmp.cpp b/pcbnew/loadcmp.cpp
index 565c05c2d6..ab57275dcd 100644
--- a/pcbnew/loadcmp.cpp
+++ b/pcbnew/loadcmp.cpp
@@ -237,7 +237,7 @@ MODULE* PCB_BASE_FRAME::GetModuleLibrary( const wxString& aLibraryFullFilename,
if( !curr_lib.IsLibrary() )
{
- msg.Printf( _( "<%s> is not a valid Kicad PCB footprint library file." ),
+ msg.Printf( _( "<%s> is not a valid KiCad PCB footprint library file." ),
GetChars( tmp ) );
wxMessageBox( msg, _( "Library Load Error" ), wxOK | wxICON_ERROR, this );
return NULL;
diff --git a/pcbnew/menubar_modedit.cpp b/pcbnew/menubar_modedit.cpp
index 7cd587dc93..bd58ae5704 100644
--- a/pcbnew/menubar_modedit.cpp
+++ b/pcbnew/menubar_modedit.cpp
@@ -303,7 +303,7 @@ void FOOTPRINT_EDIT_FRAME::ReCreateMenuBar()
AddMenuItem( helpMenu,
wxID_HELP,
_( "&Contents" ),
- _( "Open the PCBNew handbook" ),
+ _( "Open the Pcbnew handbook" ),
KiBitmap( online_help_xpm ) );
AddMenuItem( helpMenu,
wxID_INDEX,
@@ -311,11 +311,11 @@ void FOOTPRINT_EDIT_FRAME::ReCreateMenuBar()
_( "Open the \"Getting Started in KiCad\" guide for beginners" ),
KiBitmap( help_xpm ) );
- // About PCBNew
+ // About Pcbnew
helpMenu->AppendSeparator();
AddMenuItem( helpMenu, wxID_ABOUT,
- _( "&About PCBNew" ),
- _( "About PCBNew PCB designer" ),
+ _( "&About Pcbnew" ),
+ _( "About Pcbnew PCB designer" ),
KiBitmap( info_xpm ) );
// Append menus to the menubar
diff --git a/pcbnew/menubar_pcbframe.cpp b/pcbnew/menubar_pcbframe.cpp
index cec069507a..95d40e287f 100644
--- a/pcbnew/menubar_pcbframe.cpp
+++ b/pcbnew/menubar_pcbframe.cpp
@@ -1,6 +1,6 @@
/**
* @file menubar_pcbframe.cpp
- * PCBNew editor menu bar
+ * Pcbnew editor menu bar
*/
#include "fctsys.h"
#include "appl_wxstruct.h"
@@ -13,7 +13,7 @@
#include "help_common_strings.h"
/**
- * PCBNew mainframe menubar
+ * Pcbnew mainframe menubar
*/
void PCB_EDIT_FRAME::ReCreateMenuBar()
{
@@ -67,10 +67,10 @@ void PCB_EDIT_FRAME::ReCreateMenuBar()
KiBitmap( open_project_xpm ) );
- // PCBNew Board
+ // Pcbnew Board
item = new wxMenuItem( filesMenu, ID_APPEND_FILE,
- _( "&Append Board" ),
- _( "Append another PCBNew board to the current loaded board" ) );
+ _( "&Append Board" ),
+ _( "Append another Pcbnew board to the current loaded board" ) );
SET_BITMAP( KiBitmap( import_xpm ) );
filesMenu->Append( item );
@@ -248,7 +248,7 @@ void PCB_EDIT_FRAME::ReCreateMenuBar()
/* Quit */
filesMenu->AppendSeparator();
- item = new wxMenuItem( filesMenu, wxID_EXIT, _( "&Quit" ), _( "Quit PCBNew" ) );
+ item = new wxMenuItem( filesMenu, wxID_EXIT, _( "&Quit" ), _( "Quit Pcbnew" ) );
SET_BITMAP( KiBitmap( exit_xpm ) );
filesMenu->Append( item );
@@ -495,7 +495,7 @@ void PCB_EDIT_FRAME::ReCreateMenuBar()
#else
item = new wxMenuItem( configmenu, wxID_PREFERENCES,
_( "&General" ),
- _( "Select general options for PCBnew" ) );
+ _( "Select general options for Pcbnew" ) );
SET_BITMAP( KiBitmap( preference_xpm ) );
configmenu->Append( item );
@@ -657,7 +657,7 @@ void PCB_EDIT_FRAME::ReCreateMenuBar()
// Contents
AddMenuItem( helpMenu, wxID_HELP,
_( "&Contents" ),
- _( "Open the PCBNew handbook" ),
+ _( "Open the pcbnew handbook" ),
KiBitmap( online_help_xpm ) );
AddMenuItem( helpMenu, wxID_INDEX,
_( "&Getting Started in KiCad" ),
@@ -667,8 +667,8 @@ void PCB_EDIT_FRAME::ReCreateMenuBar()
// About
helpMenu->AppendSeparator();
AddMenuItem( helpMenu, wxID_ABOUT,
- _( "&About PCBNew" ),
- _( "About PCBnew printed circuit board designer" ),
+ _( "&About Pcbnew" ),
+ _( "About Pcbnew printed circuit board designer" ),
KiBitmap( info_xpm ) );
/**
diff --git a/pcbnew/modeditoptions.cpp b/pcbnew/modeditoptions.cpp
index ad69c413c4..1f2caa9892 100644
--- a/pcbnew/modeditoptions.cpp
+++ b/pcbnew/modeditoptions.cpp
@@ -1,6 +1,7 @@
-/***********************************************/
-/* PCBNEW - Footprint (module) editor options. */
-/***********************************************/
+/**
+ * @file modeditoptions.cpp
+ * @brief Pcbnew footprint (module) editor options.
+ */
#include "fctsys.h"
#include "class_drawpanel.h"
diff --git a/pcbnew/netlist.cpp b/pcbnew/netlist.cpp
index 88bf45b578..ea3854f8f3 100644
--- a/pcbnew/netlist.cpp
+++ b/pcbnew/netlist.cpp
@@ -1,6 +1,6 @@
-/***********************/
-/* PCBNEW: netlist.cpp */
-/***********************/
+/**
+ * @file pcbnew/netlist.cpp
+ */
/*
* Functions to read a netlist. They are:
@@ -80,7 +80,7 @@ public: MODULE_INFO( const wxString& libname,
class NETLIST_READER
{
private:
- PCB_EDIT_FRAME* m_pcbframe; // the main pcbnew frame
+ PCB_EDIT_FRAME* m_pcbframe; // the main Pcbnew frame
wxTextCtrl* m_messageWindow; // a textctrl to show messages (can be NULL)
wxString m_netlistFullName; // The full netlist filename
wxString m_cmplistFullName; // The full component/footprint association filename
diff --git a/pcbnew/pcb_plot_params.cpp b/pcbnew/pcb_plot_params.cpp
index a378fc7231..d4d8fbece5 100644
--- a/pcbnew/pcb_plot_params.cpp
+++ b/pcbnew/pcb_plot_params.cpp
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
- * Copyright (C) 1992-2011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/pcb_plot_params.h b/pcbnew/pcb_plot_params.h
index 23402a7e9c..0d9a6c677e 100644
--- a/pcbnew/pcb_plot_params.h
+++ b/pcbnew/pcb_plot_params.h
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
- * Copyright (C) 1992-2011 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 1992-2011 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/pcbframe.cpp b/pcbnew/pcbframe.cpp
index ee919aae3d..ccc9f10433 100644
--- a/pcbnew/pcbframe.cpp
+++ b/pcbnew/pcbframe.cpp
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2004-2010 Jean-Pierre Charras, jean-pierre.charras@gpisa-lab.inpg.fr
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/pcbnew.cpp b/pcbnew/pcbnew.cpp
index 050d76e3c0..d83da49f30 100644
--- a/pcbnew/pcbnew.cpp
+++ b/pcbnew/pcbnew.cpp
@@ -1,6 +1,6 @@
/**
* @file pcbnew.cpp
- * @brief PCBNEW: main program.
+ * @brief Pcbnew main program.
*/
#include "fctsys.h"
@@ -24,10 +24,10 @@
// Colors for layers and items
COLORS_DESIGN_SETTINGS g_ColorsSettings;
-int g_DrawDefaultLineThickness = 60; /* Default line thickness in PCBNEW units used to
- * draw/plot items having a
- * default thickness line value (Frame references)
- * (i.e. = 0 ). 0 = single pixel line width */
+int g_DrawDefaultLineThickness = 60; /* Default line thickness in PCnew units used to draw
+ * or plot items having a default thickness line value
+ * (Frame references) (i.e. = 0 ). 0 = single pixel line
+ * width */
bool Drc_On = true;
bool g_AutoDeleteOldTrack = true;
@@ -52,7 +52,7 @@ int g_MagneticTrackOption = capture_cursor_in_track_tool;
wxPoint g_Offset_Module; /* Distance to offset module trace when moving. */
// Wildcard for footprint libraries filesnames
-const wxString g_FootprintLibFileWildcard( wxT( "Kicad footprint library file (*.mod)|*.mod" ) );
+const wxString g_FootprintLibFileWildcard( _( "KiCad footprint library file (*.mod)|*.mod" ) );
/* Name of the document footprint list
* usually located in share/modules/footprints_doc
@@ -87,11 +87,11 @@ bool EDA_APP::OnInit()
wxFileName fn;
PCB_EDIT_FRAME* frame = NULL;
- InitEDA_Appl( wxT( "PCBNew" ), APP_PCBNEW_T );
+ InitEDA_Appl( wxT( "Pcbnew" ), APP_PCBNEW_T );
if( m_Checker && m_Checker->IsAnotherRunning() )
{
- if( !IsOK( NULL, _( "PCBNew is already running, Continue?" ) ) )
+ if( !IsOK( NULL, _( "Pcbnew is already running, Continue?" ) ) )
return false;
}
@@ -105,7 +105,7 @@ bool EDA_APP::OnInit()
if( fn.GetExt() != PcbFileExtension )
{
- wxLogDebug( wxT( "PCBNew file <%s> has the wrong extension. \
+ wxLogDebug( wxT( "Pcbnew file <%s> has the wrong extension. \
Changing extension to .brd." ), GetChars( fn.GetFullPath() ) );
fn.SetExt( PcbFileExtension );
}
@@ -120,7 +120,7 @@ Changing extension to .brd." ), GetChars( fn.GetFullPath() ) );
* display the real hotkeys in menus or tool tips */
ReadHotkeyConfig( wxT( "PcbFrame" ), g_Board_Editor_Hokeys_Descr );
- frame = new PCB_EDIT_FRAME( NULL, wxT( "PCBNew" ), wxPoint( 0, 0 ), wxSize( 600, 400 ) );
+ frame = new PCB_EDIT_FRAME( NULL, wxT( "Pcbnew" ), wxPoint( 0, 0 ), wxSize( 600, 400 ) );
frame->UpdateTitle();
SetTopWindow( frame );
@@ -137,9 +137,8 @@ Changing extension to .brd." ), GetChars( fn.GetFullPath() ) );
/* Load file specified in the command line. */
if( fn.IsOk() )
{
- /* Note the first time PCBnew is called after creating a new project
- * the board file may not exists
- * So we load settings only
+ /* Note the first time Pcbnew is called after creating a new project
+ * the board file may not exist so we load settings only.
*/
if( fn.FileExists() )
{
diff --git a/pcbnew/pcbnew.h b/pcbnew/pcbnew.h
index 0ffaf7115e..bb51c4d026 100644
--- a/pcbnew/pcbnew.h
+++ b/pcbnew/pcbnew.h
@@ -12,7 +12,7 @@
#define U_PCB (PCB_INTERNAL_UNIT / EESCHEMA_INTERNAL_UNIT)
-// Arcs are approximated by segments: define the number of segments per 360 deg (kicad use 0.1
+// Arcs are approximated by segments: define the number of segments per 360 deg (KiCad uses 0.1
// deg approximation). Be aware 3600 / ARC_APPROX_SEGMENTS_COUNT_LOW_DEF is an integer.
#define ARC_APPROX_SEGMENTS_COUNT_LOW_DEF 16
#define ARC_APPROX_SEGMENTS_COUNT_HIGHT_DEF 32
@@ -33,9 +33,9 @@
#define DIM_ANCRE_MODULE 3 /* Anchor size (footprint center) */
#define DIM_ANCRE_TEXTE 2 /* Anchor size (Text center) */
-#define TEXTS_MIN_SIZE 50 // Minimum text size in pcbnew units value (50 * 0.0001 mils)
-#define TEXTS_MAX_SIZE 10000 // Maximum text size in pcbnew units value (1 inch) )
-#define TEXTS_MAX_WIDTH 5000 // Maximum text width in pcbnew units value (0.5 inches)
+#define TEXTS_MIN_SIZE 50 // Minimum text size in Pcbnew units value (50 * 0.0001 mils)
+#define TEXTS_MAX_SIZE 10000 // Maximum text size in Pcbnew units value (1 inch) )
+#define TEXTS_MAX_WIDTH 5000 // Maximum text width in Pcbnew units value (0.5 inches)
/* Flag to force the SKETCH mode to display items (.m_Flags member) */
#define FORCE_SKETCH ( IS_DRAGGED | IN_EDIT )
diff --git a/pcbnew/pcbnew_config.cpp b/pcbnew/pcbnew_config.cpp
index cc19c3183b..093bd0271d 100644
--- a/pcbnew/pcbnew_config.cpp
+++ b/pcbnew/pcbnew_config.cpp
@@ -116,7 +116,7 @@ void PCB_EDIT_FRAME::Process_Config( wxCommandEvent& event )
break;
case ID_PREFERENCES_HOTKEY_SHOW_CURRENT_LIST:
- // Display current hotkey list for eeschema.
+ // Display current hotkey list for Pcbnew.
DisplayHotkeyList( this, g_Board_Editor_Hokeys_Descr );
break;
diff --git a/pcbnew/pcbnew_config.h b/pcbnew/pcbnew_config.h
index 91e7926448..fe3c33c927 100644
--- a/pcbnew/pcbnew_config.h
+++ b/pcbnew/pcbnew_config.h
@@ -1,6 +1,7 @@
-/************************************************************/
-/** pcbnew_config.h : configuration parameters for PCBNew **/
-/************************************************************/
+/**
+ * @file pcbnew_config.h
+ * @brief Cconfiguration parameters for Pcbnew.
+ */
#ifndef _PCBNEW_CONFIG_H_
#define _PCBNEW_CONFIG_H_
diff --git a/pcbnew/pcbnew_id.h b/pcbnew/pcbnew_id.h
index ad86a69660..e891d0c42f 100644
--- a/pcbnew/pcbnew_id.h
+++ b/pcbnew/pcbnew_id.h
@@ -6,9 +6,9 @@
/**
* Command IDs for the printed circuit board editor.
*
- * Please add IDs that are unique to the printed circuit board editor (PCBNew)
+ * Please add IDs that are unique to the printed circuit board editor (Pcbnew)
* here and not in the global id.h file. This will prevent the entire project
- * from being rebuilt when adding new commands to the PCBNew.
+ * from being rebuilt when adding new commands to the Pcbnew.
*/
enum pcbnew_ids
diff --git a/pcbnew/pcbplot.cpp b/pcbnew/pcbplot.cpp
index 1be1f43194..0742906735 100644
--- a/pcbnew/pcbplot.cpp
+++ b/pcbnew/pcbplot.cpp
@@ -791,7 +791,7 @@ void DIALOG_PLOT::Plot( wxCommandEvent& event )
}
// If no layer selected, we have nothing plotted.
- // Prompt user if it happens because he could think there is a bug in pcbnew.
+ // Prompt user if it happens because he could think there is a bug in Pcbnew.
if( !g_PcbPlotOptions.GetLayerSelection() )
DisplayError( this, _( "No layer selected" ) );
}
diff --git a/pcbnew/plotgerb.cpp b/pcbnew/plotgerb.cpp
index 94b8910a50..9a773d4efe 100644
--- a/pcbnew/plotgerb.cpp
+++ b/pcbnew/plotgerb.cpp
@@ -7,7 +7,7 @@
* filenames are like xxxc.PHO and use the RS274X format
* Units = inches
* format 3.4, Leading zero omitted, Abs format
- * format 3.4 uses the native pcbnew units (1/10000 inch).
+ * format 3.4 uses the native Pcbnew units (1/10000 inch).
*/
#include "fctsys.h"
@@ -35,7 +35,7 @@ bool PCB_BASE_FRAME::ExportToGerberFile( const wxString& aFullFileName, int aLay
wxPoint offset;
- /* Calculate scaling from pcbnew units (in 0.1 mil or 0.0001 inch) to gerber units */
+ /* Calculate scaling from Pcbnew units (in 0.1 mil or 0.0001 inch) to gerber units */
double scale = g_PcbPlotOptions.m_PlotScale;
if( aPlotOriginIsAuxAxis )
diff --git a/pcbnew/polygons_defs.h b/pcbnew/polygons_defs.h
index b39d9d4e6e..227b7dc152 100644
--- a/pcbnew/polygons_defs.h
+++ b/pcbnew/polygons_defs.h
@@ -1,6 +1,6 @@
/*
* file polygons_defs.h
- * definitions to use boost::polygon in Kicad
+ * definitions to use boost::polygon in KiCad.
*/
#ifndef _POLYGONS_DEFS_H_
diff --git a/pcbnew/printout_controler.cpp b/pcbnew/printout_controler.cpp
index b6fb838553..189a43995a 100644
--- a/pcbnew/printout_controler.cpp
+++ b/pcbnew/printout_controler.cpp
@@ -81,7 +81,7 @@ bool BOARD_PRINTOUT_CONTROLER::OnPrintPage( int page )
if( m_PrintParams.m_PrintMaskLayer == 0 )
return false;
- // In pcbnew we can want the layer EDGE always printed
+ // In Pcbnew we can want the layer EDGE always printed
if( m_PrintParams.m_Flags == 1 )
m_PrintParams.m_PrintMaskLayer |= EDGE_LAYER;
diff --git a/pcbnew/specctra.cpp b/pcbnew/specctra.cpp
index 46eba9c4b8..d1920db789 100644
--- a/pcbnew/specctra.cpp
+++ b/pcbnew/specctra.cpp
@@ -1,9 +1,9 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2011 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -75,7 +75,7 @@ void SPECCTRA_DB::buildLayerMaps( BOARD* aBoard )
{
// specctra wants top physical layer first, then going down to the
// bottom most physical layer in physical sequence.
- // @question : why does Kicad not display layers in that order?
+ // @question : why does KiCad not display layers in that order?
int layerCount = aBoard->GetCopperLayerCount();
layerIds.clear();
@@ -86,7 +86,7 @@ void SPECCTRA_DB::buildLayerMaps( BOARD* aBoard )
{
int kilayer = kiNdx>0 && kiNdx==layerCount-1 ? LAYER_N_FRONT : kiNdx;
- // establish bi-directional mapping between kicad's BOARD layer and PCB layer
+ // establish bi-directional mapping between KiCad's BOARD layer and PCB layer
pcbLayer2kicad[pcbNdx] = kilayer;
kicadLayer2pcb[kilayer] = pcbNdx;
@@ -3601,7 +3601,7 @@ PARSER::PARSER( ELEM* aParent ) :
via_rotate_first = true;
generated_by_freeroute = false;
- host_cad = "Kicad's PCBNEW";
+ host_cad = "KiCad's Pcbnew";
wxString msg = GetBuildVersion();
host_version = TO_UTF8(msg);
}
diff --git a/pcbnew/specctra.h b/pcbnew/specctra.h
index da494fe412..bfc8ba2f43 100644
--- a/pcbnew/specctra.h
+++ b/pcbnew/specctra.h
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2008 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -1887,7 +1887,7 @@ class PIN : public ELEM
std::string pin_id;
POINT vertex;
- int kiNetCode; ///< kicad netcode
+ int kiNetCode; ///< KiCad netcode
public:
@@ -3602,7 +3602,7 @@ class SPECCTRA_DB : public SPECCTRA_LEXER
/**
* Function buildLayerMaps
* creates a few data translation structures for layer name and number
- * mapping between the DSN::PCB structure and the kicad BOARD structure.
+ * mapping between the DSN::PCB structure and the KiCad BOARD structure.
* @param aBoard The BOARD to create the maps for.
*/
void buildLayerMaps( BOARD* aBoard );
@@ -3733,7 +3733,7 @@ class SPECCTRA_DB : public SPECCTRA_LEXER
/**
* Function makeVia
- * makes a round through hole PADSTACK using the given Kicad diameter in deci-mils.
+ * makes a round through hole PADSTACK using the given KiCad diameter in deci-mils.
* @param aCopperDiameter The diameter of the copper pad.
* @param aDrillDiameter The drill diameter, used on re-import of the session file.
* @param aTopLayer The DSN::PCB top most layer index.
@@ -3746,7 +3746,7 @@ class SPECCTRA_DB : public SPECCTRA_LEXER
/**
* Function makeVia
- * makes any kind of PADSTACK using the given Kicad SEGVIA.
+ * makes any kind of PADSTACK using the given KiCad SEGVIA.
* @param aVia The SEGVIA to build the padstack from.
* @return PADSTACK* - The padstack, which is on the heap only, user must save
* or delete it.
@@ -3787,7 +3787,7 @@ class SPECCTRA_DB : public SPECCTRA_LEXER
/**
* Function makeVIA
- * instantiates a Kicad SEGVIA on the heap and initializes it with internal
+ * instantiates a KiCad SEGVIA on the heap and initializes it with internal
* values consistent with the given PADSTACK, POINT, and netcode.
*/
SEGVIA* makeVIA( PADSTACK* aPadstack, const POINT& aPoint, int aNetCode ) throw( IO_ERROR );
@@ -3862,7 +3862,7 @@ public:
* Function LoadSESSION
* is a recursive descent parser for a SPECCTRA DSN "session" file.
* A session file is a file that is fed back from the router to the layout
- * tool (PCBNEW) and should be used to update a BOARD object with the new
+ * tool (Pcbnew) and should be used to update a BOARD object with the new
* tracks, vias, and component locations.
*
* @param filename The name of the dsn file to load.
diff --git a/pcbnew/specctra_export.cpp b/pcbnew/specctra_export.cpp
index d397db238a..388a35d905 100644
--- a/pcbnew/specctra_export.cpp
+++ b/pcbnew/specctra_export.cpp
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2008 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -59,7 +59,7 @@ using namespace DSN;
// Add .1 mil to the requested clearances as a safety margin.
// There has been disagreement about interpretation of clearance in the past
-// between Kicad and Freerouter, so keep this safetyMargin until the
+// between KiCad and Freerouter, so keep this safetyMargin until the
// disagreement is resolved and stable. Freerouter seems to be moving
// (protected) traces upon loading the DSN file, and even though it seems to sometimes
// add its own 0.1 to the clearances, I believe this is happening after
@@ -105,7 +105,7 @@ void PCB_EDIT_FRAME::ExportToSpecctra( wxCommandEvent& event )
SetLocaleTo_C_standard( ); // Switch the locale to standard C
- // DSN Images (=Kicad MODULES and pads) must be presented from the
+ // DSN Images (=KiCad MODULES and pads) must be presented from the
// top view. So we temporarily flip any modules which are on the back
// side of the board to the front, and record this in the MODULE's flag field.
db.FlipMODULEs( GetBoard() );
@@ -160,7 +160,7 @@ const KICAD_T SPECCTRA_DB::scanPADs[] = { TYPE_PAD, EOT };
/**
* Function scale
- * converts a distance from kicad units to our reported specctra dsn units:
+ * converts a distance from KiCad units to our reported specctra dsn units:
* 1/10000 inches (deci-mils) to mils. So the factor of 10 comes in.
*/
static inline double scale( int kicadDist )
@@ -181,7 +181,7 @@ static inline double mapY( int y )
/**
* Function mapPt
- * converts a Kicad point into a DSN file point. Kicad's BOARD coordinates
+ * converts a KiCad point into a DSN file point. Kicad's BOARD coordinates
* are in deci-mils (i.e. 1/10,000th of an inch) and we are exporting in units
* of mils, so we have to divide by 10.
*/
@@ -639,7 +639,7 @@ IMAGE* SPECCTRA_DB::makeIMAGE( BOARD* aBoard, MODULE* aModule )
path->SetAperture( scale( graphic->m_Width ) );
path->SetLayerId( "signal" );
- // Do the math using Kicad units, that way we stay out of the
+ // Do the math using KiCad units, that way we stay out of the
// scientific notation range of floating point numbers in the
// DSN file. We do not parse scientific notation in our own
// lexer/beautifier, and the spec is not clear that this is
@@ -956,7 +956,7 @@ void SPECCTRA_DB::FromBOARD( BOARD* aBoard ) throw( IO_ERROR )
{
// specctra wants top physical layer first, then going down to the
// bottom most physical layer in physical sequence.
- // @question : why does Kicad not display layers in that order?
+ // @question : why does KiCad not display layers in that order?
buildLayerMaps( aBoard );
@@ -1578,7 +1578,7 @@ void SPECCTRA_DB::RevertMODULEs( BOARD* aBoard )
if( !modulesAreFlipped )
return;
- // DSN Images (=Kicad MODULES and pads) must be presented from the
+ // DSN Images (=KiCad MODULES and pads) must be presented from the
// top view. Restore those that were flipped.
for( MODULE* module = aBoard->m_Modules; module; module = module->Next() )
{
diff --git a/pcbnew/specctra_import.cpp b/pcbnew/specctra_import.cpp
index ab5eed2781..92e2c02342 100644
--- a/pcbnew/specctra_import.cpp
+++ b/pcbnew/specctra_import.cpp
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2007-2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
@@ -140,17 +140,17 @@ namespace DSN {
/**
* Function scale
- * converts a session file distance to Kicad units of deci-mils.
+ * converts a session file distance to KiCad units of deci-mils.
* @param distance The session file length to convert.
* @param aResolution The session UNIT_RES which holds the engineering unit
* specifier
- * @return int - The Kicad length in deci-mils
+ * @return int - The KiCad length in deci-mils
*/
static int scale( double distance, UNIT_RES* aResolution )
{
double resValue = aResolution->GetValue();
- double factor; // multiply this times session value to get mils for Kicad.
+ double factor; // multiply this times session value to get mils for KiCad.
switch( aResolution->GetEngUnits() )
{
@@ -173,7 +173,7 @@ static int scale( double distance, UNIT_RES* aResolution )
}
// the factor of 10.0 is used to convert mils to deci-mils, the units
- // used within Kicad.
+ // used within KiCad.
factor *= 10.0;
int ret = wxRound( factor * distance / resValue );
@@ -184,10 +184,10 @@ static int scale( double distance, UNIT_RES* aResolution )
/**
* Function mapPt
* translates a point from the Specctra Session format coordinate system
- * to the Kicad coordinate system.
+ * to the KiCad coordinate system.
* @param aPoint The session point to translate
* @param aResolution - The amount to scale the point.
- * @return wxPoint - The Kicad coordinate system point.
+ * @return wxPoint - The KiCad coordinate system point.
*/
static wxPoint mapPt( const POINT& aPoint, UNIT_RES* aResolution )
{
@@ -231,7 +231,7 @@ SEGVIA* SPECCTRA_DB::makeVIA( PADSTACK* aPadstack, const POINT& aPoint, int aNet
int copperLayerCount = sessionBoard->GetCopperLayerCount();
- // The drill diameter is encoded in the padstack name if PCBNEW did the DSN export.
+ // The drill diameter is encoded in the padstack name if Pcbnew did the DSN export.
// It is in mils and is after the colon and before the last '_'
int drillStartNdx = aPadstack->padstack_id.find( ':' );
@@ -411,7 +411,7 @@ void SPECCTRA_DB::FromSESSION( BOARD* aBoard ) throw( IO_ERROR )
if( place->side == T_front )
{
- // convert from degrees to tenths of degrees used in Kicad.
+ // convert from degrees to tenths of degrees used in KiCad.
int orientation = (int) (place->rotation * 10.0);
if( module->GetLayer() != LAYER_N_FRONT )
{
diff --git a/pcbnew/specctra_test.cpp b/pcbnew/specctra_test.cpp
index 6e774e9bf8..eb17afca54 100644
--- a/pcbnew/specctra_test.cpp
+++ b/pcbnew/specctra_test.cpp
@@ -1,8 +1,8 @@
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2010 SoftPLC Corporation, Dick Hollenbeck <dick@softplc.com>
- * Copyright (C) 2010 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2010 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/surbrill.cpp b/pcbnew/surbrill.cpp
index 99fa56e39a..66cea682f7 100644
--- a/pcbnew/surbrill.cpp
+++ b/pcbnew/surbrill.cpp
@@ -106,7 +106,7 @@ int PCB_EDIT_FRAME::Select_High_Light( wxDC* DC )
// use this scheme because a pad is a higher priority than a track in the
// search, and finding a pad, instead of a track on a pad,
- // allows us to fire a message to eeschema.
+ // allows us to fire a message to Eeschema.
GENERAL_COLLECTORS_GUIDE guide = GetCollectorsGuide();
diff --git a/pcbnew/xchgmod.cpp b/pcbnew/xchgmod.cpp
index 3784331dc6..1580f81ed5 100644
--- a/pcbnew/xchgmod.cpp
+++ b/pcbnew/xchgmod.cpp
@@ -574,7 +574,7 @@ void DIALOG_EXCHANGE_MODULE::BrowseAndSelectFootprint( wxCommandEvent& event )
/**
* Function RecreateBOMFileFromBoard
* Recreates a .cmp file from the current loaded board
- * this is the same as created by cvpcb.
+ * this is the same as created by CvPcb.
* can be used if this file is lost
*/
void PCB_EDIT_FRAME::RecreateCmpFileFromBoard( wxCommandEvent& aEvent )
diff --git a/pcbnew/zones_by_polygon_fill_functions.cpp b/pcbnew/zones_by_polygon_fill_functions.cpp
index 2814450bf2..fa5744f4b2 100644
--- a/pcbnew/zones_by_polygon_fill_functions.cpp
+++ b/pcbnew/zones_by_polygon_fill_functions.cpp
@@ -3,10 +3,10 @@
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009 Jean-Pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr>
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/zones_functions_for_undo_redo.cpp b/pcbnew/zones_functions_for_undo_redo.cpp
index a3c3a0046e..b836664759 100644
--- a/pcbnew/zones_functions_for_undo_redo.cpp
+++ b/pcbnew/zones_functions_for_undo_redo.cpp
@@ -3,10 +3,10 @@
*/
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009 Jean-Pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr>
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/zones_functions_for_undo_redo.h b/pcbnew/zones_functions_for_undo_redo.h
index bcac6e46ff..7ef0ae2a9d 100644
--- a/pcbnew/zones_functions_for_undo_redo.h
+++ b/pcbnew/zones_functions_for_undo_redo.h
@@ -1,11 +1,12 @@
-/////////////////////////////////////////////////////////////////////////////
-// Name: zones_functions_for_undo_redo.h
-/////////////////////////////////////////////////////////////////////////////
+/**
+ * @file zones_functions_for_undo_redo.h
+ */
+
/*
- * This program source code file is part of KICAD, a free EDA CAD application.
+ * This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2009 Jean-Pierre Charras <jean-pierre.charras@gipsa-lab.inpg.fr>
- * Copyright (C) 2007 Kicad Developers, see change_log.txt for contributors.
+ * Copyright (C) 2007 KiCad Developers, see change_log.txt for contributors.
*
* This program is free software; you can redistribute it and/or
* modify it under the terms of the GNU General Public License
diff --git a/pcbnew/zones_test_and_combine_areas.cpp b/pcbnew/zones_test_and_combine_areas.cpp
index e3f4432a6e..6c53f74b38 100644
--- a/pcbnew/zones_test_and_combine_areas.cpp
+++ b/pcbnew/zones_test_and_combine_areas.cpp
@@ -260,7 +260,7 @@ int BOARD::TestAreaPolygon( ZONE_CONTAINER* CurrArea )
* @param aCurrArea = the zone to process
* @param bMessageBoxInt == true, shows message when clipping occurs.
* @param bMessageBoxArc == true, shows message when clipping can't be done due to arcs.
- * @param bRetainArcs = true to handle arcs (not really used in kicad)
+ * @param bRetainArcs = true to handle arcs (not really used in KiCad)
* @return:
* -1 if arcs intersect other sides, so polygon can't be clipped
* 0 if no intersecting sides