ShellPkg: Add comment that ItemPtr is set after validation

Add a comment to clarify that in Acpiview the ItemPtr is not set until
after the FieldValidator has been called.

Signed-off-by: Chris Jones <christopher.jones@arm.com>
Reviewed-by: Sami Mujawar <sami.mujawar@arm.com>
Reviewed-by: Zhichao Gao <zhichao.gao@intel.com>

diff --git a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
index 0b7726b9d5807ad2f5c5447408c4c5451718938b..5e34a70c8baeaaa05ecd797d405f1fc62a44a305 100644 (file)
--- a/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
+++ b/ShellPkg/Library/UefiShellAcpiViewCommandLib/AcpiParser.h
@@ -283,7 +283,9 @@ typedef struct AcpiParser {
   FNPTR_PRINT_FORMATTER PrintFormatter;\r
 \r
   /// Optional pointer which may be set to request the parser to update\r
-  /// a pointer to the field data. If unused this must be set to NULL.\r
+  /// a pointer to the field data. This value is set after the FieldValidator\r
+  /// has been called and therefore should not be used by the FieldValidator.\r
+  /// If unused this must be set to NULL.\r
   VOID**                ItemPtr;\r
 \r
   /// Optional pointer to a field validator function.\r