Added documentation for keywords
Change-Id: Ifc55139a04dd32b2fbed13050737403a013d32c4
Signed-off-by: Anves Kumar rayankula <anvesr77@in.ibm.com>
diff --git a/lib/bmc_network_utils.robot b/lib/bmc_network_utils.robot
index dbcac25..52fc5bd3 100644
--- a/lib/bmc_network_utils.robot
+++ b/lib/bmc_network_utils.robot
@@ -288,7 +288,9 @@
... msg=MAC address ${fw_env_addr} does not match ${mac_new_addr}.
Truncate MAC Address
+ [Documentation] Truncates and returns user provided MAC address.
[Arguments] ${sys_mac_addr} ${user_mac_addr}
+
# Description of argument(s):
# sys_mac_addr MAC address of the BMC.
# user_mac_addr user provided MAC address.
@@ -304,8 +306,9 @@
Return From Keyword If ${invalid_mac_byte} ${user_mac_addr}
${mac_int} = Convert To Integer ${user_mac_list}[${mac_byte}] 16
${user_mac_len} = Get Length ${user_mac_list}
- ${user_mac_byte}= Run Keyword IF ${mac_int} >= ${256} Truncate MAC Bits ${user_mac_list}[${mac_byte}]
- ... ELSE Set Variable ${user_mac_list}[${mac_byte}]
+ ${user_mac_byte}= Run Keyword IF
+ ... ${mac_int} >= ${256} Truncate MAC Bits ${user_mac_list}[${mac_byte}]
+ ... ELSE Set Variable ${user_mac_list}[${mac_byte}]
Append To List ${user_new_mac_list} ${user_mac_byte}
${mac_byte} = Set Variable ${mac_byte + 1}
@@ -316,7 +319,9 @@
[Return] ${user_new_mac_string}
Truncate MAC Bits
+ [Documentation] Truncates user provided MAC address byte to bits.
[Arguments] ${user_mac_addr_byte}
+
# Description of argument(s):
# user_mac_addr_byte user provided MAC address byte to truncate bits