regulators: Complete compare_vpd action
Complete implementation of the compare_vpd action in the JSON
configuration file. For more information about this action see
https://github.com/openbmc/phosphor-power/blob/master/phosphor-regulators/docs/config_file/compare_vpd.md
Implement the execute() method of the CompareVPDAction class. Obtain
the actual VPD keyword value from the VPD service and compare it with
the expected value.
Also improve doxygen for the execute() method of the
ComparePresenceAction class.
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Ieb93806245babe6782fef95209bed8eed5b32578
diff --git a/phosphor-regulators/src/actions/compare_presence_action.hpp b/phosphor-regulators/src/actions/compare_presence_action.hpp
index b16c98f..f2038d1 100644
--- a/phosphor-regulators/src/actions/compare_presence_action.hpp
+++ b/phosphor-regulators/src/actions/compare_presence_action.hpp
@@ -44,7 +44,8 @@
/**
* Constructor.
*
- * @param fru Field-Replaceable Unit (FRU)
+ * @param fru Field-Replaceable Unit (FRU). Specify the D-Bus inventory path
+ * of the FRU.
* @param value Expected presence value
*/
explicit ComparePresenceAction(const std::string& fru, bool value) :
@@ -55,8 +56,13 @@
/**
* Executes this action.
*
- * @param environment Action execution environment.
- * @return true
+ * Compares the actual presence value to the expected value.
+ *
+ * Throws an exception if an error occurs.
+ *
+ * @param environment action execution environment
+ * @return true if the actual presence value equals the expected value,
+ * otherwise returns false
*/
virtual bool execute(ActionEnvironment& environment) override;
@@ -91,7 +97,7 @@
/**
* Field-Replaceable Unit (FRU) for this action.
*
- * Specify the D-Bus inventory path of the FRU.
+ * The D-Bus inventory path of the FRU.
*/
const std::string fru{};