telepathy-qt: docs: remove the empty 'functions' group and actually put the utils.cpp functions in the utils group
Alexandr Akulich
kaffeine at kemper.freedesktop.org
Sun Oct 9 13:45:43 UTC 2016
Module: telepathy-qt
Branch: master
Commit: 639ac370be34536c4bc96dd3abcf2b4c480639c7
URL: http://cgit.freedesktop.org/telepathy/telepathy-qt/commit/?id=639ac370be34536c4bc96dd3abcf2b4c480639c7
Author: George Kiagiadakis <gkiagia at tolabaki.gr>
Date: Sun Sep 25 17:38:39 2016 +0300
docs: remove the empty 'functions' group and actually put the utils.cpp functions in the utils group
---
TelepathyQt/groups.dox | 4 ++--
TelepathyQt/utils.cpp | 15 +++++++++++----
2 files changed, 13 insertions(+), 6 deletions(-)
diff --git a/TelepathyQt/groups.dox b/TelepathyQt/groups.dox
index a5415c4..31627ab 100644
--- a/TelepathyQt/groups.dox
+++ b/TelepathyQt/groups.dox
@@ -139,7 +139,7 @@
*/
/**
- * \defgroup utils Utililty classes
+ * \defgroup utils Utililty classes and functions
*
- * Utility classes.
+ * Utility classes and functions
*/
diff --git a/TelepathyQt/utils.cpp b/TelepathyQt/utils.cpp
index e4614c2..4611cf0 100644
--- a/TelepathyQt/utils.cpp
+++ b/TelepathyQt/utils.cpp
@@ -27,10 +27,6 @@
#include <QByteArray>
#include <QStringList>
-/**
- * \defgroup utility functions
- */
-
namespace Tp
{
@@ -42,6 +38,8 @@ static inline bool isBad(char c, bool isFirst)
}
/**
+ * \ingroup utils
+ *
* Escape an arbitrary string so it follows the rules for a C identifier,
* and hence an object path component, interface element component,
* bus name component or member name in D-Bus.
@@ -119,6 +117,9 @@ QString escapeAsIdentifier(const QString &string)
return QString::fromLatin1(op.constData());
}
+/**
+ * \ingroup utils
+ */
bool checkValidProtocolName(const QString &protocolName)
{
if (protocolName.isEmpty()) {
@@ -145,6 +146,9 @@ bool checkValidProtocolName(const QString &protocolName)
return true;
}
+/**
+ * \ingroup utils
+ */
QVariant::Type variantTypeFromDBusSignature(const QString &signature)
{
QVariant::Type type;
@@ -171,6 +175,9 @@ QVariant::Type variantTypeFromDBusSignature(const QString &signature)
return type;
}
+/**
+ * \ingroup utils
+ */
QVariant parseValueWithDBusSignature(const QString &value,
const QString &dbusSignature)
{
More information about the telepathy-commits
mailing list