FmpDevicePkg/FmpDependencyLib: Correct ValidateDependency() documentation

Modifies the return value documentation to state that the BOOLEAN
value indicates whether a given dependency expression is valid
not a capsule.

Cc: Liming Gao <liming.gao@intel.com>
Cc: Michael D Kinney <michael.d.kinney@intel.com>
Cc: Guomin Jiang <guomin.jiang@intel.com>
Cc: Wei6 Xu <wei6.xu@intel.com>
Signed-off-by: Michael Kubacki <michael.kubacki@microsoft.com>
Reviewed-by: Michael D Kinney <michael.d.kinney@intel.com>
Reviewed-by: Guomin Jiang <guomin.jiang@intel.com>
Reviewed-by: Wei6 Xu <wei6.xu@intel.com>

diff --git a/FmpDevicePkg/Include/Library/FmpDependencyLib.h b/FmpDevicePkg/Include/Library/FmpDependencyLib.h
index 1110eefa9a54b184039594dabfa1a5c2dbdd5b21..c732903425b4c57d9a21ab61797416c6c4090160 100644 (file)
--- a/FmpDevicePkg/Include/Library/FmpDependencyLib.h
+++ b/FmpDevicePkg/Include/Library/FmpDependencyLib.h
@@ -2,6 +2,7 @@
   Fmp Capsule Dependency support functions for Firmware Management Protocol based\r
   firmware updates.\r
 \r
+  Copyright (c) Microsoft Corporation.<BR>\r
   Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>\r
 \r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
@@ -29,8 +30,8 @@ typedef struct {
   @param[in]   MaxDepexSize   Max size of the dependency.\r
   @param[out]  DepexSize      Size of dependency.\r
 \r
-  @retval TRUE    The capsule is valid.\r
-  @retval FALSE   The capsule is invalid.\r
+  @retval TRUE    The dependency expression is valid.\r
+  @retval FALSE   The dependency expression is invalid.\r
 \r
 **/\r
 BOOLEAN\r

diff --git a/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c b/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c
index 91dc0b9abd3363f9622a81aba72379ab17cb8378..28358069950a80c02497611910773eec0244c865 100644 (file)
--- a/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c
+++ b/FmpDevicePkg/Library/FmpDependencyLib/FmpDependencyLib.c
@@ -1,6 +1,7 @@
 /** @file\r
   Supports Fmp Capsule Dependency Expression.\r
 \r
+  Copyright (c) Microsoft Corporation.<BR>\r
   Copyright (c) 2020, Intel Corporation. All rights reserved.<BR>\r
 \r
   SPDX-License-Identifier: BSD-2-Clause-Patent\r
@@ -433,8 +434,8 @@ Error:
   @param[in]   MaxDepexSize   Max size of the dependency.\r
   @param[out]  DepexSize      Size of dependency.\r
 \r
-  @retval TRUE    The capsule is valid.\r
-  @retval FALSE   The capsule is invalid.\r
+  @retval TRUE    The dependency expression is valid.\r
+  @retval FALSE   The dependency expression is invalid.\r
 \r
 **/\r
 BOOLEAN\r