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

@@ -383,77 +383,27 @@ VOID
/// The perspective of the services is that of the processor, not the bus or system.
///
struct _EFI_PEI_CPU_IO_PPI {
///
/// Collection of memory-access services.
///
EFI_PEI_CPU_IO_PPI_ACCESS Mem;
///
/// Collection of I/O-access services.
///
EFI_PEI_CPU_IO_PPI_ACCESS Io;
///
/// 8-bit I/O read service.
///
EFI_PEI_CPU_IO_PPI_ACCESS Mem; ///< Collection of memory-access services.
EFI_PEI_CPU_IO_PPI_ACCESS Io; ///< Collection of I/O-access services.
EFI_PEI_CPU_IO_PPI_IO_READ8 IoRead8;
///
/// 16-bit I/O read service.
///
EFI_PEI_CPU_IO_PPI_IO_READ16 IoRead16;
///
/// 32-bit I/O read service.
///
EFI_PEI_CPU_IO_PPI_IO_READ32 IoRead32;
///
/// 64-bit I/O read service.
///
EFI_PEI_CPU_IO_PPI_IO_READ64 IoRead64;
///
/// 8-bit I/O write service.
///
EFI_PEI_CPU_IO_PPI_IO_WRITE8 IoWrite8;
///
/// 16-bit I/O write service.
///
EFI_PEI_CPU_IO_PPI_IO_WRITE16 IoWrite16;
///
/// 32-bit I/O write service.
///
EFI_PEI_CPU_IO_PPI_IO_WRITE32 IoWrite32;
///
/// 64-bit I/O write service.
///
EFI_PEI_CPU_IO_PPI_IO_WRITE64 IoWrite64;
///
/// 8-bit memory read service.
///
EFI_PEI_CPU_IO_PPI_MEM_READ8 MemRead8;
///
/// 16-bit memory read service.
///
EFI_PEI_CPU_IO_PPI_MEM_READ16 MemRead16;
///
/// 32-bit memory read service.
///
EFI_PEI_CPU_IO_PPI_MEM_READ32 MemRead32;
///
/// 64-bit memory read service.
///
EFI_PEI_CPU_IO_PPI_MEM_READ64 MemRead64;
///
/// 8-bit memory write service.
///
EFI_PEI_CPU_IO_PPI_MEM_WRITE8 MemWrite8;
///
/// 16-bit memory write service.
///
EFI_PEI_CPU_IO_PPI_MEM_WRITE16 MemWrite16;
///
/// 32-bit memory write service.
///
EFI_PEI_CPU_IO_PPI_MEM_WRITE32 MemWrite32;
///
/// 64-bit memory write service.
///
EFI_PEI_CPU_IO_PPI_MEM_WRITE64 MemWrite64;
};