summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorRolf Eike Beer <eb@emlix.com>2016-10-21 15:30:12 (GMT)
committerRolf Eike Beer <kde@opensource.sf-tec.de>2016-10-21 16:20:18 (GMT)
commitd73ddd585d42fdced964197e910b8e3bce2cab06 (patch)
tree9fa2b488cd37aa3cdeae197324c4f3855282cf51
parentafe68e81f5c2d4a625f615b7e36457d37f811061 (diff)
document the input expected by KGpgRootNode::addGroups()
-rw-r--r--core/KGpgRootNode.h6
1 files changed, 5 insertions, 1 deletions
diff --git a/core/KGpgRootNode.h b/core/KGpgRootNode.h
index 1d67237..5741746 100644
--- a/core/KGpgRootNode.h
+++ b/core/KGpgRootNode.h
@@ -56,7 +56,11 @@ public:
/**
* Create new group nodes
- * @param groups list of group names to create
+ * @param groups list of group names and keys to create
+ *
+ * The format of each entry of groups is name:keys, where keys is
+ * a list of key ids separated by semicolons. This is the format
+ * that is output by "gpg --list-config --with-colons".
*/
void addGroups(const QStringList &groups);
void addKeys(const QStringList &ids = QStringList());