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:
@@ -814,107 +814,9 @@ EFI_STATUS
|
||||
|
||||
|
||||
|
||||
//
|
||||
// Interface structure for the PCD PPI
|
||||
//
|
||||
/**
|
||||
@par Ppi Description:
|
||||
This service abstracts the ability to set/get Platform Configuration Database (PCD).
|
||||
|
||||
@param SetSku
|
||||
Sets the SKU value for subsequent calls to set or get PCD token values.
|
||||
|
||||
@param Get8
|
||||
Retrieves an 8-bit value for a given PCD token.
|
||||
|
||||
@param Get16
|
||||
Retrieves an 16-bit value for a given PCD token.
|
||||
|
||||
@param Get32
|
||||
Retrieves an 32-bit value for a given PCD token.
|
||||
|
||||
@param Get64
|
||||
Retrieves an 64-bit value for a given PCD token.
|
||||
|
||||
@param GetPtr
|
||||
Retrieves a pointer to a value for a given PCD token.
|
||||
|
||||
@param GetBool
|
||||
Retrieves an Boolean value for a given PCD token.
|
||||
|
||||
@param GetSize
|
||||
Retrieves the size of the value for a given PCD token.
|
||||
|
||||
@param Get8Ex
|
||||
Retrieves an 8-bit value for a given PCD token and token space.
|
||||
|
||||
@param Get16Ex
|
||||
Retrieves an 16-bit value for a given PCD token and token space.
|
||||
|
||||
@param Get32Ex
|
||||
Retrieves an 32-bit value for a given PCD token and token space.
|
||||
|
||||
@param Get64Ex
|
||||
Retrieves an 64-bit value for a given PCD token and token space.
|
||||
|
||||
@param GetPtrEx
|
||||
Retrieves a pointer to a value for a given PCD token and token space.
|
||||
|
||||
@param GetBoolEx
|
||||
Retrieves an Boolean value for a given PCD token and token space.
|
||||
|
||||
@param GetSizeEx
|
||||
Retrieves the size of the value for a given PCD token and token space.
|
||||
|
||||
@param Set8
|
||||
Sets an 8-bit value for a given PCD token.
|
||||
|
||||
@param Set16
|
||||
Sets an 16-bit value for a given PCD token.
|
||||
|
||||
@param Set32
|
||||
Sets an 32-bit value for a given PCD token.
|
||||
|
||||
@param Set64
|
||||
Sets an 64-bit value for a given PCD token.
|
||||
|
||||
@param SetPtr
|
||||
Sets the buffer of a specified size for a given PCD token.
|
||||
|
||||
@param SetBool
|
||||
Sets an Boolean value for a given PCD token.
|
||||
|
||||
@param Set8Ex
|
||||
Sets an 8-bit value for a given PCD token and token space.
|
||||
|
||||
@param Set16Ex
|
||||
Sets an 16-bit value for a given PCD token and token space.
|
||||
|
||||
@param Set32Ex
|
||||
Sets an 32-bit value for a given PCD token and token space.
|
||||
|
||||
@param Set64Ex
|
||||
Sets an 64-bit value for a given PCD token and token space.
|
||||
|
||||
@param SetPtrEx
|
||||
Sets the buffer of a specified size for a given PCD token and token space.
|
||||
|
||||
@param SetBoolEx
|
||||
Sets an Boolean value for a given PCD token and token space.
|
||||
|
||||
@param CallbackOnSet
|
||||
Specifies a function to be called anytime the value of a designated token is changed.
|
||||
|
||||
@param CancelCallback
|
||||
Cancels a previously set callback function for a particular PCD token number.
|
||||
|
||||
@param GetNextToken
|
||||
Retrieves the next valid PCD token for a given namespace.
|
||||
|
||||
@param GetNextTokenSpace
|
||||
Retrieves the next valid PCD token namespace for a given namespace.
|
||||
|
||||
**/
|
||||
///
|
||||
/// This service abstracts the ability to set/get Platform Configuration Database (PCD).
|
||||
///
|
||||
typedef struct {
|
||||
PCD_PPI_SET_SKU SetSku;
|
||||
|
||||
|
Reference in New Issue
Block a user