Doxygen style

This commit is contained in:
Mat Sutcliffe
2021-09-18 00:51:48 +01:00
parent 57d32da826
commit 312dec792b
66 changed files with 75 additions and 75 deletions

View File

@@ -19,7 +19,7 @@
namespace Ui { class CAboutHtmlComponent; }
namespace BlackGui::Components
{
/**
/*!
* Display the HTML info "about swift"
*/
class BLACKGUI_EXPORT CAboutHtmlComponent : public QFrame

View File

@@ -28,7 +28,7 @@ namespace BlackMisc
}
namespace BlackGui::Components
{
/**
/*!
* Dialog for CAircraftModelValidationComponent
* \remark aircraft model view has a simplified version BlackGui::Views::CAircraftModelValidationDialog
*/

View File

@@ -31,7 +31,7 @@ namespace BlackMisc
}
namespace BlackGui::Components
{
/**
/*!
* Handle validation result
*/
class BLACKGUI_EXPORT CAircraftModelValidationComponent : public COverlayMessagesFrame

View File

@@ -19,7 +19,7 @@
namespace Ui { class CAltitudeDialog; }
namespace BlackGui::Components
{
/**
/*!
* Dialog to get a correct altitude
*/
class CAltitudeDialog : public QDialog

View File

@@ -24,7 +24,7 @@
namespace Ui { class CCallsignCompleter; }
namespace BlackGui::Components
{
/**
/*!
* Completer for aircraft callsigns
*/
class BLACKGUI_EXPORT CCallsignCompleter : public QFrame

View File

@@ -20,7 +20,7 @@
namespace Ui { class CConfigSimulatorComponent; }
namespace BlackGui::Components
{
/**
/*!
* Simulator configuration
*/
class CConfigSimulatorComponent : public QFrame
@@ -55,7 +55,7 @@ namespace BlackGui::Components
QScopedPointer<Ui::CConfigSimulatorComponent> ui;
};
/**
/*!
* Wizard page for CConfigSimulatorComponent
*/
class CConfigSimulatorWizardPage : public QWizardPage

View File

@@ -18,7 +18,7 @@
namespace Ui { class CConfigurationWizard; }
namespace BlackGui::Components
{
/**
/*!
* Configure the most important settings
*/
class BLACKGUI_EXPORT CConfigurationWizard : public QWizard

View File

@@ -140,7 +140,7 @@ namespace BlackGui::Components
BlackMisc::CData<BlackCore::Data::TVatsimLastServer> m_lastVatsimServer { this }; //!< recently used VATSIM server
};
/**
/*!
* Wizard page for CCopyConfigurationComponent
*/
class CCopyConfigurationWizardPage : public QWizardPage

View File

@@ -21,7 +21,7 @@
namespace Ui { class CCopyModelsFromOtherSwiftVersionsComponent; }
namespace BlackGui::Components
{
/**
/*!
* Copy models from another swift version
*/
class CCopyModelsFromOtherSwiftVersionsComponent : public COverlayMessagesFrame
@@ -58,7 +58,7 @@ namespace BlackGui::Components
BlackMisc::Simulation::Data::CModelSetCaches m_modelSetCaches { false, this };
};
/**
/*!
* Wizard page for CCopyModelsFromOtherSwiftVersionsComponent
*/
class CCopyModelsFromOtherSwiftVersionsWizardPage : public QWizardPage

View File

@@ -17,7 +17,7 @@
namespace Ui { class CCopyModelsFromOtherSwiftVersionsDialog; }
namespace BlackGui::Components
{
/**
/*!
* Copy models from other swift versions as dialog
*/
class CCopyModelsFromOtherSwiftVersionsDialog : public QDialog

View File

@@ -41,7 +41,7 @@
namespace Ui { class CCopySettingsAndCachesComponent; }
namespace BlackGui::Components
{
/**
/*!
* Copy settings and caches
*/
class CCopySettingsAndCachesComponent : public COverlayMessagesFrame
@@ -140,7 +140,7 @@ namespace BlackGui::Components
BlackMisc::CData<BlackMisc::Simulation::Data::TLastModel> m_cacheLastAircraftModel { this }; //!< recently used aircraft model
};
/**
/*!
* Wizard page for CCopySettingsAndCaches
*/
class CCopySettingsAndCachesWizardPage : public QWizardPage

View File

@@ -18,7 +18,7 @@
namespace Ui { class CCoreSettingsDialog; }
namespace BlackGui::Components
{
/**
/*!
* Core / swift pilot client settings as Dialog
*/
class BLACKGUI_EXPORT CCoreSettingsDialog : public QDialog

View File

@@ -18,7 +18,7 @@
namespace Ui { class CCountrySelector; }
namespace BlackGui::Components
{
/**
/*!
* @brief Select a valid country
*/
class CCountrySelector : public QFrame

View File

@@ -33,7 +33,7 @@ namespace BlackGui::Components
class CDbModelComponent;
class CDbAircraftCategoryComponent;
/**
/*!
* Info area containing the DB data (models, liveries ...)
*/
class BLACKGUI_EXPORT CDataInfoAreaComponent :

View File

@@ -29,7 +29,7 @@ namespace BlackGui::Components
class CLogComponent;
class CDataSettingsComponent;
/**
/*!
* Main info area for data entry tool
*/
class BLACKGUI_EXPORT CDataMainInfoAreaComponent :

View File

@@ -22,7 +22,7 @@ namespace Ui { class CDataSettingsComponent; }
namespace BlackCore::Db { class CBackgroundDataUpdater; }
namespace BlackGui::Components
{
/**
/*!
* Settings
*/
class BLACKGUI_EXPORT CDataSettingsComponent : public COverlayMessagesFrame

View File

@@ -22,7 +22,7 @@
namespace Ui { class CDbAircraftCategoryComponent; }
namespace BlackGui::Components
{
/**
/*!
* DB aircraft categories
*/
class BLACKGUI_EXPORT CDbAircraftCategoryComponent :

View File

@@ -27,7 +27,7 @@ namespace BlackGui
namespace Views { class CAircraftIcaoCodeView; }
namespace Components
{
/**
/*!
* DB aircraft ICAO data
*/
class BLACKGUI_EXPORT CDbAircraftIcaoComponent :

View File

@@ -27,7 +27,7 @@ namespace BlackGui
namespace Views { class CAirlineIcaoCodeView; }
namespace Components
{
/**
/*!
* Airline ICAO code
*/
class BLACKGUI_EXPORT CDbAirlineIcaoComponent :

View File

@@ -23,7 +23,7 @@
namespace Ui { class CDbAutoSimulatorStashingComponent; }
namespace BlackGui::Components
{
/**
/*!
* Allows to automatically update models if found in own model set, but already existing
* for a sibling simulator (ie. FSX/P3D/FS9)
*/

View File

@@ -27,7 +27,7 @@ namespace BlackGui
namespace Views { class CDistributorView; }
namespace Components
{
/**
/*!
* Distributors
*/
class BLACKGUI_EXPORT CDbDistributorComponent :

View File

@@ -23,7 +23,7 @@
namespace Ui { class CDbLoadDataDialog; }
namespace BlackGui::Components
{
/**
/*!
* Load data from DB as dialog
*/
class BLACKGUI_EXPORT CDbLoadDataDialog : public QDialog

View File

@@ -25,7 +25,7 @@ namespace BlackMisc::Network { class CAuthenticatedUser; }
namespace Ui { class CDbLoginComponent; }
namespace BlackGui::Components
{
/**
/*!
* Login to DB
* \sa BlackCore::Db::CDatabaseAuthenticationService
*/

View File

@@ -26,7 +26,7 @@
namespace Ui { class CDbModelComponent; }
namespace BlackGui::Components
{
/**
/*!
* Database models. Those are the models loaaded from the DB.
*/
class BLACKGUI_EXPORT CDbModelComponent :

View File

@@ -17,7 +17,7 @@
namespace BlackGui::Components
{
/**
/*!
* Completer for model keys
*/
class CDbModelKeyCompleter : public QLineEdit

View File

@@ -25,7 +25,7 @@
namespace Ui { class CDownloadComponent; }
namespace BlackGui::Components
{
/**
/*!
* Download a file
*/
class BLACKGUI_EXPORT CDownloadComponent :

View File

@@ -21,7 +21,7 @@ namespace Ui { class CDownloadDialog; }
namespace BlackMisc::Network { class CRemoteFile; class CRemoteFileList; }
namespace BlackGui::Components
{
/**
/*!
* CDownloadComponent as dialog
*/
class BLACKGUI_EXPORT CDownloadDialog : public QDialog

View File

@@ -17,7 +17,7 @@
namespace Ui { class CFirstModelSetDialog; }
namespace BlackGui::Components
{
/**
/*!
* First model set dialog
*/
class CFirstModelSetDialog : public QDialog

View File

@@ -18,7 +18,7 @@
namespace Ui { class CInitialDataLoadComponent; }
namespace BlackGui::Components
{
/**
/*!
* Initial data load to prefill caches
* \remark Normally used in wizard
*/
@@ -46,7 +46,7 @@ namespace BlackGui::Components
QScopedPointer<Ui::CInitialDataLoadComponent> ui;
};
/**
/*!
* Wizard page for CInitialDataLoadComponent
*/
class CInitialDataLoadWizardPage : public QWizardPage

View File

@@ -19,7 +19,7 @@ namespace BlackGui::Components
class CInstallXSwiftBusComponent;
class CInstallFsxTerrainProbeComponent;
/**
/*!
* Simulator specific installation
*/
class CInstallSimulatorSpecificWizardPage : public COverlayMessagesWizardPage

View File

@@ -26,7 +26,7 @@
namespace Ui { class CInstallXSwiftBusComponent; }
namespace BlackGui::Components
{
/**
/*!
* Download and install XSwiftBus
*/
class CInstallXSwiftBusComponent :
@@ -101,7 +101,7 @@ namespace BlackGui::Components
void openDownloadDir();
};
/**
/*!
* Wizard page for CInstallXSwiftBusWizardPage
*/
class CInstallXSwiftBusWizardPage : public QWizardPage

View File

@@ -17,7 +17,7 @@
namespace Ui { class CInstallXSwiftBusDialog; }
namespace BlackGui::Components
{
/**
/*!
* CInstallXSwiftBusComponent as dialog
*/
class CInstallXSwiftBusDialog : public QDialog

View File

@@ -30,7 +30,7 @@ namespace Ui { class CInterpolationLogDisplay; }
namespace BlackCore { class CAirspaceMonitor; }
namespace BlackGui::Components
{
/**
/*!
* Display live data of interpolation
*/
class BLACKGUI_EXPORT CInterpolationLogDisplay :

View File

@@ -23,7 +23,7 @@ namespace BlackCore
namespace Ui { class CInterpolationLogDisplayDialog; }
namespace BlackGui::Components
{
/**
/*!
* CInterpolationLogDisplay as dialog
*/
class BLACKGUI_EXPORT CInterpolationLogDisplayDialog : public QDialog

View File

@@ -20,7 +20,7 @@
namespace Ui { class CLegalInfoComponent; }
namespace BlackGui::Components
{
/**
/*!
* swift legal information
*/
class CLegalInfoComponent : public COverlayMessagesFrame
@@ -54,7 +54,7 @@ namespace BlackGui::Components
BlackMisc::CSetting<BlackCore::Application::TCrashDumpSettings> m_crashDumpSettings { this };
};
/**
/*!
* Wizard page for CLegalInfoComponent
*/
class CLegalInfoWizardPage : public QWizardPage

View File

@@ -17,7 +17,7 @@
namespace Ui { class CModelConverterXSetupComponent; }
namespace BlackGui::Components
{
/**
/*!
* Setup to start ModelConverterX
*/
class CModelConverterXSetupComponent : public QFrame

View File

@@ -18,7 +18,7 @@
namespace Ui { class COtherSwiftVersionsComponent; }
namespace BlackGui::Components
{
/**
/*!
* Overview about other "swift" versions
*/
class COtherSwiftVersionsComponent : public QFrame

View File

@@ -17,7 +17,7 @@
namespace Ui { class COtherSwiftVersionsDialog; }
namespace BlackGui::Components
{
/**
/*!
* COtherVersionsComponent as dialog
*/
class COtherSwiftVersionsDialog : public QDialog

View File

@@ -18,7 +18,7 @@
namespace Ui { class CScaleScreenFactor; }
namespace BlackGui::Components
{
/**
/*!
* UI to scale screen factor
*/
class BLACKGUI_EXPORT CScaleScreenFactor : public QFrame

View File

@@ -66,7 +66,7 @@ namespace BlackGui::Components
BlackCore::CActionBind m_action { "/Test/Message", BlackMisc::CIcons::StandardIconWrench16, this, &CSettingsHotkeyComponent::hotkeySlot };
};
/**
/*!
* Wizard page for CConfigSimulatorComponent
*/
class CConfigHotkeyWizardPage : public QWizardPage

View File

@@ -18,7 +18,7 @@
namespace Ui { class CSettingsSwiftPlugin; }
namespace BlackGui::Components
{
/**
/*!
* Settings for the swift pseudo driver
*/
class BLACKGUI_EXPORT CSettingsSwiftPlugin : public QFrame

View File

@@ -19,7 +19,7 @@ namespace BlackGui::Components
{
class CCopyModelsFromOtherSwiftVersionsDialog;
/**
/*!
* Setup dialog, if something goes wrong allows to copy bootstrap file
*/
class CSetupLoadingDialog : public QDialog

View File

@@ -17,7 +17,7 @@
namespace Ui { class CStringListDialog; }
namespace BlackGui::Components
{
/**
/*!
* Select from a list of string
*/
class CStringListDialog : public QDialog

View File

@@ -20,7 +20,7 @@ namespace Ui { class CTransponderModeComponent; }
namespace BlackMisc { class CIdentifier; namespace Simulation { class CSimulatedAircraft; }}
namespace BlackGui::Components
{
/**
/*!
* Small component to display XPDR mode
*/
class CTransponderModeComponent : public QFrame, BlackMisc::CIdentifiable

View File

@@ -25,7 +25,7 @@ namespace BlackGui::Components
class CInstallXSwiftBusDialog;
class CDownloadDialog;
/**
/*!
* Update info (distributions, artifacts etc.)
*/
class BLACKGUI_EXPORT CUpdateInfoComponent : public QFrame

View File

@@ -18,7 +18,7 @@
namespace Ui { class CUpdateInfoDialog; }
namespace BlackGui::Components
{
/**
/*!
* Download and install swift
*/
class BLACKGUI_EXPORT CUpdateInfoDialog : public QDialog

View File

@@ -302,7 +302,7 @@ namespace BlackGui
this->setFrameless(!frameless);
}
/**
/*!
void CDockWidget::toggleFramelessDeferred(int delayMs)
{
QPointer<CDockWidget> myself(this);

View File

@@ -19,7 +19,7 @@
namespace Ui { class CAircraftModelForm; }
namespace BlackGui::Editors
{
/**
/*!
* Combined form of Livery, ICAOs, distributor
*/
class CAircraftModelForm : public CForm

View File

@@ -21,7 +21,7 @@ class QWidget;
namespace Ui { class CAircraftPartsForm; }
namespace BlackGui::Editors
{
/**
/*!
* Edit and set aircraft parts
*/
class BLACKGUI_EXPORT CAircraftPartsForm : public CForm

View File

@@ -19,7 +19,7 @@
namespace Ui { class CCoordinateForm; }
namespace BlackGui::Editors
{
/**
/*!
* Select / enter a geo position
*/
class BLACKGUI_EXPORT CCoordinateForm : public CForm

View File

@@ -20,7 +20,7 @@
namespace Ui { class CSituationForm; }
namespace BlackGui::Editors
{
/**
/*!
* Selector / entry
*/
class BLACKGUI_EXPORT CSituationForm : public CForm

View File

@@ -15,7 +15,7 @@
namespace BlackGui
{
/**
/*!
* Push button with elided text
* \remark based on http://doc.qt.io/qt-5/qtwidgets-widgets-elidedlabel-example.html
*/

View File

@@ -23,7 +23,7 @@
namespace BlackGui::Graphs
{
/**
/*!
* For axis labels
*/
class CTextScaleDraw: public QwtScaleDraw
@@ -45,7 +45,7 @@ namespace BlackGui::Graphs
QStringList m_labels;
};
/**
/*!
* Bar chart, modified version of QWT examples
*/
class BLACKGUI_EXPORT CBarChart: public QwtPlot

View File

@@ -21,7 +21,7 @@ namespace BlackGui
{
class CPluginConfigWindow;
/**
/*!
* The interface for the plugin config.
* The plugin config plugin is always called from the GUI process in order
* to make it possible to create a config window.

View File

@@ -18,7 +18,7 @@ class QShowEvent;
namespace BlackGui
{
/**
/*!
* Base class for plugin config window.
*/
class BLACKGUI_EXPORT CPluginConfigWindow : public COverlayMessagesFrame

View File

@@ -56,7 +56,7 @@ namespace BlackGui
QStringListModel *getCompleterModel() const;
};
/**
/*!
* Utility functions
*/
class BLACKGUI_EXPORT CompleterUtils

View File

@@ -17,7 +17,7 @@ class QWidget;
namespace BlackGui
{
/**
/*!
* Enable / disable UI depending on how many swift applications are running
*/
class CSingleApplicationUi

View File

@@ -21,7 +21,7 @@
namespace BlackGui
{
/**
/*!
* Own splash screen
*/
class CSplashScreen : public QSplashScreen

View File

@@ -18,7 +18,7 @@
namespace Ui { class CAircraftModelValidationDialog; }
namespace BlackGui::Views
{
/**
/*!
* Model validation
* \remark there is also a more specific validation version BlackGui::Components::CAircraftModelSetValidationDialog
*/