Tidy generated comments etc

Author: callumfare

offload/new-api/API/Common.td

@@ -29,12 +29,6 @@ def : Macro {
   let alt_value = "";
 }
 
-def : Typedef {
-  let name = "offload_bool_t";
-  let value = "uint8_t";
-  let desc = "compiler-independent type";
-}
-
 def : Handle {
   let name = "offload_platform_handle_t";
   let desc = "Handle of a platform instance";
@@ -62,14 +56,14 @@ def : Enum {
     Etor<"ERROR_DEVICE_LOST", "Device hung, reset, was removed, or driver update occurred">,
     Etor<"ERROR_UNINITIALIZED", "plugin is not initialized or specific entry-point is not implemented">,
     Etor<"ERROR_OUT_OF_RESOURCES", "Out of resources">,
-    Etor<"ERROR_UNSUPPORTED_VERSION", "[Validation] generic error code for unsupported versions">,
-    Etor<"ERROR_UNSUPPORTED_FEATURE", "[Validation] generic error code for unsupported features">,
-    Etor<"ERROR_INVALID_ARGUMENT", "[Validation] generic error code for invalid arguments">,
-    Etor<"ERROR_INVALID_NULL_HANDLE", "[Validation] handle argument is not valid">,
-    Etor<"ERROR_INVALID_NULL_POINTER", "[Validation] pointer argument may not be nullptr">,
-    Etor<"ERROR_INVALID_SIZE", "[Validation] invalid size or dimensions (e.g., must not be zero, or is out of bounds)">,
-    Etor<"ERROR_INVALID_ENUMERATION", "[Validation] enumerator argument is not valid">,
-    Etor<"ERROR_UNSUPPORTED_ENUMERATION", "[Validation] enumerator argument is not supported by the device">,
+    Etor<"ERROR_UNSUPPORTED_VERSION", "generic error code for unsupported versions">,
+    Etor<"ERROR_UNSUPPORTED_FEATURE", "generic error code for unsupported features">,
+    Etor<"ERROR_INVALID_ARGUMENT", "generic error code for invalid arguments">,
+    Etor<"ERROR_INVALID_NULL_HANDLE", "handle argument is not valid">,
+    Etor<"ERROR_INVALID_NULL_POINTER", "pointer argument may not be nullptr">,
+    Etor<"ERROR_INVALID_SIZE", "invalid size or dimensions (e.g., must not be zero, or is out of bounds)">,
+    Etor<"ERROR_INVALID_ENUMERATION", "enumerator argument is not valid">,
+    Etor<"ERROR_UNSUPPORTED_ENUMERATION", "enumerator argument is not supported by the device">,
     Etor<"ERROR_UNKNOWN", "Unknown or internal error">
   ];
 }

offload/new-api/API/Device.td

@@ -46,13 +46,13 @@ def : Function {
   let params = [
     Param<"offload_platform_handle_t", "hPlatform", "handle of the platform instance", PARAM_IN>,
     Param<"offload_device_type_t", "DeviceType", "the type of the devices.", PARAM_IN>,
-    Param<"uint32_t", "NumEntries", "the number of devices to be added to phDevices."
-        "If phDevices is not NULL, then NumEntries should be greater than zero. Otherwise OFFLOAD_RESULT_ERROR_INVALID_SIZE"
+    Param<"uint32_t", "NumEntries", "the number of devices to be added to phDevices. "
+        "If phDevices is not NULL, then NumEntries should be greater than zero. Otherwise OFFLOAD_RESULT_ERROR_INVALID_SIZE "
         "will be returned.", PARAM_IN>,
-    RangedParam<"offload_device_handle_t*", "phDevices", "array of handle of devices."
+    RangedParam<"offload_device_handle_t*", "phDevices", "Array of device handles. "
         "If NumEntries is less than the number of devices available, then platform shall only retrieve that number of devices.", PARAM_OUT_OPTIONAL,
         Range<"0", "NumEntries">>,
-    Param<"uint32_t*", "pNumDevices", "pointer to the number of devices."
+    Param<"uint32_t*", "pNumDevices", "pointer to the number of devices. "
         "pNumDevices will be updated with the total number of devices available.", PARAM_OUT_OPTIONAL>
   ];
   let returns = [

offload/new-api/API/Platform.td

@@ -17,13 +17,13 @@ def : Function {
   ];
   let params = [
     Param<"uint32_t", "NumEntries",
-      "The number of platforms to be added to phPlatforms. If phPlatforms is not NULL, then"
-      "NumEntries should be greater than zero, otherwise OFFLOAD_RESULT_ERROR_INVALID_SIZE"
+      "The number of platforms to be added to phPlatforms. If phPlatforms is not NULL, then "
+      "NumEntries should be greater than zero, otherwise OFFLOAD_RESULT_ERROR_INVALID_SIZE "
       "will be returned.", PARAM_IN>,
     RangedParam<"offload_platform_handle_t*", "phPlatforms", 
-      "Array of handle of platforms. If NumEntries is"
-      "less than the number of platforms available, then offloadPlatformGet"
-      "shall only retrieve that number of platforms.",
+      "Array of handle of platforms. If NumEntries is less than the number of "
+      "platforms available, then offloadPlatformGet shall only retrieve that "
+      "number of platforms.",
       PARAM_OUT_OPTIONAL, Range<"0", "NumEntries">>,
     Param<"uint32_t*",
       "pNumPlatforms", "returns the total number of platforms available.",
@@ -69,8 +69,8 @@ def : Function {
     Param<"offload_platform_handle_t", "hPlatform", "handle of the platform", PARAM_IN>,
     Param<"offload_platform_info_t", "propName", "type of the info to retrieve", PARAM_IN>,
     Param<"size_t", "propSize", "the number of bytes pointed to by pPlatformInfo.", PARAM_IN>,
-    TypeTaggedParam<"void*", "pPropValue", "array of bytes holding the info."
-      "If Size is not equal to or greater to the real number of bytes needed to return the info"
+    TypeTaggedParam<"void*", "pPropValue", "array of bytes holding the info. "
+      "If Size is not equal to or greater to the real number of bytes needed to return the info "
       "then the OFFLOAD_RESULT_ERROR_INVALID_SIZE error is returned and pPlatformInfo is not used.", PARAM_OUT_OPTIONAL,
       TypeInfo<"propName" , "propSize">>,
     Param<"size_t*", "pPropSizeRet", "pointer to the actual number of bytes being queried by pPlatformInfo.", PARAM_OUT_OPTIONAL>