1) Add blank before @file to follows doxygen style.

2) Adjust function order to avoid pre-declaration for function prototype.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@8644 6f19259b-4bc3-4df7-8a09-765794883524

diff --git a/IntelFrameworkModulePkg/Universal/DataHubDxe/DataHub.c b/IntelFrameworkModulePkg/Universal/DataHubDxe/DataHub.c
index ff8e8a17168fcc815cb0d2e1d1a72aa6115182db..3f2a4c6e1a1b79cdacf2d0d7c31f06d54dc2be10 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/DataHubDxe/DataHub.c
+++ b/IntelFrameworkModulePkg/Universal/DataHubDxe/DataHub.c
@@ -23,22 +23,6 @@ CONST EFI_GUID gZeroGuid  = { 0, 0, 0, { 0, 0, 0, 0, 0, 0, 0, 0 } };
 //\r
 DATA_HUB_INSTANCE mPrivateData;\r
 \r
-//\r
-// Worker functions private to this file\r
-//\r
-DATA_HUB_FILTER_DRIVER  *\r
-FindFilterDriverByEvent (\r
-  IN  LIST_ENTRY      *Head,\r
-  IN  EFI_EVENT       Event\r
-  );\r
-\r
-EFI_DATA_RECORD_HEADER  *\r
-GetNextDataRecord (\r
-  IN  LIST_ENTRY          *Head,\r
-  IN  UINT64              ClassFilter,\r
-  IN OUT  UINT64          *PtrCurrentMTC\r
-  );\r
-\r
 /**\r
   Log data record into the data logging hub\r
 \r
@@ -157,6 +141,110 @@ DataHubLogData (
   return EFI_SUCCESS;\r
 }\r
 \r
+/**\r
+  Search the Head doubly linked list for the passed in MTC. Return the \r
+  matching element in Head and the MTC on the next entry.\r
+\r
+  @param Head             Head of Data Log linked list.\r
+  @param ClassFilter      Only match the MTC if it is in the same Class as the\r
+                          ClassFilter.\r
+  @param PtrCurrentMTC    On IN contians MTC to search for. On OUT contians next\r
+                          MTC in the data log list or zero if at end of the list.\r
+  \r
+  @retval EFI_DATA_LOG_ENTRY  Return pointer to data log data from Head list.\r
+  @retval NULL                If no data record exists.\r
+\r
+**/\r
+EFI_DATA_RECORD_HEADER *\r
+GetNextDataRecord (\r
+  IN  LIST_ENTRY          *Head,\r
+  IN  UINT64              ClassFilter,\r
+  IN OUT  UINT64          *PtrCurrentMTC\r
+  )\r
+\r
+{\r
+  EFI_DATA_ENTRY          *LogEntry;\r
+  LIST_ENTRY              *Link;\r
+  BOOLEAN                 ReturnFirstEntry;\r
+  EFI_DATA_RECORD_HEADER  *Record;\r
+  EFI_DATA_ENTRY          *NextLogEntry;\r
+\r
+  //\r
+  // If MonotonicCount == 0 just return the first one\r
+  //\r
+  ReturnFirstEntry  = (BOOLEAN) (*PtrCurrentMTC == 0);\r
+\r
+  Record            = NULL;\r
+  for (Link = GetFirstNode(Head); Link != Head; Link = GetNextNode(Head, Link)) {\r
+    LogEntry = DATA_ENTRY_FROM_LINK (Link);\r
+    if ((LogEntry->Record->DataRecordClass & ClassFilter) == 0) {\r
+      //\r
+      // Skip any entry that does not have the correct ClassFilter\r
+      //\r
+      continue;\r
+    }\r
+\r
+    if ((LogEntry->Record->LogMonotonicCount == *PtrCurrentMTC) || ReturnFirstEntry) {\r
+      //\r
+      // Return record to the user\r
+      //\r
+      Record = LogEntry->Record;\r
+\r
+      //\r
+      // Calculate the next MTC value. If there is no next entry set\r
+      // MTC to zero.\r
+      //\r
+      *PtrCurrentMTC = 0;\r
+      for (Link = GetNextNode(Head, Link); Link != Head; Link = GetNextNode(Head, Link)) {\r
+        NextLogEntry = DATA_ENTRY_FROM_LINK (Link);\r
+        if ((NextLogEntry->Record->DataRecordClass & ClassFilter) != 0) {\r
+          //\r
+          // Return the MTC of the next thing to search for if found\r
+          //\r
+          *PtrCurrentMTC = NextLogEntry->Record->LogMonotonicCount;\r
+          break;\r
+        }\r
+      }\r
+      //\r
+      // Record found exit loop and return\r
+      //\r
+      break;\r
+    }\r
+  }\r
+\r
+  return Record;\r
+}\r
+\r
+/**\r
+  Search the Head list for a EFI_DATA_HUB_FILTER_DRIVER member that\r
+  represents Event and return it.\r
+\r
+  @param Head   Pointer to head of dual linked list of EFI_DATA_HUB_FILTER_DRIVER structures.\r
+  @param Event  Event to be search for in the Head list.\r
+\r
+  @retval EFI_DATA_HUB_FILTER_DRIVER  Returned if Event stored in the Head doubly linked list.\r
+  @retval NULL                        If Event is not in the list\r
+\r
+**/\r
+DATA_HUB_FILTER_DRIVER *\r
+FindFilterDriverByEvent (\r
+  IN  LIST_ENTRY      *Head,\r
+  IN  EFI_EVENT       Event\r
+  )\r
+{\r
+  DATA_HUB_FILTER_DRIVER  *FilterEntry;\r
+  LIST_ENTRY              *Link;\r
+\r
+  for (Link = GetFirstNode(Head); Link != Head; Link = GetNextNode(Head, Link)) {\r
+    FilterEntry = FILTER_ENTRY_FROM_LINK (Link);\r
+    if (FilterEntry->Event == Event) {\r
+      return FilterEntry;\r
+    }\r
+  }\r
+\r
+  return NULL;\r
+}\r
+\r
 /**\r
 \r
   Get a previously logged data record and the MonotonicCount for the next\r
@@ -417,109 +505,7 @@ DataHubUnregisterFilterDriver (
   return EFI_SUCCESS;\r
 }\r
 \r
-/**\r
-  Search the Head list for a EFI_DATA_HUB_FILTER_DRIVER member that\r
-  represents Event and return it.\r
-\r
-  @param Head   Pointer to head of dual linked list of EFI_DATA_HUB_FILTER_DRIVER structures.\r
-  @param Event  Event to be search for in the Head list.\r
-\r
-  @retval EFI_DATA_HUB_FILTER_DRIVER  Returned if Event stored in the Head doubly linked list.\r
-  @retval NULL                        If Event is not in the list\r
-\r
-**/\r
-DATA_HUB_FILTER_DRIVER *\r
-FindFilterDriverByEvent (\r
-  IN  LIST_ENTRY      *Head,\r
-  IN  EFI_EVENT       Event\r
-  )\r
-{\r
-  DATA_HUB_FILTER_DRIVER  *FilterEntry;\r
-  LIST_ENTRY              *Link;\r
-\r
-  for (Link = GetFirstNode(Head); Link != Head; Link = GetNextNode(Head, Link)) {\r
-    FilterEntry = FILTER_ENTRY_FROM_LINK (Link);\r
-    if (FilterEntry->Event == Event) {\r
-      return FilterEntry;\r
-    }\r
-  }\r
-\r
-  return NULL;\r
-}\r
-\r
-/**\r
-  Search the Head doubly linked list for the passed in MTC. Return the \r
-  matching element in Head and the MTC on the next entry.\r
-\r
-  @param Head             Head of Data Log linked list.\r
-  @param ClassFilter      Only match the MTC if it is in the same Class as the\r
-                          ClassFilter.\r
-  @param PtrCurrentMTC    On IN contians MTC to search for. On OUT contians next\r
-                          MTC in the data log list or zero if at end of the list.\r
-  \r
-  @retval EFI_DATA_LOG_ENTRY  Return pointer to data log data from Head list.\r
-  @retval NULL                If no data record exists.\r
-\r
-**/\r
-EFI_DATA_RECORD_HEADER *\r
-GetNextDataRecord (\r
-  IN  LIST_ENTRY          *Head,\r
-  IN  UINT64              ClassFilter,\r
-  IN OUT  UINT64          *PtrCurrentMTC\r
-  )\r
-\r
-{\r
-  EFI_DATA_ENTRY          *LogEntry;\r
-  LIST_ENTRY              *Link;\r
-  BOOLEAN                 ReturnFirstEntry;\r
-  EFI_DATA_RECORD_HEADER  *Record;\r
-  EFI_DATA_ENTRY          *NextLogEntry;\r
-\r
-  //\r
-  // If MonotonicCount == 0 just return the first one\r
-  //\r
-  ReturnFirstEntry  = (BOOLEAN) (*PtrCurrentMTC == 0);\r
-\r
-  Record            = NULL;\r
-  for (Link = GetFirstNode(Head); Link != Head; Link = GetNextNode(Head, Link)) {\r
-    LogEntry = DATA_ENTRY_FROM_LINK (Link);\r
-    if ((LogEntry->Record->DataRecordClass & ClassFilter) == 0) {\r
-      //\r
-      // Skip any entry that does not have the correct ClassFilter\r
-      //\r
-      continue;\r
-    }\r
-\r
-    if ((LogEntry->Record->LogMonotonicCount == *PtrCurrentMTC) || ReturnFirstEntry) {\r
-      //\r
-      // Return record to the user\r
-      //\r
-      Record = LogEntry->Record;\r
-\r
-      //\r
-      // Calculate the next MTC value. If there is no next entry set\r
-      // MTC to zero.\r
-      //\r
-      *PtrCurrentMTC = 0;\r
-      for (Link = GetNextNode(Head, Link); Link != Head; Link = GetNextNode(Head, Link)) {\r
-        NextLogEntry = DATA_ENTRY_FROM_LINK (Link);\r
-        if ((NextLogEntry->Record->DataRecordClass & ClassFilter) != 0) {\r
-          //\r
-          // Return the MTC of the next thing to search for if found\r
-          //\r
-          *PtrCurrentMTC = NextLogEntry->Record->LogMonotonicCount;\r
-          break;\r
-        }\r
-      }\r
-      //\r
-      // Record found exit loop and return\r
-      //\r
-      break;\r
-    }\r
-  }\r
 \r
-  return Record;\r
-}\r
 \r
 /**\r
   Driver's Entry point routine that install Driver to produce Data Hub protocol. \r

diff --git a/IntelFrameworkModulePkg/Universal/DataHubDxe/DataHub.h b/IntelFrameworkModulePkg/Universal/DataHubDxe/DataHub.h
index ebd0d08fa204736299b5bd9205f37df58a37a49f..6b0885df51764898b8b764d98069756fff6564b3 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/DataHubDxe/DataHub.h
+++ b/IntelFrameworkModulePkg/Universal/DataHubDxe/DataHub.h
@@ -1,4 +1,4 @@
-/**@file\r
+/** @file\r
   This code supports a the private implementation \r
   of the Data Hub protocol\r
   \r

diff --git a/IntelFrameworkModulePkg/Universal/DataHubStdErrDxe/DataHubStdErr.c b/IntelFrameworkModulePkg/Universal/DataHubStdErrDxe/DataHubStdErr.c
index d814c6716d993c21665d626b3f39f6a10dcf9a4d..7dd893b3b8eb709a35207710937e83fd6806b6bc 100644 (file)
--- a/IntelFrameworkModulePkg/Universal/DataHubStdErrDxe/DataHubStdErr.c
+++ b/IntelFrameworkModulePkg/Universal/DataHubStdErrDxe/DataHubStdErr.c
@@ -1,4 +1,4 @@
-/**@file\r
+/** @file\r
   Data Hub filter driver that takes DEBUG () info from Data Hub and writes it\r
   to StdErr if it exists.\r
 \r