mirror of
https://github.com/swift-project/pilotclient.git
synced 2026-04-05 01:05:34 +08:00
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:
@@ -72,13 +72,13 @@ namespace BlackMisc
|
||||
//! Is hotkey valid?
|
||||
bool isValid() const { return !m_identifier.getMachineName().isEmpty() && !m_combination.isEmpty() && !m_action.isEmpty(); }
|
||||
|
||||
//! \copydoc CValueObject::setPropertyByIndex
|
||||
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
|
||||
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
|
||||
|
||||
//! \copydoc CValueObject::propertyByIndex
|
||||
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
|
||||
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
|
||||
|
||||
//! \copydoc CValueObject::convertToQString
|
||||
//! \copydoc BlackMisc::Mixin::String::toQString
|
||||
QString convertToQString(bool i18n = false) const;
|
||||
|
||||
private:
|
||||
|
||||
@@ -70,7 +70,7 @@ namespace BlackMisc
|
||||
//! E.g. CTRL would be a subset of CTRL+D
|
||||
bool isSubsetOf(const CHotkeyCombination &other) const;
|
||||
|
||||
//! \copydoc CValueObject::convertToQString
|
||||
//! \copydoc BlackMisc::Mixin::String::toQString
|
||||
QString convertToQString(bool i18n = false) const;
|
||||
|
||||
private:
|
||||
|
||||
@@ -54,10 +54,10 @@ namespace BlackMisc
|
||||
//! Set button object
|
||||
void setButtonObject(const CJoystickButton &button);
|
||||
|
||||
//! \copydoc CValueObject::setPropertyByIndex
|
||||
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
|
||||
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
|
||||
|
||||
//! \copydoc CValueObject::propertyByIndex
|
||||
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
|
||||
CVariant propertyByIndex(const CPropertyIndex &index) const;
|
||||
|
||||
//! Button index to string
|
||||
@@ -69,7 +69,7 @@ namespace BlackMisc
|
||||
//! Invalid button index
|
||||
static int getInvalidIndex() { return m_invalidIndex; }
|
||||
|
||||
//! \copydoc CValueObject::convertToQString
|
||||
//! \copydoc BlackMisc::Mixin::String::toQString
|
||||
QString convertToQString(bool i18n = false) const;
|
||||
|
||||
private:
|
||||
|
||||
@@ -73,13 +73,13 @@ namespace BlackMisc
|
||||
//! Set key object
|
||||
void setKeyObject(const CKeyboardKey &key);
|
||||
|
||||
//! \copydoc CValueObject::setPropertyByIndex
|
||||
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
|
||||
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
|
||||
|
||||
//! \copydoc CValueObject::propertyByIndex
|
||||
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
|
||||
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
|
||||
|
||||
//! \copydoc CValueObject::convertToQString
|
||||
//! \copydoc BlackMisc::Mixin::String::toQString
|
||||
QString convertToQString(bool i18n = false) const;
|
||||
|
||||
private:
|
||||
|
||||
Reference in New Issue
Block a user