Update For R9 Review.

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

5 files changed, 74 insertions, 20 deletions

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/ComponentName.h b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/ComponentName.h
index cce33cf36a..35cc252bd5 100644
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/ComponentName.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/ComponentName.h
@@ -10,8 +10,8 @@
 

 **/

 

-#ifndef _IDE_BUS_COMPONENT_NAME_H

-#define _IDE_BUS_COMPONENT_NAME_H

+#ifndef _IDE_BUS_COMPONENT_NAME_H_

+#define _IDE_BUS_COMPONENT_NAME_H_

 

 #define ADD_NAME(x) AddName ((x));

 

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ide.h b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ide.h
index 71ab6ecd75..f2cc9df454 100644
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ide.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/Ide.h
@@ -18,8 +18,8 @@
 

 **/

 

-#ifndef _IDE_H

-#define _IDE_H

+#ifndef _IDE_H_

+#define _IDE_H_

 

 //

 // Helper functions Prototype

@@ -118,7 +118,7 @@ IDEWritePortB (
   @param  Port TODO: add argument description

   @param  Data TODO: add argument description

 

-  TODO: add return values

+  TODO: add return values.

 

 **/

 VOID

@@ -442,7 +442,7 @@ AtaPioDataOut (
 

   @param  IdeDev TODO: add argument description

 

-  TODO: add return values

+  TODO: add return values.

 

 **/

 EFI_STATUS

@@ -1242,10 +1242,8 @@ EnableInterrupt (
 /**

   Clear pending IDE interrupt before OS loader/kernel take control of the IDE device.

 

-  @param[in]  Event   Pointer to this event

-  @param[in]  Context Event hanlder private data

-

-  @retval  EFI_SUCCESS - Interrupt cleared.

+  @param[in]  Event   Pointer to this event.

+  @param[in]  Context Event hanlder private data.

 

 **/

 VOID

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.c b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.c
index e864eccc31..3d54691514 100644
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.c
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.c
@@ -1042,9 +1042,12 @@ DeRegisterIdeDevice (
 // ***********************************************************************************

 //

 /**

-  TODO:    This - add argument and description to function comment

-  TODO:    ExtendedVerification - add argument and description to function comment

-  TODO:    EFI_DEVICE_ERROR - add return value to function comment

+  GC_TODO: Add function description

+

+  @param  This                  GC_TODO: add argument description.

+  @param  ExtendedVerification  GC_TODO: add argument description.

+

+  @retval EFI_DEVICE_ERROR      GC_TODO: Add description for return value.

 

 **/

 EFI_STATUS

@@ -1244,8 +1247,12 @@ Done:
 // ***********************************************************************************

 //

 /**

-  TODO:    This - add argument and description to function comment

-  TODO:    EFI_SUCCESS - add return value to function comment

+  TODO: Add function description

+

+  @param  This TODO: add argument description

+

+  @retval EFI_SUCCESS   GC_TODO: Add description for return value.

+

 **/

 EFI_STATUS

 EFIAPI

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h
index f4ec71594d..9b5a5d6b7e 100644
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeBus.h
@@ -12,8 +12,8 @@
 

 **/

 

-#ifndef _IDE_BUS_H

-#define _IDE_BUS_H

+#ifndef _IDE_BUS_H_

+#define _IDE_BUS_H_

 

 

 

@@ -196,6 +196,18 @@ IDEBusDriverBindingStop (
 //

 // EFI Driver Configuration Functions

 //

+/**

+  TODO: Add function description

+

+  @param  This                 TODO: add argument description

+  @param  ControllerHandle     TODO: add argument description

+  @param  ChildHandle          TODO: add argument description

+  @param  Language             TODO: add argument description

+  @param  ActionRequired       TODO: add argument description

+

+  TODO: add return values.

+

+**/

 EFI_STATUS

 IDEBusDriverConfigurationSetOptions (

   IN  EFI_DRIVER_CONFIGURATION_PROTOCOL                      *This,

@@ -205,6 +217,16 @@ IDEBusDriverConfigurationSetOptions (
   OUT EFI_DRIVER_CONFIGURATION_ACTION_REQUIRED               *ActionRequired

   );

 

+/**

+  TODO: Add function description

+

+  @param  This                 TODO: add argument description

+  @param  ControllerHandle     TODO: add argument description

+  @param  ChildHandle          TODO: add argument description

+

+  TODO: add return values.

+

+**/

 EFI_STATUS

 IDEBusDriverConfigurationOptionsValid (

   IN  EFI_DRIVER_CONFIGURATION_PROTOCOL               *This,

@@ -212,6 +234,18 @@ IDEBusDriverConfigurationOptionsValid (
   IN  EFI_HANDLE                                      ChildHandle  OPTIONAL

   );

 

+/**

+  TODO: Add function description

+

+  @param  This                 TODO: add argument description

+  @param  ControllerHandle     TODO: add argument description

+  @param  ChildHandle          TODO: add argument description

+  @param  DefaultType          TODO: add argument description

+  @param  ActionRequired       TODO: add argument description

+

+  TODO: add return values.

+

+**/

 EFI_STATUS

 IDEBusDriverConfigurationForceDefaults (

   IN  EFI_DRIVER_CONFIGURATION_PROTOCOL                      *This,

@@ -224,6 +258,21 @@ IDEBusDriverConfigurationForceDefaults (
 //

 // EFI Driver Diagnostics Functions

 //

+/**

+  TODO: Add function description

+

+  @param  This                 TODO: add argument description

+  @param  ControllerHandle     TODO: add argument description

+  @param  ChildHandle          TODO: add argument description

+  @param  DiagnosticType       TODO: add argument description

+  @param  Language             TODO: add argument description

+  @param  ErrorType            TODO: add argument description

+  @param  BufferSize           TODO: add argument description

+  @param  Buffer               TODO: add argument description

+

+  TODO: add return values.

+

+**/

 EFI_STATUS

 IDEBusDriverDiagnosticsRunDiagnostics (

   IN  EFI_DRIVER_DIAGNOSTICS_PROTOCOL               *This,

@@ -264,7 +313,7 @@ IDEBlkIoReset (
   @param  BufferSize TODO: add argument description

   @param  Buffer TODO: add argument description

 

-  TODO: add return values

+  TODO: add return values.

 

 **/

 EFI_STATUS

diff --git a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeData.h b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeData.h
index 83a42af6b1..e4bc4f71fd 100644
--- a/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeData.h
+++ b/IntelFrameworkModulePkg/Bus/Pci/IdeBusDxe/IdeData.h
@@ -12,8 +12,8 @@
 

 **/

 

-#ifndef _IDE_DATA_H

-#define _IDE_DATA_H

+#ifndef _IDE_DATA_H_

+#define _IDE_DATA_H_

 

 #include <IndustryStandard/Atapi.h>