summaryrefslogtreecommitdiffstats
path: root/MdeModulePkg/Core/Pei/PeiMain.h
diff options
context:
space:
mode:
authorMichael Kubacki <michael.a.kubacki@intel.com>2019-11-20 17:31:24 -0800
committermergify[bot] <37929162+mergify[bot]@users.noreply.github.com>2019-12-11 07:00:10 +0000
commitd3add11e87dace180387562d6f1951f2bffbd3d9 (patch)
treec0cef93e404391d0d66a99f916f1a5a399b370ea /MdeModulePkg/Core/Pei/PeiMain.h
parentd39d1260c615b716675f67f5c4e1f4f52df01dad (diff)
downloadedk2-d3add11e87dace180387562d6f1951f2bffbd3d9.tar.gz
edk2-d3add11e87dace180387562d6f1951f2bffbd3d9.tar.bz2
edk2-d3add11e87dace180387562d6f1951f2bffbd3d9.zip
MdeModulePkg PeiCore: Improve comment semantics
This patch clarifies wording in several PeiCore comments to improve reading comprehension. Cc: Dandan Bi <dandan.bi@intel.com> Cc: Liming Gao <liming.gao@intel.com> Cc: Jian J Wang <jian.j.wang@intel.com> Cc: Hao A Wu <hao.a.wu@intel.com> Signed-off-by: Michael Kubacki <michael.a.kubacki@intel.com> Reviewed-by: Liming Gao <liming.gao@intel.com> Reviewed-by: Jian J Wang <jian.j.wang@intel.com>
Diffstat (limited to 'MdeModulePkg/Core/Pei/PeiMain.h')
-rw-r--r--MdeModulePkg/Core/Pei/PeiMain.h11
1 files changed, 6 insertions, 5 deletions
diff --git a/MdeModulePkg/Core/Pei/PeiMain.h b/MdeModulePkg/Core/Pei/PeiMain.h
index 3f61247a0f..6431bdaaac 100644
--- a/MdeModulePkg/Core/Pei/PeiMain.h
+++ b/MdeModulePkg/Core/Pei/PeiMain.h
@@ -1217,8 +1217,8 @@ PeiFfsGetVolumeInfo (
);
/**
- This routine enable a PEIM to register itself to shadow when PEI Foundation
- discovery permanent memory.
+ This routine enables a PEIM to register itself for shadow when the PEI Foundation
+ discovers permanent memory.
@param FileHandle File handle of a PEIM.
@@ -1314,12 +1314,13 @@ ProcessFvFile (
);
/**
- Get instance of PEI_CORE_FV_HANDLE for next volume according to given index.
+ Gets a PEI_CORE_FV_HANDLE instance for the next volume according to the given index.
- This routine also will install FvInfo PPI for FV HOB in PI ways.
+ This routine also will install an instance of the FvInfo PPI for the FV HOB
+ as defined in the PI specification.
@param Private Pointer of PEI_CORE_INSTANCE
- @param Instance The index of FV want to be searched.
+ @param Instance Index of the FV to search
@return Instance of PEI_CORE_FV_HANDLE.
**/