FAPI2 Comments/Clean up

This commit is just adding/cleaning up some comments in the
fapi2 code.

Change-Id: Ibd095d2d27bce1836543ee2370328da640e71aa0
RTC:147822
Reviewed-on: http://ralgit01.raleigh.ibm.com/gerrit1/21682
Tested-by: Jenkins Server
Reviewed-by: Matt Derksen <v2cibmd@us.ibm.com>
Reviewed-by: Martin Gloff <mgloff@us.ibm.com>
Reviewed-by: Prachi Gupta <pragupta@us.ibm.com>
Reviewed-by: Daniel M. Crowell <dcrowell@us.ibm.com>

1 files changed, 10 insertions, 2 deletions

diff --git a/src/usr/fapi2/test/fapi2TestUtils.H b/src/usr/fapi2/test/fapi2TestUtils.H
index 15ddb0b6a..f4e9f5dc8 100644
--- a/src/usr/fapi2/test/fapi2TestUtils.H
+++ b/src/usr/fapi2/test/fapi2TestUtils.H
@@ -37,7 +37,9 @@
 
 namespace fapi2
 {
-// Setup some targets to use
+
+//Used by generateTargets to get a list of all platform target
+// types that directly relate to fapi2 target types
 enum{
     MY_EQ,
     MY_EX,
@@ -57,7 +59,13 @@ enum{
     NUM_TARGETS
 };
 
-
+///
+/// @brief Generates a list of platform targets of all differnt types.
+///        This comes in handy when testing out fapi2 target interfaces
+/// @param[in] i_pMasterProcChip Pointer to master proc chip
+/// @param[out] o_targetList     List of platform targets that gets generated
+///                              by this function
+///
 void generateTargets(TARGETING::Target* i_pMasterProcChip,
                                     TARGETING::Target* o_targetList[]);