commit 8c43fcc35c1bac3d4b19bf6cfad45fe7282b863c
author Yingdi Yu <yuyingdi@gmail.com> Wed Mar 09 18:23:57 2016 -0800
committer Yingdi Yu <yuyingdi@gmail.com> Thu Mar 10 14:21:16 2016 -0800
tree 17d7c2e7523150e2ff2d2bf7f489c5fc59a48b94
parent d263c8a53084c4fffdfc1b84be5c52dd4ef8b8f2

doc: Clarify doxygen in GroupManager and GroupManagerDB

Change-Id: I35404474de4943cd8c45fecf78cb9a1d335f4e06
Refs: #3287, #3288, #3297

src/group-manager-db.hpp

diff --git a/src/group-manager-db.hpp b/src/group-manager-db.hpp
index bf5ef2f..9f737ae 100644
--- a/src/group-manager-db.hpp
+++ b/src/group-manager-db.hpp
@@ -46,8 +46,11 @@
   };
 
 public:
+  /**
+   * @brief Create the database of group manager at path @p dbPath.
+   */
   explicit
-  GroupManagerDB(const std::string& dbDir);
+  GroupManagerDB(const std::string& dbPath);
 
   ~GroupManagerDB();
 
@@ -90,7 +93,8 @@
   addSchedule(const std::string& name, const Schedule& schedule);
 
   /**
-   * @brief Delete the schedule with @p name
+   * @brief Delete the schedule with @p name.
+   *        also delete members which reference the schedule.
    */
   void
   deleteSchedule(const std::string& name);