Fix doxygen copydoc documentation

The following issues were fixed
* Fixed wrong/missing namespaces
* Fixed obvious typos in documentation
* Documentation not in sync with source code

refs #544
This commit is contained in:
Roland Winklmeier
2016-02-07 18:40:11 +01:00
parent dfb6798d31
commit 794bf0cd74
154 changed files with 399 additions and 399 deletions

View File

@@ -67,14 +67,14 @@ namespace BlackGui
//! \copydoc BlackGui::Models::CAircraftModelListModel::setHighlightModelStrings(const QStringList &)
void setHighlightModelStrings(const QStringList &highlightModels);
//! \copydoc BlackGui::Models::CAircraftModelListModel::setHighlightModelsStrings(bool)
//! \copydoc BlackGui::Models::CAircraftModelListModel::setHighlightModelStrings(bool)
void setHighlightModelStrings(bool highlight);
//! \copydoc BlackGui::Models::CAircraftModelListModel::setHighlightModelStringsColor
void setHighlightModelStringsColor(const QBrush &brush);
//! \copydoc BlackGui::Models::CAircraftModelListModel::highlightModelsStrings
bool highlightModelsStrings() const;
//! \copydoc BlackGui::Models::CAircraftModelListModel::highlightModelStrings
signals:
//! Request to stash if applicable

View File

@@ -44,7 +44,7 @@ namespace BlackGui
void requestTextMessageWidget(const BlackMisc::Aviation::CCallsign &callsign);
public slots:
//! \copydoc CAtcStationListModel::changedAtcStationConnectionStatus
//! \copydoc Models::CAtcStationListModel::changedAtcStationConnectionStatus
void changedAtcStationConnectionStatus(const BlackMisc::Aviation::CAtcStation &station, bool added);
protected:

View File

@@ -110,13 +110,13 @@ namespace BlackGui
//! Allow to drag and/or drop value objects
virtual void allowDragDropValueObjects(bool allowDrag, bool allowDrop);
//! \copydoc CDockWidget::allowDrop
//! \copydoc CDropBase::allowDrop
virtual void allowDrop(bool allow) override;
//! \copydoc CDockWidget::isDropAllowed
//! \copydoc CDropBase::isDropAllowed
virtual bool isDropAllowed() const override;
//! \copydoc CEnableForDockWidgetInfoArea::setParentDockWidgetInfoArea
//! \copydoc Components::CEnableForDockWidgetInfoArea::setParentDockWidgetInfoArea
virtual bool setParentDockWidgetInfoArea(BlackGui::CDockWidgetInfoArea *parentDockableWidget);
//! Resize mode
@@ -191,7 +191,7 @@ namespace BlackGui
//! Menus
Menu getMenu() const { return this->m_menus; }
//! \copydoc QTableView::setSelectionModel();
//! \copydoc QTableView::setSelectionModel
virtual void setSelectionModel(QItemSelectionModel *model) override;
//! Main application window widget if any
@@ -256,7 +256,7 @@ namespace BlackGui
//! Method creating the menu
//! \remarks override this method to contribute to the menu
//! \sa CViewBaseNonTemplate::ps_customMenuRequested
//! \sa BlackGui::Views::CViewBaseNonTemplate::ps_customMenuRequested
virtual void customMenu(QMenu &menu) const;
//! \copydoc QTableView::paintEvent
@@ -430,13 +430,13 @@ namespace BlackGui
//! Access to container
const ContainerType &container() const;
//! \copydoc BlackGui::Models::ListModelBase::containerOrFilteredContainer
//! \copydoc BlackGui::Models::CListModelBase::containerOrFilteredContainer
const ContainerType &containerOrFilteredContainer() const;
//! Selected objects
ContainerType selectedObjects() const;
//! \copydoc CViewBaseNonTemplate::removeSelectedRows
//! \copydoc BlackGui::Views::CViewBaseNonTemplate::removeSelectedRows
//! \remarks Actually a slot, but not defined as such as the template does not support Q_OBJECT
virtual int removeSelectedRows() override;
@@ -476,7 +476,7 @@ namespace BlackGui
//! Column count
int columnCount() const;
//! \copydoc CViewBaseNonTemplate::isEmpty
//! \copydoc BlackGui::Views::CViewBaseNonTemplate::isEmpty
virtual bool isEmpty() const override;
//! Convert to JSON

View File

@@ -44,11 +44,11 @@ namespace BlackGui
//! Constructor
explicit CViewWithDbObjects(QWidget *parent = nullptr);
//! \copydoc QWidget::customMenu
//! \copydoc BlackGui::Views::CViewBaseNonTemplate::customMenu
virtual void customMenu(QMenu &menu) const override;
protected slots:
//! \copydoc CViewBaseNonTemplate::ps_toggleHighlightDbData
//! \copydoc BlackGui::Views::CViewBase::ps_toggleHighlightDbData
virtual void ps_toggleHighlightDbData() override;
};
} // namespace