Fix doxygen comment for structure and macro
authorklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 9 Oct 2008 18:33:40 +0000 (18:33 +0000)
committerklu2 <klu2@6f19259b-4bc3-4df7-8a09-765794883524>
Thu, 9 Oct 2008 18:33:40 +0000 (18:33 +0000)
git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6095 6f19259b-4bc3-4df7-8a09-765794883524

MdePkg/Include/Protocol/GuidedSectionExtraction.h
MdePkg/Include/Protocol/Hash.h
MdePkg/Include/Protocol/HiiConfigAccess.h
MdePkg/Include/Protocol/HiiConfigRouting.h
MdePkg/Include/Protocol/HiiDatabase.h
MdePkg/Include/Protocol/HiiFont.h
MdePkg/Include/Protocol/HiiImage.h
MdePkg/Include/Protocol/HiiString.h
MdePkg/Include/Protocol/IScsiInitiatorName.h
MdePkg/Include/Protocol/Ip4.h
MdePkg/Include/Protocol/Ip4Config.h

index 7c95b1a..23f8754 100644 (file)
@@ -133,10 +133,6 @@ EFI_STATUS
   of the GUIDed Section Extraction Protocol must have the same interface structure, they do not all\r
   have the same GUID. The GUID that is associated with an instance of the GUIDed Section\r
   Extraction Protocol is used to correlate it with the GUIDed section type that it is intended to process.\r
-\r
-  @param ExtractSection\r
-  Takes the GUIDed section as input and produces the section stream data.\r
-\r
 **/\r
 struct _EFI_GUIDED_SECTION_EXTRACTION_PROTOCOL {\r
   EFI_EXTRACT_GUIDED_SECTION  ExtractSection;\r
index bb4d651..1467235 100644 (file)
@@ -132,13 +132,6 @@ EFI_STATUS
   @par Protocol Description:\r
   This protocol allows creating a hash of an arbitrary message digest \r
   using one or more hash algorithms.\r
-\r
-  @param GetHashSize\r
-  Return the size of a specific type of resulting hash.\r
-  \r
-  @param Hash\r
-  Create a hash for the specified message.\r
-\r
 **/\r
 struct _EFI_HASH_PROTOCOL {\r
   EFI_HASH_GET_HASH_SIZE          GetHashSize;\r
index 0af0190..fbe0315 100644 (file)
@@ -198,26 +198,12 @@ EFI_STATUS
   OUT EFI_BROWSER_ACTION_REQUEST             *ActionRequest\r
   )\r
   ;\r
+  \r
 /**\r
   @par Protocol Description:   \r
   This protocol provides a callable interface between the HII and\r
   drivers. Only drivers which provide IFR data to HII are required\r
   to publish this protocol.\r
-\r
-  @param ExtractConfig  This function breaks apart the UNICODE\r
-                        request strings routing them to the\r
-                        appropriate drivers. This function is\r
-                        analogous to the similarly named\r
-                        function in the HII Routing Protocol.\r
-  \r
-  @param RouteConfig    This function breaks apart the UNICODE\r
-                        results strings and returns configuration\r
-                        information as specified by the request.\r
-  \r
-  @param Callback       This function is called from the\r
-                        configuration browser to communicate certain\r
-                        activities that were initiated by a user.\r
-\r
 **/\r
 struct _EFI_HII_CONFIG_ACCESS_PROTOCOL {\r
   EFI_HII_ACCESS_EXTRACT_CONFIG     ExtractConfig;\r
index 176e096..93ff5d0 100644 (file)
@@ -25,7 +25,6 @@
 \r
 typedef struct _EFI_HII_CONFIG_ROUTING_PROTOCOL EFI_HII_CONFIG_ROUTING_PROTOCOL;\r
 \r
-\r
 /**\r
    \r
   This function allows the caller to request the current\r
@@ -396,32 +395,6 @@ EFI_STATUS
   This protocol defines the configuration routing interfaces\r
   between external applications and the HII. There may only be one\r
   instance of this protocol in the system.\r
-  \r
-  @param ExtractConfig\r
-  This function allows a caller to extract the current configuration for \r
-  one or more named elements from one or more drivers.\r
-\r
-  @param ExportConfig\r
-  This function allows the caller to request the current configuration for \r
-  the entirety of the current HII database and returns the data \r
-  in a null-terminated Unicode string.\r
-\r
-  @param RouteConfig\r
-  This function processes the results of processing forms and routes it \r
-  to the appropriate handlers or storage.\r
-\r
-  @param BlockToConfig\r
-  This helper function is to be called by drivers to map configuration data \r
-  stored in byte array ("block") formats such as UEFI Variables into current \r
-  configuration strings.\r
-\r
-  @param ConfigToBlock\r
-  This helper function is to be called by drivers to map configuration strings \r
-  to configurations stored in byte array ("block") formats such as UEFI Variables.\r
-\r
-  @param GetAltConfig\r
-  This helper function is to be called by drivers to extract portions of a larger configuration string.\r
-\r
 **/\r
 struct _EFI_HII_CONFIG_ROUTING_PROTOCOL {\r
   EFI_HII_ROUTING_EXTRACT_CONFIG  ExtractConfig;\r
index 210dd87..7ccc925 100644 (file)
 typedef struct _EFI_HII_DATABASE_PROTOCOL EFI_HII_DATABASE_PROTOCOL;\r
 \r
 \r
-//\r
-// EFI_HII_DATABASE_NOTIFY_TYPE\r
-// \r
+///\r
+/// EFI_HII_DATABASE_NOTIFY_TYPE\r
+/// \r
 typedef UINTN   EFI_HII_DATABASE_NOTIFY_TYPE;\r
+\r
 #define EFI_HII_DATABASE_NOTIFY_NEW_PACK    0x00000001\r
 #define EFI_HII_DATABASE_NOTIFY_REMOVE_PACK 0x00000002\r
 #define EFI_HII_DATABASE_NOTIFY_EXPORT_PACK 0x00000004\r
@@ -493,46 +494,10 @@ EFI_STATUS
 /**\r
   @par Protocol Description:\r
   Database manager for HII-related data structures.\r
-\r
-  @param NewPackageList     Add a new package list to the HII database.\r
-\r
-  @param RemovePackageList  Remove a package list from the HII\r
-                            database.\r
-\r
-  @param UpdatePackageList  Update a package list in the HII\r
-                            database.\r
-\r
-  @param ListPackageLists   List the handles of the package\r
-                            lists within the HII database. \r
-\r
-  @param ExportPackageLists Export package lists from the HII\r
-                            database.\r
-\r
-  @param RegisterPackageNotify  \r
-                            Register notification when\r
-                            packages of a certain type are\r
-                            installed.\r
-\r
-  @param UnregisterPackageNotify \r
-                            Unregister notification of packages.\r
-\r
-  @param FindKeyboardLayouts  \r
-                            Retrieves a list of the keyboard\r
-                            layouts in the system.\r
-\r
-  @param GetKeyboardLayout  Allows a program to extract the\r
-                            current keyboard layout. See the\r
-                            GetKeyboardLayout() function\r
-                            description.\r
-\r
-  @param SetKeyboardLayout  Changes the current keyboard layout.\r
-                            See the SetKeyboardLayout() function\r
-\r
-\r
 **/\r
 struct _EFI_HII_DATABASE_PROTOCOL {\r
-  EFI_HII_DATABASE_NEW_PACK                    NewPackageList;\r
-  EFI_HII_DATABASE_REMOVE_PACK                 RemovePackageList;\r
+  EFI_HII_DATABASE_NEW_PACK           NewPackageList;\r
+  EFI_HII_DATABASE_REMOVE_PACK        RemovePackageList;\r
   EFI_HII_DATABASE_UPDATE_PACK        UpdatePackageList;\r
   EFI_HII_DATABASE_LIST_PACKS         ListPackageLists;\r
   EFI_HII_DATABASE_EXPORT_PACKS       ExportPackageLists;\r
index f2da306..02cab77 100644 (file)
@@ -25,10 +25,11 @@ typedef struct _EFI_HII_FONT_PROTOCOL EFI_HII_FONT_PROTOCOL;
 \r
 typedef VOID    *EFI_FONT_HANDLE;\r
 \r
-//\r
-// EFI_HII_OUT_FLAGS\r
-// \r
+///\r
+/// EFI_HII_OUT_FLAGS\r
+/// \r
 typedef UINT32  EFI_HII_OUT_FLAGS;\r
+\r
 #define EFI_HII_OUT_FLAG_CLIP         0x00000001\r
 #define EFI_HII_OUT_FLAG_WRAP         0x00000002\r
 #define EFI_HII_OUT_FLAG_CLIP_CLEAN_Y 0x00000004\r
@@ -39,38 +40,32 @@ typedef UINT32  EFI_HII_OUT_FLAGS;
 #define EFI_HII_DIRECT_TO_SCREEN      0x00000080\r
 \r
 /**\r
-\r
   Definition of EFI_HII_ROW_INFO.\r
-\r
-  @param StartIndex     The index of the first character in the\r
-                        string which is displayed on the line.\r
-\r
-  @param EndIndex       The index of the last character in the string\r
-                        which is displayed on the line. If this is the\r
-                        same as StartIndex, then no characters are\r
-                        displayed.\r
-\r
-  @param LineHeight     The height of the line, in pixels.\r
-\r
-  @param LineWidth      The width of the text on the line, in pixels.\r
-\r
-  @param BaselineOffset The number of pixels above the bottom of\r
-                        the row of the font baseline or 0 if\r
-                        none.\r
-\r
 **/\r
 typedef struct _EFI_HII_ROW_INFO {\r
+  ///\r
+  /// The index of the first character in the string which is displayed on the line.\r
+  ///\r
   UINTN   StartIndex;\r
+  ///\r
+  /// The index of the last character in the string which is displayed on the line.\r
+  /// If this is the same as StartIndex, then no characters are displayed.  \r
+  ///\r
   UINTN   EndIndex;\r
-  UINTN   LineHeight;\r
-  UINTN   LineWidth;\r
+  UINTN   LineHeight; ///< The height of the line, in pixels.\r
+  UINTN   LineWidth;  ///< The width of the text on the line, in pixels.\r
+  \r
+  ///\r
+  /// The number of pixels above the bottom of the row of the font baseline or 0 if none.  \r
+  ///\r
   UINTN   BaselineOffset;\r
 } EFI_HII_ROW_INFO;\r
 \r
-//\r
-// EFI_FONT_INFO_MASK\r
-// \r
+///\r
+/// EFI_FONT_INFO_MASK\r
+/// \r
 typedef UINT32  EFI_FONT_INFO_MASK;\r
+\r
 #define EFI_FONT_INFO_SYS_FONT        0x00000001\r
 #define EFI_FONT_INFO_SYS_SIZE        0x00000002\r
 #define EFI_FONT_INFO_SYS_STYLE       0x00000004\r
@@ -87,7 +82,7 @@ typedef UINT32  EFI_FONT_INFO_MASK;
 // \r
 typedef struct {\r
   EFI_HII_FONT_STYLE FontStyle;\r
-  UINT16             FontSize; // character cell height in pixels\r
+  UINT16             FontSize;      ///< character cell height in pixels\r
   CHAR16             FontName[1];\r
 } EFI_FONT_INFO;\r
 \r
@@ -127,22 +122,6 @@ typedef struct {
   EFI_FONT_INFO_ANY_STYLE is specified, then the system may\r
   attempt to match with any font style. This flag cannot be used\r
   with EFI_FONT_INFO_SYS_STYLE or EFI_FONT_INFO_RESTYLE.\r
-\r
-\r
-  @param ForegroundColor  The color of the "on" pixels in the\r
-                          glyph in the bitmap.\r
-  \r
-  @param BackgroundColor  The color of the "off" pixels in the\r
-                          glyph in the bitmap.\r
-  \r
-  @param FontInfoMask     The font information mask determines\r
-                          which portion of the font information\r
-                          will be used and what to do if the\r
-                          specific font is not available.\r
-\r
-  @param FontInfo         Points to the font information or NULL if the\r
-                          string should use the default system font.\r
-    \r
 **/\r
 typedef struct _EFI_FONT_DISPLAY_INFO {\r
   EFI_GRAPHICS_OUTPUT_BLT_PIXEL ForegroundColor;\r
@@ -503,15 +482,6 @@ EFI_STATUS
 /**\r
   @par Protocol Description:\r
   The protocol provides the service to retrieve the font informations.\r
-\r
-  @param StringToImage    Render a string to a bitmap or to the display.\r
-\r
-  @param StringIdToImage  Render a string to a bitmap or to the display.\r
-\r
-  @param GetGlyph         Return a specific glyph in a specific font.\r
-\r
-  @param GetFontInfo      Return font information for a specific font.\r
-\r
 **/\r
 struct _EFI_HII_FONT_PROTOCOL {\r
   EFI_HII_STRING_TO_IMAGE     StringToImage;\r
index 0cc6445..5e65aa3 100644 (file)
@@ -339,19 +339,6 @@ IN        UINTN                   BltY
 /**\r
   @par Protocol Description:  \r
   Services to access to images in the images database.\r
-\r
-  @param NewImage    Add a new image.\r
-\r
-  @param GetImage    Retrieve an image and related font\r
-                     information.\r
-\r
-  @param SetImage    Change an image.\r
-  \r
-  @param DrawImage   Renders an image to a bitmap or to the display.\r
-  \r
-  @param DrawImageId Render an image to a bitmap or the screen containing \r
-                     the contents of the specified image.\r
-\r
 **/\r
 struct _EFI_HII_IMAGE_PROTOCOL {\r
   EFI_HII_NEW_IMAGE     NewImage;\r
index 4e48e75..79dc934 100644 (file)
@@ -217,19 +217,6 @@ EFI_STATUS
 /**\r
   @par Protocol Description:\r
   Services to manipulate the string.\r
-   \r
-  @param NewString              Add a new string. GetString Retrieve a\r
-                                string and related string information.\r
-\r
-  @param SetString              Change a string. \r
-\r
-  @param GetLanguages           List the languages for a particular\r
-                                package list.\r
-\r
-  @param GetSecondaryLanguages  List supported secondary\r
-                                languages for a particular\r
-                                primary language.\r
-\r
 **/\r
 struct _EFI_HII_STRING_PROTOCOL {\r
   EFI_HII_NEW_STRING        NewString;\r
index e760bff..8982739 100644 (file)
@@ -74,11 +74,6 @@ typedef EFI_STATUS
 /**  \r
   @par Protocol Description:\r
   iSCSI Initiator Name Protocol for setting and obtaining the iSCSI Initiator Name. \r
-  \r
-  @param Get Used to retrieve the iSCSI Initiator Name.\r
-\r
-  @param Set Used to set the iSCSI Initiator Name.\r
-\r
 **/\r
 struct _EFI_ISCSI_INITIATOR_NAME_PROTOCOL {\r
   EFI_ISCSI_INITIATOR_NAME_GET         Get;\r
index 215a3ce..df6fd03 100644 (file)
@@ -398,30 +398,6 @@ EFI_STATUS
   @par Protocol Description:\r
   The EFI IPv4 Protocol implements a simple packet-oriented interface that can be \r
   used by drivers, daemons, and applications to transmit and receive network packets.\r
-  \r
-  @param GetModeData\r
-  Gets the current operational settings for this instance of the EFI IPv4 Protocol driver. \r
-\r
-  @param Configure\r
-  Changes or resets the operational settings for the EFI IPv4 Protocol. \r
-\r
-  @param Groups\r
-  Joins and leaves multicast groups. \r
-\r
-  @param Routes\r
-  Adds and deletes routing table entries. \r
-\r
-  @param Transmit\r
-  Places outgoing data packets into the transmit queue. \r
-\r
-  @param Receive\r
-  Places a receiving request into the receiving queue. \r
-\r
-  @param Cancel\r
-  Aborts a pending transmit or receive request. \r
-\r
-  @param Poll\r
-  Polls for incoming data packets and processes outgoing data packets. \r
 **/\r
 struct _EFI_IP4_PROTOCOL {\r
   EFI_IP4_GET_MODE_DATA        GetModeData;\r
index 444be53..4dfe98b 100644 (file)
@@ -114,16 +114,6 @@ EFI_STATUS
   @par Protocol Description:\r
   The EFI_IP4_CONFIG_PROTOCOL driver performs platform- and policy-dependent \r
   configuration for the EFI IPv4 Protocol driver. \r
-  \r
-  @param Start\r
-  Starts running the configuration policy for the EFI IPv4 Protocol driver. \r
-\r
-  @param Stop\r
-  Stops running the configuration policy for the EFI IPv4 Protocol driver. \r
-\r
-  @param GetData\r
-  Returns the default configuration data (if any) for the EFI IPv4 Protocol driver.  \r
-\r
 **/\r
 struct _EFI_IP4_CONFIG_PROTOCOL {\r
   EFI_IP4_CONFIG_START         Start;\r