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>
This commit is contained in:
Michael Kubacki 2020-08-06 12:05:36 -07:00 committed by mergify[bot]
parent bfe36cb4ef
commit ef0460b852
2 changed files with 6 additions and 4 deletions

View File

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

View File

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