diff options
| author | Hess Chen <hesheng.chen@intel.com> | 2016-04-22 12:50:23 +0800 |
|---|---|---|
| committer | Yonghong Zhu <yonghong.zhu@intel.com> | 2016-04-26 11:20:59 +0800 |
| commit | f8895c2ad4fe0191732aa376333eaf49649e3760 (patch) | |
| tree | 700749be71d124e90c9896a08900759703c517a3 /BaseTools/Source/Python/Ecc/EccToolError.py | |
| parent | cf6c1550cbf80423a9c058a52f7708db09dd4883 (diff) | |
| download | edk2-f8895c2ad4fe0191732aa376333eaf49649e3760.tar.gz edk2-f8895c2ad4fe0191732aa376333eaf49649e3760.tar.bz2 edk2-f8895c2ad4fe0191732aa376333eaf49649e3760.zip | |
Update ECC to support more doxygen keywords
Contributed-under: TianoCore Contribution Agreement 1.0
Signed-off-by: Hess Chen <hesheng.chen@intel.com>
Reviewed-by: Yonghong Zhu <yonghong.zhu@intel.com>
Diffstat (limited to 'BaseTools/Source/Python/Ecc/EccToolError.py')
| -rw-r--r-- | BaseTools/Source/Python/Ecc/EccToolError.py | 4 |
1 files changed, 2 insertions, 2 deletions
diff --git a/BaseTools/Source/Python/Ecc/EccToolError.py b/BaseTools/Source/Python/Ecc/EccToolError.py index 5c45fdf904..1eae9d1364 100644 --- a/BaseTools/Source/Python/Ecc/EccToolError.py +++ b/BaseTools/Source/Python/Ecc/EccToolError.py @@ -1,7 +1,7 @@ ## @file
# Standardized Error Hanlding infrastructures.
#
-# Copyright (c) 2008 - 2015, Intel Corporation. All rights reserved.<BR>
+# Copyright (c) 2008 - 2016, Intel Corporation. All rights reserved.<BR>
# This program and the accompanying materials
# are licensed and made available under the terms and conditions of the BSD License
# which accompanies this distribution. The full text of the license may be found at
@@ -172,7 +172,7 @@ gEccErrorMessage = { ERROR_DOXYGEN_CHECK_FUNCTION_HEADER : "The function headers should follow Doxygen special documentation blocks in section 2.3.5",
ERROR_DOXYGEN_CHECK_COMMENT_DESCRIPTION : """The first line of text in a comment block should be a brief description of the element being documented and the brief description must end with a period.""",
ERROR_DOXYGEN_CHECK_COMMENT_FORMAT : "For comment line with '///< ... text ...' format, if it is used, it should be after the code section",
- ERROR_DOXYGEN_CHECK_COMMAND : "Only Doxygen commands '@bug', '@todo', '@example', '@file', '@attention', '@param', '@post', '@pre', '@retval', '@return', '@sa', '@since', '@test', '@note', '@par' are allowed to mark the code",
+ ERROR_DOXYGEN_CHECK_COMMAND : "Only Doxygen commands '@bug', '@todo', '@example', '@file', '@attention', '@param', '@post', '@pre', '@retval', '@return', '@sa', '@since', '@test', '@note', '@par', '@endcode', '@code', '@{', '@}' are allowed to mark the code",
ERROR_META_DATA_FILE_CHECK_ALL : "",
ERROR_META_DATA_FILE_CHECK_PATH_NAME : "The file defined in meta-data does not exist",
|