flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-04-09 21:45:34 +08:00
Code Issues Packages Projects Releases Wiki Activity

Renaming, header, Doxygen, formatting (during refs #314)

Browse Source
This commit is contained in:
Klaus Basan
2014-08-23 23:25:42 +02:00
parent f311582c28
commit 3fb5087ea8
295 changed files with 2736 additions and 3031 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
src/blacksim/fsx/fsx.h
View File

@@ -1,8 +1,17 @@
/* 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.
*/
#ifndef FSX_NAMESPACES_H
#define FSX_NAMESPACES_H
// just a dummy header, namespace documentation will go here
/*! \file */
//! \file
/*!
* \namespace FSX

14
src/blacksim/fsx/fsxsimulatorsetup.h
View File

@@ -1,7 +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
#ifndef BLACKSIM_FSX_SIMSETUP_H
#define BLACKSIM_FSX_SIMSETUP_H

35
src/blacksim/fsx/simconnectutilities.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 BLACKSIM_FSX_SIMCONNECTUTILITIES_H
#define BLACKSIM_FSX_SIMCONNECTUTILITIES_H
@@ -13,30 +24,26 @@
#endif
#include <Windows.h>
#else
typedef unsigned long DWORD;
typedef unsigned long DWORD; //!< Fake Windows DWORD
#endif
namespace BlackSim
{
namespace Fsx
{
//! \brief Utilities for SimConnect
//! Utilities for SimConnect
class CSimConnectUtilities : public QObject
{
Q_OBJECT
Q_ENUMS(SIMCONNECT_EXCEPTION)
Q_ENUMS(SIMCONNECT_SURFACE)
private:
//! \brief CSimConnect
CSimConnectUtilities();
public:
//! Path to local config file
static QString getLocalSimConnectCfgFilename();
/*!
* \brief Content for FSX simconnect.cfg file
* Content for FSX simconnect.cfg file
* \param ip IP address of FSX
* \param port Port of FSX (e.g. 500)
* \return content for simconnect.cfg
@@ -44,7 +51,7 @@ namespace BlackSim
static QString simConnectCfg(const QString &ip, quint16 port = 500);
/*!
* \brief Create a FSX simconnect.cfg file
* Create a FSX simconnect.cfg file
* \param fileName and path
* \param ip IP address of FSX
* \param port Port of FSX (e.g. 500)
@@ -53,14 +60,14 @@ namespace BlackSim
static bool writeSimConnectCfg(const QString &fileName, const QString &ip, quint16 port = 500);
/*!
* \brief Resolve SimConnect exception (based on Qt metadata).
* Resolve SimConnect exception (based on Qt metadata).
* \param id enum element
* \return enum element's name
*/
static const QString simConnectExceptionToString(const DWORD id);
/*!
* \brief Resolve SimConnect surface (based on Qt metadata).
* Resolve SimConnect surface (based on Qt metadata).
* \param type enum element
* \param beautify remove "_"
* \return
@@ -141,17 +148,21 @@ namespace BlackSim
SIMCONNECT_EXCEPTION_OBJECT_SCHEDULE
};
//! \brief Register metadata
//! Register metadata
static void registerMetadata();
private:
/*!
* \brief Resolve enum value to its cleartext (based on Qt metadata).
* Resolve enum value to its cleartext (based on Qt metadata).
* \param id enum element
* \param enumName name of the resolved enum
* \return enum element's name
*/
static const QString resolveEnumToString(const DWORD id, const char *enumName);
//! Hidden constructor
CSimConnectUtilities();
};
}
}