Formalize comments for Protocols and PPIs.

[mirror_edk2.git] / MdePkg / Include / Protocol / LoadedImage.h

diff --git a/MdePkg/Include/Protocol/LoadedImage.h b/MdePkg/Include/Protocol/LoadedImage.h
index ecf182662477ea43e4fea691a70e595ece13c804..c31b27545ad5f4d7b576f5d6e2a3de8805e38904 100644 (file)
--- a/MdePkg/Include/Protocol/LoadedImage.h
+++ b/MdePkg/Include/Protocol/LoadedImage.h
@@ -45,82 +45,78 @@
 /// \r
 #define EFI_LOADED_IMAGE_INFORMATION_REVISION    EFI_LOADED_IMAGE_PROTOCOL_REVISION\r
 \r
-/**  \r
-  @par Protocol Description:\r
-  Can be used on any image handle to obtain information about the loaded image.\r
-\r
-  @param Revision\r
-  Defines the revision of the EFI_LOADED_IMAGE_PROTOCOL structure. \r
-  All future revisions will be backward compatible to the current revision.\r
-\r
-  @param ParentHandle\r
-  Parent image's image handle. NULL if the image is loaded directly from \r
-  the firmware's boot manager. \r
-\r
-  @param SystemTable\r
-  The image's EFI system table pointer. \r
-\r
-  @param DeviceHandle\r
-  The device handle that the EFI Image was loaded from. \r
-\r
-  @param FilePath\r
-  A pointer to the file path portion specific to DeviceHandle \r
-  that the EFI Image was loaded from. \r
-\r
-  @param Reserved\r
-  Reserved. DO NOT USE.\r
-\r
-  @param LoadOptionsSize\r
-  The size in bytes of LoadOptions.\r
-\r
-  @param LoadOptions\r
-  A pointer to the image's binary load options.\r
-\r
-  @param ImageBase\r
-  The base address at which the image was loaded.\r
-\r
-  @param ImageSize\r
-  The size in bytes of the loaded image.\r
-\r
-  @param ImageCodeType\r
-  The memory \r
-\r
-  @param ImageDataType\r
-  The memory \r
-\r
-  @param Unload\r
-  Function that unloads the image. \r
-\r
-**/\r
+///\r
+/// Can be used on any image handle to obtain information about the loaded image.\r
+///\r
 typedef struct {\r
+  ///\r
+  /// Defines the revision of the EFI_LOADED_IMAGE_PROTOCOL structure. \r
+  /// All future revisions will be backward compatible to the current revision.\r
+  ///\r
   UINT32                    Revision;\r
+\r
+  ///\r
+  /// Parent image's image handle. NULL if the image is loaded directly from \r
+  /// the firmware's boot manager. \r
+  ///\r
   EFI_HANDLE                ParentHandle;\r
+\r
+  ///\r
+  /// the image's EFI system table pointer.\r
+  ///\r
   EFI_SYSTEM_TABLE          *SystemTable;\r
 \r
   //\r
   // Source location of image\r
   //\r
+  ///\r
+  /// The device handle that the EFI Image was loaded from. \r
+  ///\r
   EFI_HANDLE                DeviceHandle;\r
+  \r
+  ///\r
+  /// A pointer to the file path portion specific to DeviceHandle \r
+  /// that the EFI Image was loaded from. \r
+  ///\r
   EFI_DEVICE_PATH_PROTOCOL  *FilePath;\r
-  VOID                      *Reserved;\r
+  VOID                      *Reserved;       ///< Reserved. DO NOT USE.\r
 \r
   //\r
   // Images load options\r
   //\r
+  ///\r
+  /// The size in bytes of LoadOptions.\r
+  ///\r
   UINT32                    LoadOptionsSize;\r
+  \r
+  ///\r
+  /// A pointer to the image's binary load options.\r
+  ///\r
   VOID                      *LoadOptions;\r
 \r
   //\r
   // Location of where image was loaded\r
   //\r
+  ///\r
+  /// The base address at which the image was loaded.\r
+  ///\r
   VOID                      *ImageBase;\r
+  \r
+  ///\r
+  /// The size in bytes of the loaded image.\r
+  ///\r
   UINT64                    ImageSize;\r
+\r
+  ///\r
+  /// The memory type that the code sections were loaded as.\r
+  ///\r
   EFI_MEMORY_TYPE           ImageCodeType;\r
+\r
+  ///\r
+  /// The memory type that the data sections were loaded as.\r
+  ///\r
   EFI_MEMORY_TYPE           ImageDataType;\r
 \r
-  //\r
-  // If the driver image supports a dynamic unload request\r
-  //\r
   EFI_IMAGE_UNLOAD          Unload;\r
 \r
 } EFI_LOADED_IMAGE_PROTOCOL;\r