On 3/6/23 8:43 AM, Ajay Kadapathri wrote:
+EFI_STATUS
+GuidToStr (
+  IN EFI_GUID  *guid,
+  IN OUT UINT8 *str_buffer
+  )
+/*++
+
+Routine Description:
+  This function prints a GUID to a buffer
+
+Arguments:
+  guid       - Pointer to a GUID
+  str_buffer - Pointer to a str buffer
+
+Returns:
+  EFI_SUCCESS            GUID was printed
+  EFI_INVALID_PARAMETER  GUID was NULL
+
+--*/
+{
+  if (guid == NULL) {
+    return EFI_INVALID_PARAMETER;
+  }
+
+  sprintf (
+    (CHAR8 *)str_buffer,
+    "%08X-%04X-%04X-%02X%02X-%02X%02X%02X%02X%02X%02X",
+    (unsigned) guid->Data1,
+    guid->Data2,
+    guid->Data3,
+    guid->Data4[0],
+    guid->Data4[1],
+    guid->Data4[2],
+    guid->Data4[3],
+    guid->Data4[4],
+    guid->Data4[5],
+    guid->Data4[6],
+    guid->Data4[7]
+    );
+
+  return EFI_SUCCESS;
+}

Could you fix the documentation block please?

It should be placed _above_ the function, and be formatted in Doxygen style, as:


/**

 This function prints a GUID to a buffer


 @param guid       Pointer to a GUID

 @param str_buffer Pointer to a str buffer


 @retval EFI_SUCCESS           GUID was printed

 @retval EFI_INVALID_PARAMETER GUID was NULL


**/



-=-=-=-=-=-=-=-=-=-=-=-
Groups.io Links: You receive all messages sent to this group.
View/Reply Online (#100741): https://edk2.groups.io/g/devel/message/100741
Mute This Topic: https://groups.io/mt/97427598/21656
Group Owner: devel+ow...@edk2.groups.io
Unsubscribe: https://edk2.groups.io/g/devel/unsub [arch...@mail-archive.com]
-=-=-=-=-=-=-=-=-=-=-=-


Reply via email to