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

@@ -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:
 

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"

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)
  */

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

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"

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

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

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] =

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

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

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 );

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"

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"

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"

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;

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 )
 {

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

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

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 )

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

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 )

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

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 ),
 

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)

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