Formatting, headers, Doxygen

This commit is contained in:
Klaus Basan
2014-08-02 18:56:40 +02:00
parent f9eca1f3a5
commit 6d5461cff8
52 changed files with 533 additions and 405 deletions

View File

@@ -23,7 +23,6 @@ namespace BlackGui
{
namespace Components
{
//! Aircraft widget
class CAircraftComponent : public QTabWidget, public CRuntimeBasedComponent
{

View File

@@ -7,11 +7,11 @@
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKGUI_FLIGHTPLANCOMPONENT_H
#define BLACKGUI_FLIGHTPLANCOMPONENT_H
//! \file
#include "blackgui/components/runtimebasedcomponent.h"
#include "blackmisc/avaircraft.h"
#include "blackmisc/avflightplan.h"

View File

@@ -7,11 +7,11 @@
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKGUI_MAININFOAREACOMPONENT_H
#define BLACKGUI_MAININFOAREACOMPONENT_H
//! \file
#include "../dockwidgetinfoarea.h"
#include "atcstationcomponent.h"
#include "aircraftcomponent.h"

View File

@@ -7,11 +7,11 @@
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKGUI_SIMULATORCOMPONENT_H
#define BLACKGUI_SIMULATORCOMPONENT_H
//! \file
#include "runtimebasedcomponent.h"
#include <QTabWidget>

View File

@@ -7,11 +7,11 @@
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKGUI_DOCKWIDGET_H
#define BLACKGUI_DOCKWIDGET_H
//! \file
#include <QDockWidget>
#include <QTabWidget>
#include <QMenu>
@@ -59,6 +59,8 @@ namespace BlackGui
//! Show the window title when docked
void showTitleWhenDocked(bool show);
public slots:
//! Toggle floating
void toggleFloating();

View File

@@ -1,5 +1,5 @@
/* Copyright (C) 2013
* Swift Project Community / Contributors
* swift Project Community / Contributors
*
* This file is part of swift Project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of Swift Project,

View File

@@ -7,17 +7,17 @@
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKGUI_DOCKWIDGETINFOAREA_H
#define BLACKGUI_DOCKWIDGETINFOAREA_H
//! \file
#include "blackgui/dockwidget.h"
namespace BlackGui
{
//! Class for dock widgets in the info area, containing some specialized functionality
//! Class for dock widgets serving as info bar
class CDockWidgetInfoArea : public CDockWidget
{
Q_OBJECT
@@ -29,7 +29,6 @@ namespace BlackGui
protected:
//! Contribute to menu
virtual void addToContextMenu(QMenu *contextMenu) const override;
};
} // namespace

View File

@@ -1,17 +1,20 @@
/***************************************************************************
* Copyright (C) 2010 by P. Sereno *
* http://www.sereno-online.com *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Lesser General Public License *
* version 2.1 as published by the Free Software Foundation *
* *
* 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 Lesser General Public License for more details. *
* http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. *
***************************************************************************/
/* Copyright (C) 2013
* swift Project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of Swift Project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*
* Copyright (C) 2010 by P. Sereno
* http://www.sereno-online.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* version 2.1 as published by the Free Software Foundation
*/
#include "led.h"
#include <QColor>
#include <QtGlobal>
@@ -20,7 +23,6 @@
#include <QtSvg>
#include <QSvgRenderer>
#include "led.h"
namespace BlackGui
{

View File

@@ -1,17 +1,20 @@
/***************************************************************************
* Copyright (C) 2010 by P. Sereno *
* http://www.sereno-online.com *
* *
* This program is free software; you can redistribute it and/or modify *
* it under the terms of the GNU Lesser General Public License *
* version 2.1 as published by the Free Software Foundation *
* *
* 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 Lesser General Public License for more details. *
* http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. *
***************************************************************************/
/* Copyright (C) 2013
* swift Project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of Swift Project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*
* Copyright (C) 2010 by P. Sereno
* http://www.sereno-online.com
*
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU Lesser General Public License
* version 2.1 as published by the Free Software Foundation
*/
//! \file
#ifndef BLACKGUI_LED_H
#define BLACKGUI_LED_H

View File

@@ -1,7 +1,11 @@
/* Copyright (C) 2013 VATSIM Community / contributors
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* Copyright (C) 2013
* swift Project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of Swift Project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
#include "atcstationlistmodel.h"
#include "blackmisc/blackmiscfreefunctions.h"

View File

@@ -1,11 +1,13 @@
/* Copyright (C) 2013 VATSIM Community / contributors
* This Source Code Form is subject to the terms of the Mozilla Public
* License, v. 2.0. If a copy of the MPL was not distributed with this
* file, You can obtain one at http://mozilla.org/MPL/2.0/. */
/* Copyright (C) 2013
* swift Project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of Swift Project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
/*!
\file
*/
//! \file
#ifndef BLACKGUI_ATCLISTMODEL_H
#define BLACKGUI_ATCLISTMODEL_H

View File

@@ -7,11 +7,11 @@
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKGUI_COLUMNS_H
#define BLACKGUI_COLUMNS_H
//! \file
#include "blackmisc/valueobject.h" // for qHash overload, include before Qt stuff due GCC issue
#include "blackmisc/collection.h"
#include <QObject>

View File

@@ -120,7 +120,6 @@ namespace BlackGui
return this->m_container.size();
}
/*
* Update
*/

View File

@@ -7,6 +7,8 @@
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKGUI_LISTMODELBASE_H
#define BLACKGUI_LISTMODELBASE_H
@@ -118,7 +120,7 @@ namespace BlackGui
//! \copydoc QAbstractTableModel::flags
Qt::ItemFlags flags(const QModelIndex &index) const override;
//! Update by new list
//! Update by new container
virtual int update(const ContainerType &container);
//! Update single element

View File

@@ -1,3 +1,12 @@
/* Copyright (C) 2013
* swift Project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of Swift Project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
#include "selcalcodeselector.h"
#include "ui_selcalcodeselector.h"
#include "blackmisc/avselcal.h"

View File

@@ -1,3 +1,14 @@
/* Copyright (C) 2013
* swift Project Community / Contributors
*
* This file is part of swift project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of Swift Project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKGUI_SELCALCODESELECTOR_H
#define BLACKGUI_SELCALCODESELECTOR_H
@@ -7,9 +18,7 @@ namespace Ui { class CSelcalCodeSelector; }
namespace BlackGui
{
/*!
* \brief SELCAL mode selector
*/
//! SELCAL mode selector
class CSelcalCodeSelector : public QFrame
{
Q_OBJECT

View File

@@ -7,11 +7,11 @@
* contained in the LICENSE file.
*/
//! \file
#ifndef BLACKGUI_NAMEVARIANTPAIRVIEW_H
#define BLACKGUI_NAMEVARIANTPAIRVIEW_H
//! \file
#include "viewbase.h"
#include "../models/namevariantpairlistmodel.h"