Minor coding style fixes in headers

This commit is contained in:
Simon Wells 2016-01-12 11:33:33 -05:00 committed by Chris Pavlina
parent 3a8e78c586
commit 09ef795a02
27 changed files with 125 additions and 83 deletions

View File

@ -1,6 +1,3 @@
#ifndef BIN_MOD_H_
#define BIN_MOD_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -24,6 +21,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef BIN_MOD_H_
#define BIN_MOD_H_
#if 0
#include <wx/filehistory.h> // wx 3.0:
#else

View File

@ -1,8 +1,3 @@
/**
* @file class_bitmap_base.h
*
*/
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -30,6 +25,10 @@
#ifndef _BITMAP_BASE_H_
#define _BITMAP_BASE_H_
/**
* @file class_bitmap_base.h
*
*/
class PLOTTER;

View File

@ -1,5 +1,3 @@
#ifndef TITLE_BLOCK_H_
#define TITLE_BLOCK_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -23,6 +21,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef CLASS_TITLE_BLOCK_H_
#define CLASS_TITLE_BLOCK_H_
#include <wx/string.h>
@ -162,4 +163,4 @@ private:
}
};
#endif // TITLE_BLOCK_H_
#endif // CLASS_TITLE_BLOCK_H_

View File

@ -1,5 +1,3 @@
#ifndef CONFIG_PARAMS_H_
#define CONFIG_PARAMS_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -25,6 +23,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef CONFIG_PARAMS_H_
#define CONFIG_PARAMS_H_
/**
* The common library
* @file config_params.h

View File

@ -1,6 +1,3 @@
/**
* @file convert_basic_shapes_to_polygon.h
*/
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -28,6 +25,10 @@
#ifndef CONVERT_BASIC_SHAPES_TO_POLYGON_H
#define CONVERT_BASIC_SHAPES_TO_POLYGON_H
/**
* @file convert_basic_shapes_to_polygon.h
*/
#include <vector>
#include <fctsys.h>

View File

@ -1,6 +1,3 @@
#ifndef DIALOG_SHIM_
#define DIALOG_SHIM_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -25,6 +22,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef DIALOG_SHIM_
#define DIALOG_SHIM_
#include <wx/dialog.h>
#include <hashtables.h>
#include <kiway_player.h>

View File

@ -1,5 +1,3 @@
#ifndef EDA_DRAW_FRAME_H_
#define EDA_DRAW_FRAME_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -25,6 +23,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef DRAW_FRAME_H_
#define DRAW_FRAME_H_
#include <wxstruct.h>
#include <kiway_player.h>
#include <climits>
@ -809,4 +810,4 @@ public:
DECLARE_EVENT_TABLE()
};
#endif // EDA_DRAW_FRAME_H_
#endif // DRAW_FRAME_H_

View File

@ -1,4 +1,4 @@
/* -*- c++ -*-
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 2015 Chris Pavlina <pavlina.chris@gmail.com>

View File

@ -1,4 +1,3 @@
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*

View File

@ -1,5 +1,3 @@
#ifndef HASHTABLES_H_
#define HASHTABLES_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -24,6 +22,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef HASHTABLES_H_
#define HASHTABLES_H_
#include <base_struct.h>
#include <wx/string.h>

View File

@ -1,5 +1,3 @@
#ifndef IMPORT_EXPORT_H_
#define IMPORT_EXPORT_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -24,6 +22,8 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef IMPORT_EXPORT_H_
#define IMPORT_EXPORT_H_
/// Macros which export functions from a DLL/DSO.
/// See: http://gcc.gnu.org/wiki/Visibility

View File

@ -1,4 +1,3 @@
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*

View File

@ -1,6 +1,3 @@
#ifndef KIFACE_I_H_
#define KIFACE_I_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -24,6 +21,8 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef KIFACE_I_H_
#define KIFACE_I_H_
#include <kiway.h>
#include <bin_mod.h>

View File

@ -1,5 +1,3 @@
#ifndef KIWAY_H_
#define KIWAY_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -24,6 +22,8 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef KIWAY_H_
#define KIWAY_H_
/*

View File

@ -1,5 +1,3 @@
#ifndef KIWAY_EXPRESS_H_
#define KIWAY_EXPRESS_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -24,6 +22,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef KIWAY_EXPRESS_H_
#define KIWAY_EXPRESS_H_
// @see http://wiki.wxwidgets.org/Custom_Events_Tutorial
#include <wx/wx.h>
@ -102,4 +103,3 @@ typedef void ( wxEvtHandler::*kiwayExpressFunction )( KIWAY_EXPRESS& );
#endif // KIWAY_EXPRESS_H_

View File

@ -1,7 +1,3 @@
#ifndef KIWAY_MGR_H_
#define KIWAY_MGR_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -26,6 +22,8 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef KIWAY_MGR_H_
#define KIWAY_MGR_H_
#include <kiway.h>
#include <boost/ptr_container/ptr_vector.hpp>

View File

@ -1,6 +1,3 @@
#ifndef KIWAY_PLAYER_H_
#define KIWAY_PLAYER_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -25,6 +22,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef KIWAY_PLAYER_H_
#define KIWAY_PLAYER_H_
#include <wx/frame.h>
#include <vector>
#include <wxstruct.h>

View File

@ -1,8 +1,3 @@
/**
* @file menus_helpers.h
* @brief Usefull macros and inline functions to create menus items
* in menubars or popup menus
*/
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -26,6 +21,14 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef MENUS_HELPERS_H_
#define MENUS_HELPERS_H_
/**
* @file menus_helpers.h
* @brief Usefull macros and inline functions to create menus items
* in menubars or popup menus
*/
#include <bitmaps.h>
@ -203,3 +206,5 @@ static inline wxMenuItem* AddMenuItem( wxMenu* aMenu,
return item;
};
#endif // MENUS_HELPERS_H_

View File

@ -1,6 +1,25 @@
/******************/
/* pad_shapes.h */
/******************/
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2014 KiCad Developers, see CHANGELOG.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
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef PAD_SHAPES_H_
#define PAD_SHAPES_H_

View File

@ -1,5 +1,3 @@
#ifndef PROJECT_H_
#define PROJECT_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -23,6 +21,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef PROJECT_H_
#define PROJECT_H_
#include <vector>
#include <wx/string.h>
#include <wx/filename.h>

View File

@ -1,6 +1,3 @@
#ifndef PTREE_H_
#define PTREE_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -25,6 +22,8 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef PTREE_H_
#define PTREE_H_
/*

View File

@ -1,13 +1,3 @@
#ifndef _REPORTER_H_
#define _REPORTER_H_
/**
* @file reporter.h
* @author Wayne Stambaugh
* @note A special thanks to Dick Hollenbeck who came up with the idea that inspired
* me to write this.
*/
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -32,6 +22,15 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef _REPORTER_H_
#define _REPORTER_H_
/**
* @file reporter.h
* @author Wayne Stambaugh
* @note A special thanks to Dick Hollenbeck who came up with the idea that inspired
* me to write this.
*/
class wxString;
class wxTextCtrl;

View File

@ -1,5 +1,3 @@
#ifndef RICHIO_H_
#define RICHIO_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -24,6 +22,8 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef RICHIO_H_
#define RICHIO_H_
// This file defines 3 classes useful for working with DSN text files and is named
// "richio" after its author, Richard Hollenbeck, aka Dick Hollenbeck.

View File

@ -1,7 +1,3 @@
/**
* @file trigo.h
*/
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -25,9 +21,13 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef TRIGO_H
#define TRIGO_H
/**
* @file trigo.h
*/
#include <math.h>
#include <wx/gdicmn.h> // For wxPoint

View File

@ -1,5 +1,3 @@
#ifndef UTF8_H_
#define UTF8_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -24,6 +22,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef UTF8_H_
#define UTF8_H_
#include <string>
#include <wx/string.h>

View File

@ -1,6 +1,25 @@
/***************/
/* worksheet.h */
/***************/
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
* Copyright (C) 1992-2014 KiCad Developers, see CHANGELOG.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
* as published by the Free Software Foundation; either version 2
* of the License, or (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, you may find one here:
* http://www.gnu.org/licenses/old-licenses/gpl-2.0.html
* or you may search the http://www.gnu.org website for the version 2 license,
* or you may write to the Free Software Foundation, Inc.,
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
// For page and paper size, values are in 1/1000 inch

View File

@ -1,6 +1,3 @@
#ifndef XATTR_H_
#define XATTR_H_
/*
* This program source code file is part of KiCad, a free EDA CAD application.
*
@ -25,6 +22,9 @@
* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA
*/
#ifndef XNODE_H_
#define XNODE_H_
#include <richio.h>
// quiet the deprecated warnings with 3 lines:
@ -97,4 +97,4 @@ public:
};
#endif // XATTR_H_
#endif // XNODE_H_