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

@@ -41,7 +41,7 @@ namespace BlackGui
//! \copydoc QAbstractTableModel::rowCount
int rowCount(const QModelIndex &parent = QModelIndex()) const override;
//! \copydoc QAbstractTableModel::columCount
//! \copydoc QAbstractTableModel::columnCount
int columnCount(const QModelIndex &parent = QModelIndex()) const override;
//! \copydoc QAbstractTableModel::data

View File

@@ -306,7 +306,7 @@ namespace BlackGui
//! Constructor
CPhysiqalQuantiyFormatter(MU unit = MU::defaultUnit(), int digits = 2, int alignment = alignRightVCenter(), bool withUnit = true, bool i18n = true, QList<int> supportedRoles = roleDisplay()) : CValueObjectFormatter(alignment, i18n, supportedRoles), m_unit(unit), m_digits(digits), m_withUnit(withUnit) {}
//! \copydoc CValueObjectFormatter::displayRole
//! \copydoc BlackGui::Models::CDefaultFormatter::displayRole
virtual BlackMisc::CVariant displayRole(const BlackMisc::CVariant &physicalQuantity) const override
{
if (physicalQuantity.canConvert<PQ>())

View File

@@ -219,7 +219,7 @@ namespace BlackGui
//! Remove object
virtual void remove(const ObjectType &object);
//! \copydoc BlackMisc::ContainerBase::removeIf
//! \copydoc BlackMisc::CContainerBase::removeIf
template <class K0, class V0, class... KeysValues>
int removeIf(K0 k0, V0 v0, KeysValues... keysValues)
{
@@ -238,10 +238,10 @@ namespace BlackGui
//! \copydoc QStandardItemModel::mimeData
virtual QMimeData *mimeData(const QModelIndexList &indexes) const override;
//! \copydoc CListModelBaseNonTemplate::toJosn
//! \copydoc BlackGui::Models::CListModelBaseNonTemplate::toJson
virtual QJsonObject toJson() const override;
//! \copydoc CListModelBaseNonTemplate::toJsonString
//! \copydoc BlackGui::Models::CListModelBaseNonTemplate::toJsonString
virtual QString toJsonString(QJsonDocument::JsonFormat format = QJsonDocument::Indented) const override;
//! Filter available
@@ -254,10 +254,10 @@ namespace BlackGui
void takeFilterOwnership(std::unique_ptr<IModelFilter<ContainerType> > &filter);
protected:
//! \copydoc CListModelBaseNonTemplate::CListModelBaseNonTemplate
//! Constructor
CListModelBase(const QString &translationContext, QObject *parent = nullptr);
//! \copydoc CModelBaseNonTemplate::performUpdateContainer
//! \copydoc BlackGui::Models::CListModelBaseNonTemplate::performUpdateContainer
virtual int performUpdateContainer(const BlackMisc::CVariant &variant, bool sort) override;
//! Update filtered container

View File

@@ -39,7 +39,7 @@ namespace BlackGui
//! Set color for highlighting
void setHighlightColor(QColor color) { m_highlightColor = color; }
//! \copydoc CListModelBase::data
//! Get data for index and role
virtual QVariant data(const QModelIndex &index, int role) const override;
//! DB key for given index
@@ -49,7 +49,7 @@ namespace BlackGui
bool isHighlightIndex(const QModelIndex &index) const;
protected:
//! \copydoc CListModelDbObjectsNonTemplate::CListModelDbObjectsNonTemplate
//! Constructor
CListModelDbObjects(const QString &translationContext, QObject *parent = nullptr);
private: