flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-04-27 02:55:44 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix doxygen warnings

Browse Source 
Fixes #188
This commit is contained in:
Mat Sutcliffe
2023-02-05 16:32:51 +00:00
committed by Lars Toenning
parent 5e5b3f830d
commit 7691e42a5b
175 changed files with 570 additions and 664 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
src/blackgui/components/audioadvanceddistributedcomponent.h
View File

@@ -43,8 +43,8 @@ namespace BlackGui::Components
//! Audio enable/disable
void toggleAudioEnableDisable();
//! Start/stop button
//! @{
//! Start/stop button
void setButtons();
void setButtons(int delayMs);
//! @}

8
src/blackgui/components/audiodevicevolumesetupcomponent.h
View File

@@ -40,24 +40,24 @@ namespace BlackGui::Components
//! Destructor
virtual ~CAudioDeviceVolumeSetupComponent() override;
//! Get input and output volume values
//! @{
//! Get input and output volume values
int getInValue(int from = BlackMisc::Audio::CSettings::InMin, int to = BlackMisc::Audio::CSettings::InMax) const;
int getOutValue(int from = BlackMisc::Audio::CSettings::OutMin, int to = BlackMisc::Audio::CSettings::OutMax) const;
int getOutValueCom1(int from = BlackMisc::Audio::CSettings::OutMin, int to = BlackMisc::Audio::CSettings::OutMax) const;
int getOutValueCom2(int from = BlackMisc::Audio::CSettings::OutMin, int to = BlackMisc::Audio::CSettings::OutMax) const;
//! @}
//! Set input and output volume values
//! @{
//! Set input and output volume values
void setInValue(int value, int from = BlackMisc::Audio::CSettings::InMin, int to = BlackMisc::Audio::CSettings::InMax);
void setOutValue(int value, int from = BlackMisc::Audio::CSettings::InMin, int to = BlackMisc::Audio::CSettings::InMax);
void setOutValueCom1(int value, int from = BlackMisc::Audio::CSettings::OutMin, int to = BlackMisc::Audio::CSettings::OutMax);
void setOutValueCom2(int value, int from = BlackMisc::Audio::CSettings::OutMin, int to = BlackMisc::Audio::CSettings::OutMax);
//! @}
//! Set input and output level values 0..1
//! @{
//! Set input and output level values 0..1
void setInLevel(double value);
void setOutLevel(double value);
//! @}
@@ -134,8 +134,8 @@ namespace BlackGui::Components
BlackMisc::Audio::CAudioDeviceInfo getSelectedInputDevice() const;
BlackMisc::Audio::CAudioDeviceInfo getSelectedOutputDevice() const;
//! Transmit and receive state
//! @{
//! Transmit and receive state
void setTransmitReceiveInUi(bool tx1, bool rec1, bool tx2, bool rec2, bool integrated);
void setTransmitReceiveInUiFromVoiceClient();
//! @}

2
src/blackgui/components/cgsourceselector.h
View File

@@ -30,8 +30,8 @@ namespace BlackGui::Components
//! Dtor
virtual ~CCGSourceSelector() override;
//! Get/set value
//! @{
//! Get/set value
BlackMisc::Simulation::Settings::CSimulatorSettings::CGSource getValue() const;
void setValue(const BlackMisc::Simulation::Settings::CSimulatorSettings &settings);
void setValue(BlackMisc::Simulation::Settings::CSimulatorSettings::CGSource source);

2
src/blackgui/components/cockpitcomcomponent.h
View File

@@ -55,8 +55,8 @@ namespace BlackGui::Components
//! \copydoc BlackGui::Components::CTransponderModeSelector::transponderStateIdentEnded
void transponderStateIdentEnded();
//! Request COM text messages
//! @{
//! Request COM text messages
void requestCom1TextMessage();
void requestCom2TextMessage();
//! @}

2
src/blackgui/components/cockpitcomponent.h
View File

@@ -64,8 +64,8 @@ namespace BlackGui
//! Toggle area on show/hide details
void toggleShowHideDetails(bool show, bool considerCurrentSize);
//! Request text message COM1
//! @{
//! Request text message COM1
void onRequestTextMessageCom1();
void onRequestTextMessageCom2();
//! @}

2
src/blackgui/components/dbmappingcomponentaware.h
View File

@@ -42,8 +42,8 @@ namespace BlackGui::Components
//! Copy assignment operator
CDbMappingComponentAware &operator =(const CDbMappingComponentAware &) = default;
//! Overlay messages
//! @{
//! Overlay messages
bool showMappingComponentOverlayMessage(const BlackMisc::CStatusMessage &message, int timeoutMs = -1);
bool showMappingComponentOverlayHtmlMessage(const BlackMisc::CStatusMessage &message, int timeoutMs = -1);
//! @}

2
src/blackgui/components/networkdetailscomponent.h
View File

@@ -85,8 +85,8 @@ namespace BlackGui::Components
//! Reset state
void resetState();
//! Selected server
//! @{
//! Selected server
bool isVatsimServerSelected() const;
bool isOtherServerSelected() const;
//! @}

2
src/blackgui/components/settingstextmessagestyle.h
View File

@@ -42,8 +42,8 @@ namespace BlackGui::Components
//! Style
void setStyle(const QString &style) { m_style = style; }
//! Font size
//! @{
//! Font size
void fontSizeMinus();
void fontSizePlus();
//! @}

4
src/blackgui/components/textmessagecomponent.h
View File

@@ -56,8 +56,8 @@ namespace BlackGui
//! \remark takes the messages, turns it into a ".msg" command, and emits it
bool handleGlobalCommandLineText(const QString &commandLine, const BlackMisc::CIdentifier &originator);
//! Font size
//! @{
//! Font size
void fontSizeMinus();
void fontSizePlus();
//! @}
@@ -169,8 +169,8 @@ namespace BlackGui
//! Network connected?
bool isNetworkConnected() const;
//! Show current frequencies
//! @{
//! Show current frequencies
void showCurrentFrequenciesFromCockpit();
void showCurrentFrequenciesFromCockpit(const BlackMisc::Simulation::CSimulatedAircraft &ownAircraft);
//! @}

2
src/blackgui/dockwidget.h
View File

@@ -151,8 +151,8 @@ namespace BlackGui
//! Top level has changed for given widget
void widgetTopLevelChanged(CDockWidget *, bool topLevel);
//! Font size signals
//! @{
//! Font size signals
void fontSizePlus();
void fontSizeMinus();
//! @}

2
src/blackgui/editors/cockpitcomform.h
View File

@@ -79,8 +79,8 @@ namespace BlackGui::Editors
//! GUI values changed
void changedCockpitValues(const BlackMisc::Simulation::CSimulatedAircraft &aircraft);
//! Request COM text messages
//! @{
//! Request COM text messages
void requestCom1TextMessage();
void requestCom2TextMessage();
//! @}

2
src/blackgui/editors/matchingform.h
View File

@@ -69,8 +69,8 @@ namespace BlackGui::Editors
//! Airline group changed
void onAirlineGroupChanged();
//! Reset
//! @{
//! Reset
void resetByAlgorithm();
void resetAll();
//! @}

2
src/blackgui/editors/pbhsform.h
View File

@@ -86,8 +86,8 @@ namespace BlackGui::Editors
//! Get heading angle
double getHeadingAngleDegrees() const;
//! Values changed from UI
//! @{
//! Values changed from UI
void bankSliderChanged(int value);
void pitchSliderChanged(int value);
void headingSliderChanged(int value);

2
src/blackgui/editors/situationform.h
View File

@@ -84,8 +84,8 @@ namespace BlackGui::Editors
//! Get pressure at mean sea level
double getBarometricPressureMslMillibar() const;
//! Values changed from UI
//! @{
//! Values changed from UI
void bankSliderChanged(int value);
void pitchSliderChanged(int value);
void headingSliderChanged(int value);

14
src/blackgui/guiapplication.h
View File

@@ -122,13 +122,11 @@ namespace BlackGui
//! Set window title
QString setExtraWindowTitle(const QString &extraInfo, QWidget *mainWindowWidget = mainApplicationWidget()) const;
//! \name print warning message
//! @{
//! print warning message
virtual bool cmdLineWarningMessage(const QString &text, const QString &informativeText) const override;
//! @}
//! \name print messages generated during parsing / cmd handling
//! @{
//! print messages generated during parsing / cmd handling
virtual bool cmdLineErrorMessage(const QString &text, const QString &informativeText = "", bool retry = false) const override;
virtual bool cmdLineErrorMessage(const BlackMisc::CStatusMessageList &msgs, bool retry = false) const override;
//! @}
@@ -136,8 +134,8 @@ namespace BlackGui
//! Window size reset mode set
bool isCmdWindowSizeResetSet() const;
//! \name direct access to main application window
//! @{
//! direct access to main application window
virtual bool displayInStatusBar(const BlackMisc::CStatusMessage &message) override;
virtual bool displayTextInConsole(const QString &text) override;
virtual bool displayInOverlayWindow(const BlackMisc::CStatusMessage &message, int timeOutMs = -1) override;
@@ -152,8 +150,8 @@ namespace BlackGui
//! Add a splash screen based on resource, empty means remove splash screen
void splashScreen(const QPixmap &pixmap);
//! Display splash screen messages if screen is available and visible
//! @{
//! Display splash screen messages if screen is available and visible
void displaySplashMessage(const BlackMisc::CStatusMessage &msg);
void displaySplashMessages(const BlackMisc::CStatusMessageList &msgs);
//! @}
@@ -242,8 +240,8 @@ namespace BlackGui
//! Toggle stay on top
bool toggleStayOnTop();
//! Window to front/back
//! @{
//! Window to front/back
void windowToFront();
void windowToBack();
void windowToFrontBackToggle();
@@ -327,8 +325,8 @@ namespace BlackGui
void alwaysOnTop(bool onTop);
protected:
//! \name print messages generated during parsing / cmd handling
//! @{
//! print messages generated during parsing / cmd handling
virtual void cmdLineHelpMessage() override;
virtual void cmdLineVersionMessage() const override;
//! @}

4
src/blackgui/guiutility.h
View File

@@ -85,8 +85,8 @@ namespace BlackGui
//! Orientation as string
static const QString &orientationAsString(Qt::ScreenOrientation orientation);
//! QRect, QSize as string
//! @{
//! QRect, QSize as string
static QString rectAsString(const QRect &rect);
static QString rectAsString(const QRectF &rect);
static QString sizeAsString(const QSize &size);
@@ -216,8 +216,8 @@ namespace BlackGui
//! Is top level window?
static bool isTopLevelWindow(QWidget *widget);
//! Check window type
//! @{
//! Check window type
static bool isQMainWindow(const QWidget *widget);
static bool isDialog(const QWidget *widget);
//! @}

4
src/blackgui/levelmeter.h
View File

@@ -31,8 +31,8 @@ namespace BlackGui
{
Q_OBJECT
//! Properties
//! @{
//! Properties
Q_PROPERTY(QColor lowColor READ getLowColor WRITE setLowColor)
Q_PROPERTY(QColor highColor READ getHighColor WRITE setHighColor)
Q_PROPERTY(QColor peakColor READ getPeakColor WRITE setPeakColor)
@@ -54,8 +54,8 @@ namespace BlackGui
//! Values
void levelChanged(double level);
//! Color properties
//! @{
//! Color properties
const QColor &getLowColor() const { return m_lowColor; }
const QColor &getHighColor() const { return m_highColor; }
const QColor &getPeakColor() const { return m_peakColor; }

2
src/blackgui/menus/fontmenus.h
View File

@@ -45,8 +45,8 @@ namespace BlackGui::Menus
QList<QShortcut *> getShortcuts() const;
signals:
//! Font size signals
//! @{
//! Font size signals
void fontSizePlus();
void fontSizeMinus();
//! @}

2
src/blackgui/menus/menuaction.h
View File

@@ -222,8 +222,8 @@ namespace BlackGui::Menus
static const QString &pathDockWidgetNested() { static const QString p("DockWidget.Nested"); return p; }
//! @}
//! Predefined sub sub menus
//! @{
//! Predefined sub sub menus
static const CMenuAction &subMenuDatabase();
static const CMenuAction &subMenuSimulator();
static const CMenuAction &subMenuConsolidateModels();

2
src/blackgui/models/actionitem.h
View File

@@ -34,8 +34,8 @@ namespace BlackGui::Models
//! Destructor
~CActionItem();
//! Not copyable
//! @{
//! Not copyable
CActionItem(const CActionItem &) = delete;
CActionItem &operator =(const CActionItem &) = delete;
//! @}

2
src/blackgui/models/columnformatters.h
View File

@@ -144,8 +144,8 @@ namespace BlackGui::Models
//! \copydoc CDefaultFormatter::decorationRole
virtual BlackMisc::CVariant decorationRole(const BlackMisc::CVariant &dataCVariant) const override;
//! Width/height
//! @{
//! Width/height
int getMaxWidth() const { return m_maxWidth; }
int getMaxHeight() const { return m_maxHeight; }
void setMaxWidth(int w) { m_maxWidth = w; }

2
src/blackgui/models/columns.h
View File

@@ -217,8 +217,8 @@ namespace BlackGui::Models
//! Clear
void clear() { m_columns.clear(); }
//! Set columns
//! @{
//! Set columns
void setColumns(const QList<CColumn> &columns) { m_columns = columns; }
void setColumns(const CColumns &columns) { m_columns = columns.m_columns; }
//! @}

2
src/blackgui/views/atcstationtreeview.h
View File

@@ -109,8 +109,8 @@ namespace BlackGui
//! Restore state
void restoreState();
//! Tune in/invoke
//! @{
//! Tune in/invoke
void tuneInAtcCom1();
void tuneInAtcCom2();
void requestTextMessage();

4
src/blackgui/views/simulatedaircraftview.h
View File

@@ -86,14 +86,14 @@ namespace BlackGui
//! Follow in simulator
void requestFollowInSimulator();
//! Enable/disable parts
//! @{
//! Enable/disable parts
void requestEnableParts();
void requestDisableParts();
//! @}
//! Enable/disable parts
//! @{
//! Enable/disable parts
void request0PitchOnGround();
void requestNullPitchOnGround();
//! @}

4
src/blackgui/views/viewbase.h
View File

@@ -504,8 +504,8 @@ namespace BlackGui
//! Settings have been changed
void settingsChanged();
//! Change selection modes
//! @{
//! Change selection modes
void setMultiSelection();
void setExtendedSelection();
void setSingleSelection();
@@ -519,8 +519,8 @@ namespace BlackGui
//! \remark Default implementation, can be overridden with specifi implementation
virtual QString getRememberedLastJsonDirectory() const;
//! Clipboard cut/copy/paste
//! @{
//! Clipboard cut/copy/paste
virtual void copy() = 0;
virtual void cut() = 0;
virtual void paste() = 0;