[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    [kgpg] core: document the input expected by KGpgRootNode::addGroups()
From:       Rolf Eike Beer <kde () opensource ! sf-tec ! de>
Date:       2016-10-21 16:20:45
Message-ID: E1bxcYn-0001l5-2I () code ! kde ! org
[Download RAW message or body]

Git commit d73ddd585d42fdced964197e910b8e3bce2cab06 by Rolf Eike Beer.
Committed on 21/10/2016 at 16:20.
Pushed by dakon into branch 'master'.

document the input expected by KGpgRootNode::addGroups()

M  +5    -1    core/KGpgRootNode.h

http://commits.kde.org/kgpg/d73ddd585d42fdced964197e910b8e3bce2cab06

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());
[prev in list] [next in list] [prev in thread] [next in thread]