regulators: Improve I2CCaptureBytesAction doxygen
Improve the doxygen comments for the I2CCaptureBytesAction class.
Signed-off-by: Shawn McCarney <shawnmm@us.ibm.com>
Change-Id: Ic3352f0e35ab2dab8ea0a97d35ce66b4ddcdcca5
diff --git a/phosphor-regulators/src/actions/i2c_capture_bytes_action.cpp b/phosphor-regulators/src/actions/i2c_capture_bytes_action.cpp
index 728daeb..0bb24b1 100644
--- a/phosphor-regulators/src/actions/i2c_capture_bytes_action.cpp
+++ b/phosphor-regulators/src/actions/i2c_capture_bytes_action.cpp
@@ -37,13 +37,13 @@
uint8_t values[UINT8_MAX];
interface.read(reg, size, values, i2c::I2CInterface::Mode::I2C);
- // Build additional error data key
+ // Build additional error data key: <deviceID>_register_<register>
std::ostringstream kss;
kss << environment.getDeviceID() << "_register_0x" << std::hex
<< std::uppercase << static_cast<uint16_t>(reg);
std::string key = kss.str();
- // Build additional error data value
+ // Build additional error data value: [ <byte 0>, <byte 1>, ... ]
std::ostringstream vss;
vss << "[ " << std::hex << std::uppercase;
for (unsigned int i = 0; i < count; ++i)