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

[doxygen] Fix broken groupings

Browse Source
This commit is contained in:
Mat Sutcliffe
2020-08-01 19:08:08 +01:00
parent faf7f2a2cf
commit 2ae0352e75
115 changed files with 474 additions and 248 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

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

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

@@ -42,17 +42,20 @@ namespace BlackGui
//! 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;
//! @}
//! 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::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);
//! @}
@@ -127,7 +130,8 @@ namespace BlackGui
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();
//! @}

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

@@ -32,7 +32,8 @@ namespace BlackGui
//! 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);

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

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

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

@@ -64,7 +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();
//! @}

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

@@ -44,7 +44,8 @@ namespace BlackGui
//! 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);
//! @}

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

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

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

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

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

@@ -55,7 +55,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();
//! @}
@@ -167,7 +168,8 @@ namespace BlackGui
//! Network connected?
bool isNetworkConnected() const;
//! Show current frequencies @{
//! Show current frequencies
//! @{
void showCurrentFrequenciesFromCockpit();
void showCurrentFrequenciesFromCockpit(const BlackMisc::Simulation::CSimulatedAircraft &ownAircraft);
//! @}

3
src/blackgui/dockwidget.h
View File

@@ -151,7 +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();
//! @}

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

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

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

@@ -71,10 +71,11 @@ namespace BlackGui
//! Airline group changed
void onAirlineGroupChanged();
//! Reset @{
//! Reset
//! @{
void resetByAlgorithm();
void resetAll();
//! }
//! @}
//! Directory browser
void fileDialog();

4
src/blackgui/editors/ownmodelsetform.h
View File

@@ -81,9 +81,9 @@ namespace BlackGui
bool hasDistributorPreferences() const;
//! \name Form functions, here not used
//! \@{
//! @{
virtual void setReadOnly(bool readOnly) override { Q_UNUSED(readOnly); }
//! \@}
//! @}
signals:
//! Simulator changed

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

@@ -88,7 +88,8 @@ namespace BlackGui
//! 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);

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

@@ -86,7 +86,8 @@ namespace BlackGui
//! 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);

6
src/blackgui/guiapplication.h
View File

@@ -155,7 +155,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);
//! @}
@@ -244,7 +245,8 @@ namespace BlackGui
//! Toggle stay on top
bool toggleStayOnTop();
//! Window to front/back @{
//! Window to front/back
//! @{
void windowToFront();
void windowToBack();
void windowToFrontBackToggle();

6
src/blackgui/guiutility.h
View File

@@ -85,7 +85,8 @@ namespace BlackGui
//! Orientation as string
static const QString &orientationAsString(Qt::ScreenOrientation orientation);
//! QRect, QSize as string @{
//! QRect, QSize as string
//! @{
static const QString rectAsString(const QRect &rect);
static const QString rectAsString(const QRectF &rect);
static const QString sizeAsString(const QSize &size);
@@ -215,7 +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);
//! @}

6
src/blackgui/levelmeter.h
View File

@@ -31,7 +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)
@@ -53,7 +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; }

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

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

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

@@ -218,7 +218,7 @@ namespace BlackGui
static const QString &pathDockWidgetNested() { static const QString p("DockWidget.Nested"); return p; }
//! @}
//! \name Predefined sub sub menus
//! Predefined sub sub menus
//! @{
static const CMenuAction &subMenuDatabase();
static const CMenuAction &subMenuSimulator();

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

@@ -145,7 +145,8 @@ namespace BlackGui
//! \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; }

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

@@ -219,7 +219,8 @@ namespace BlackGui
//! 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; }
//! @}

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

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

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

@@ -89,12 +89,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();
//! @}

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

@@ -504,7 +504,8 @@ namespace BlackGui
//! Settings have been changed
void settingsChanged();
//! \name Change selection modes @{
//! Change selection modes
//! @{
void setMultiSelection();
void setExtendedSelection();
void setSingleSelection();
@@ -518,7 +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;