Formalize comments for Protocols and PPIs.

1. Use doxygen format for Protocol/PPI data structure
2. Remove doxygen comments for function elements in Protocol/Ppi
3. Use doxygen format for data elements in Protocol/Ppi, and add missing comments where necessary
4. PEI Services Table is also updated accordingly.

git-svn-id: https://edk2.svn.sourceforge.net/svnroot/edk2/trunk/edk2@6107 6f19259b-4bc3-4df7-8a09-765794883524
This commit is contained in:
xli24
2008-10-13 02:54:29 +00:00
parent 66eebcf94f
commit 44717a398f
103 changed files with 576 additions and 1012 deletions

View File

@@ -46,22 +46,17 @@ UINT32
IN EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL *This
);
/**
@par Protocol Description:
When installed, the Driver Family Override Protocol produces a GUID that represets
a family of drivers. Drivers with the same GUID are members of the same family
When drivers are connected to controllers, drivers with a higher revision value
in the same driver family are connected with a higher priority than drivers
with a lower revision value in the same driver family. The EFI Boot Service
Connect Controller uses five rules to build a prioritied list of drivers when
a request is made to connect a driver to a controller. The Driver Family Protocol
rule is between the Platform Specific Driver Override Protocol and above the
Bus Specific Driver Override Protocol.
@param GetVersion
This function returns the version value associated with the driver specified by This.
**/
///
/// When installed, the Driver Family Override Protocol produces a GUID that represets
/// a family of drivers. Drivers with the same GUID are members of the same family
/// When drivers are connected to controllers, drivers with a higher revision value
/// in the same driver family are connected with a higher priority than drivers
/// with a lower revision value in the same driver family. The EFI Boot Service
/// Connect Controller uses five rules to build a prioritied list of drivers when
/// a request is made to connect a driver to a controller. The Driver Family Protocol
/// rule is between the Platform Specific Driver Override Protocol and above the
/// Bus Specific Driver Override Protocol.
///
struct _EFI_DRIVER_FAMILY_OVERRIDE_PROTOCOL {
EFI_DRIVER_FAMILY_OVERRIDE_GET_VERSION GetVersion;
};