include/nutconf.hpp: UpsdUsersConfiguration: update comments about ex…

…isting methods [networkupstools#2294] Signed-off-by: Jim Klimov <[email protected]>
jimklimov · Apr 24, 2024 · 188e8c0 · 188e8c0
1 parent 0c4f196
commit 188e8c0
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/include/nutconf.hpp b/include/nutconf.hpp
@@ -1092,13 +1092,17 @@ class UpsdUsersConfiguration : public GenericConfiguration
 
 	inline std::string getPassword(const std::string & user) const { return getStr(user, "password"); }
 
+	/** Currently valid actions include "SET" and "FSD",
+	 *  but the method does not constrain the values */
 	inline ConfigParamList getActions(const std::string & user) const
 	{
 		ConfigParamList actions;
 		get(user, "actions", actions);
 		return actions;
 	}
 
+	/** Valid commands are "ALL" or a list of specific commands
+	 *  supported by the device (NUT driver dependent) */
 	inline ConfigParamList getInstantCommands(const std::string & user) const
 	{
 		ConfigParamList cmds;
@@ -1124,6 +1128,9 @@ class UpsdUsersConfiguration : public GenericConfiguration
 	 *
 	 *  \param  mode  Mode
 	 */
+	/* TOTHINK: Do we need a writer (other method, optional parameter
+	 * to this one) for obsolete wordings of the upsmon mode?
+	 * Note: reader in the getter accepts both old and new values. */
 	void setUpsmonMode(upsmon_mode_t mode);
 
 	/** \} */