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

Fix doxygen warnings

Browse Source 
Fixes #188
This commit is contained in:
Lars Toenning
2023-04-02 13:21:39 +02:00
parent 7691e42a5b
commit 72ac4e6b47
50 changed files with 1008 additions and 93 deletions
Download Patch File Download Diff File Expand all files Collapse all files

14
src/blackgui/components/navigatordialog.h
View File

@@ -81,12 +81,26 @@ namespace BlackGui::Components
protected:
//! \name Base class events
//! @{
//! \copydoc QDialog::mouseMoveEvent
virtual void mouseMoveEvent(QMouseEvent *event) override;
//! \copydoc QDialog::mousePressEvent
virtual void mousePressEvent(QMouseEvent *event) override;
//! \copydoc QDialog::mouseReleaseEvent
virtual void mouseReleaseEvent(QMouseEvent *event) override;
//! \copydoc QDialog::changeEvent
virtual void changeEvent(QEvent *evt) override;
//! \copydoc CEnableForFramelessWindow::windowFlagsChanged
virtual void windowFlagsChanged() override;
//! \copydoc QDialog::paintEvent
virtual void paintEvent(QPaintEvent *event) override;
//! \copydoc QDialog::enterEvent
virtual void enterEvent(QEvent *event) override;
//! @}

1
src/blackgui/eventfilter.h
View File

@@ -21,6 +21,7 @@ namespace BlackGui
Q_OBJECT
public:
//! \copydoc QObject::QObject
using QObject::QObject;
//! Not allowed characters

24
src/blackgui/models/listmodelbase.h
View File

@@ -46,19 +46,39 @@ namespace BlackGui::Models
//! \name Functions from QStandardItemModel
//! @{
//! \copydoc QStandardItemModel::data
virtual QVariant data(const QModelIndex &index, int role) const override;
//! \copydoc QStandardItemModel::setData
virtual bool setData(const QModelIndex &index, const QVariant &value, int role = Qt::EditRole) final override;
//! \copydoc QStandardItemModel::mimeData
virtual QMimeData *mimeData(const QModelIndexList &indexes) const final override;
//! \copydoc QStandardItemModel::sort
virtual void sort(int column, Qt::SortOrder order) final override;
//! \copydoc QStandardItemModel::rowCount
virtual int rowCount(const QModelIndex &parentIndex = QModelIndex()) const final override;
//! \copydoc QStandardItemModel::canDropMimeData
virtual bool canDropMimeData(const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const final override;
//! \copydoc QStandardItemModel::dropMimeData
virtual bool dropMimeData(const QMimeData *mimeData, Qt::DropAction action, int row, int column, const QModelIndex &parent) final override;
//! @}
//! \name Functions from CListModelBaseNonTemplate
//! @{
//! \copydoc BlackGui::Models::CListModelBaseNonTemplate::toJson
virtual QJsonObject toJson(bool selectedOnly = false) const override;
//! \copydoc BlackGui::Models::CListModelBaseNonTemplate::toJsonString
virtual QString toJsonString(QJsonDocument::JsonFormat format = QJsonDocument::Indented, bool selectedOnly = false) const override;
//! \copydoc BlackGui::Models::CListModelBaseNonTemplate::isOrderable
virtual bool isOrderable() const override;
//! @}
@@ -169,7 +189,11 @@ namespace BlackGui::Models
//! \name Base class overrides
//! @{
//! \copydoc BlackGui::Models::CListModelBaseNonTemplate::onDataChanged
virtual void onDataChanged(const QModelIndex &topLeft, const QModelIndex &bottomLeft, const QVector<int> &roles) override;
//! \copydoc BlackGui::Models::CListModelBaseNonTemplate::onDataChanged
virtual void onChangedDigest() override;
//! @}

15
src/blackgui/models/listmodelbasenontemplate.h
View File

@@ -50,13 +50,28 @@ namespace BlackGui::Models
//! \name Functions from QStandardItemModel
//! @{
//! \copydoc QStandardItemModel::columnCount
virtual int columnCount(const QModelIndex &modelIndex = QModelIndex()) const final override;
//! \copydoc QStandardItemModel::headerData
virtual QVariant headerData(int section, Qt::Orientation orientation, int role) const final override;
//! \copydoc QStandardItemModel::index
virtual QModelIndex index(int row, int column, const QModelIndex &parent = QModelIndex()) const final override;
//! \copydoc QStandardItemModel::parent
virtual QModelIndex parent(const QModelIndex &child) const final override;
//! \copydoc QStandardItemModel::flags
virtual Qt::ItemFlags flags(const QModelIndex &index) const final override;
//! \copydoc QStandardItemModel::supportedDragActions
virtual Qt::DropActions supportedDragActions() const final override;
//! \copydoc QStandardItemModel::supportedDropActions
virtual Qt::DropActions supportedDropActions() const final override;
//! \copydoc QStandardItemModel::mimeTypes
virtual QStringList mimeTypes() const final override;
//! @}

4
src/blackgui/models/listmodeldbobjects.h
View File

@@ -101,7 +101,11 @@ namespace BlackGui::Models
//! \name specialized BlackGui::Models::CListModelDbObjects functions for ordering
//! @{
using COrderableListModelDbObjects::CListModelDbObjects::update;
//! \copydoc BlackGui::Models::CListModelDbObjects::update
virtual int update(const ContainerType &container, bool sort) override;
//! \copydoc BlackGui::Models::CListModelDbObjects::moveItems
virtual void moveItems(const ContainerType &items, int position) override;
//! @}

8
src/blackgui/views/aircraftmodelview.h
View File

@@ -139,9 +139,17 @@ namespace BlackGui
//! \name View base class overrides
//! @{
//! \copydoc BlackGui::Views::COrderableViewWithDbObjects::customMenu
virtual void customMenu(Menus::CMenuActions &menuActions) override;
//! \copydoc BlackGui::Views::COrderableViewWithDbObjects::modifyLoadedJsonData
virtual BlackMisc::CStatusMessage modifyLoadedJsonData(BlackMisc::Simulation::CAircraftModelList &models) const override;
//! \copydoc BlackGui::Views::COrderableViewWithDbObjects::validateLoadedJsonData
virtual BlackMisc::CStatusMessage validateLoadedJsonData(const BlackMisc::Simulation::CAircraftModelList &models) const override;
//! \copydoc BlackGui::Views::COrderableViewWithDbObjects::jsonLoadedAndModelUpdated
virtual void jsonLoadedAndModelUpdated(const BlackMisc::Simulation::CAircraftModelList &models) override;
//! @}

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

@@ -433,10 +433,19 @@ namespace BlackGui
//! \name Functions from QTableView
//! @{
//! \copydoc QTableView::resizeEvent
virtual void resizeEvent(QResizeEvent *event) override;
//! \copydoc QTableView::dragEnterEvent
virtual void dragEnterEvent(QDragEnterEvent *event) override;
//! \copydoc QTableView::dragMoveEvent
virtual void dragMoveEvent(QDragMoveEvent *event) override;
//! \copydoc QTableView::dragLeaveEvent
virtual void dragLeaveEvent(QDragLeaveEvent *event) override;
//! \copydoc QTableView::dropEvent
virtual void dropEvent(QDropEvent *event) override;
//! @}
@@ -686,8 +695,14 @@ namespace BlackGui
//! \name Selection model interface ISelectionModel
//! @{
//! \copydoc BlackGui::Models::ISelectionModel::selectObjects
virtual void selectObjects(const ContainerType &selectedObjects) override;
//! \copydoc BlackGui::Models::ISelectionModel::selectedObjects
virtual ContainerType selectedObjects() const override;
//! \copydoc BlackGui::Models::ISelectionModel::unselectedObjects
virtual ContainerType unselectedObjects() const override;
//! @}
@@ -726,29 +741,69 @@ namespace BlackGui
//! \name Slot overrides from base class
//! @{
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::removeSelectedRows
virtual int removeSelectedRows() override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::presizeOrFullResizeToContents
virtual void presizeOrFullResizeToContents() override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::clearHighlighting
virtual void clearHighlighting() override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::materializeFilter
virtual void materializeFilter() override;
//! @}
//! \name BlackGui::Views::CViewBaseNonTemplate implementations
//! @{
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::clear
virtual void clear() override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::rowCount
virtual int rowCount() const override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::isEmpty
virtual bool isEmpty() const override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::isOrderable
virtual bool isOrderable() const override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::allowDragDrop
virtual void allowDragDrop(bool allowDrag, bool allowDrop, bool allowDropJsonFile = false) override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::isDropAllowed
virtual bool isDropAllowed() const override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::dropEvent
virtual void dropEvent(QDropEvent *event) override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::acceptDrop
virtual bool acceptDrop(const QMimeData *mimeData) const override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::setSorting
virtual bool setSorting(const BlackMisc::CPropertyIndex &propertyIndex, Qt::SortOrder order = Qt::AscendingOrder) override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::sortByPropertyIndex
virtual void sortByPropertyIndex(const BlackMisc::CPropertyIndex &propertyIndex, Qt::SortOrder order = Qt::AscendingOrder) override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::setNoSorting
virtual void setNoSorting() override { m_model->setNoSorting(); }
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::getSortProperty
virtual BlackMisc::CPropertyIndex getSortProperty() const override { return m_model->getSortProperty(); }
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::getSortColumn
virtual int getSortColumn() const override { return m_model->getSortColumn(); }
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::hasValidSortColumn
virtual bool hasValidSortColumn() const override { return m_model->hasValidSortColumn(); }
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::endsWithEmptyColumn
virtual bool endsWithEmptyColumn() const override { return m_model->endsWithEmptyColumn(); }
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::getSortOrder
virtual Qt::SortOrder getSortOrder() const override { return m_model->getSortOrder(); }
//! @}
@@ -806,19 +861,47 @@ namespace BlackGui
//! \name base class implementations
//! @{
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::reachedResizeThreshold
virtual bool reachedResizeThreshold(int containrerSize = -1) const override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::performModeBasedResizeToContent
virtual void performModeBasedResizeToContent() override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::performUpdateContainer
virtual int performUpdateContainer(const BlackMisc::CVariant &variant, bool sort, bool resize) override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::updateSortIndicator
virtual void updateSortIndicator() override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::mouseOverCallback
virtual void mouseOverCallback(const QModelIndex &index, bool mouseOver) override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::drawDropIndicator
virtual void drawDropIndicator(bool indicator) override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::copy
virtual void copy() override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::cut
virtual void cut() override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::paste
virtual void paste() override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::displayJsonPopup
virtual void displayJsonPopup() override { this->displayContainerAsJsonPopup(false); }
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::displaySelectedJsonPopup
virtual void displaySelectedJsonPopup() override { this->displayContainerAsJsonPopup(true); }
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::filterDialogFinished
virtual bool filterDialogFinished(int status) override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::filterWidgetChangedFilter
virtual bool filterWidgetChangedFilter(bool enabled) override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::removeFilter
virtual void removeFilter() override;
//! @}
@@ -843,10 +926,20 @@ namespace BlackGui
//! \name Overrides from base class
//! @{
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::removeFilter
virtual void onClicked(const QModelIndex &index) override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::onDoubleClicked
virtual void onDoubleClicked(const QModelIndex &index) override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::onRowSelected
virtual void onRowSelected(const QModelIndex &index) override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::loadJson
virtual BlackMisc::CStatusMessage loadJson(const QString &directory = {}) override;
//!\copydoc BlackGui::Views::CViewBaseNonTemplate::saveJson
virtual BlackMisc::CStatusMessage saveJson(bool selectedOnly = false, const QString &directory = {}) override;
//! @}
};

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

@@ -30,7 +30,11 @@ namespace BlackGui::Views
//! \name QStyledItemDelegate overrides
//! @{
//! \copydoc QStyledItemDelegate::paint
virtual void paint(QPainter *painter, const QStyleOptionViewItem &option, const QModelIndex &index) const override;
//! \copydoc QStyledItemDelegate::sizeHint
virtual QSize sizeHint(const QStyleOptionViewItem &option, const QModelIndex &index) const override;
//! @}

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

@@ -33,6 +33,8 @@ namespace BlackGui::Views
//! \name Proxy style overrides
//! @{
//! \copydoc QProxyStyle::drawPrimitive
virtual void drawPrimitive(PrimitiveElement element, const QStyleOption *option, QPainter *painter, const QWidget *widget) const override;
//! @}

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

@@ -128,6 +128,4 @@ namespace BlackGui
} // namespace
} // namespace
//! \endcond
#endif // guard