From 0c2af1d742e8957559b257d253a585c3200bd5cc Mon Sep 17 00:00:00 2001
From: Eao3piq4e <eao3piq4e@forge.com>
Date: Tue, 2 Aug 2022 11:50:12 +0800
Subject: [PATCH] Update bbox_lib.cpp

---
 src/gausskernel/cbb/bbox/bbox_lib.cpp | 54 +++++++++++++++++++++------
 1 file changed, 42 insertions(+), 12 deletions(-)

diff --git a/src/gausskernel/cbb/bbox/bbox_lib.cpp b/src/gausskernel/cbb/bbox/bbox_lib.cpp
index 115af905..24050664 100644
--- a/src/gausskernel/cbb/bbox/bbox_lib.cpp
+++ b/src/gausskernel/cbb/bbox/bbox_lib.cpp
@@ -52,14 +52,17 @@ static struct PIPE_IDS astPipeIds[BBOX_MAX_PIDS];
 
 /*
 function name: bbox_strncmp
-description: compare two strings, the pointer pszSrc and pszTarget store their addresses.
+description: To compare two substrings, the pointers pszSrc and pszTarget store their host strings'addresses.
 arguments: Two pointers of type const char*, pointing to two strings needed to be compared.
-return value: s32, an interger.
-					 If it's zero, then string pszSrc and pszTarget are same,
-                     else it indicates the position of the first character that
-                     these two strings can't match.
-note：The two pointers shouldn't be null.
+				   An integer indicates the number of characters at the former of two strings that  
+                   will be compared.
+return value: Type s32, an interger.
+					 If it's zero, then the former substrings of string pszSrc and pszTarget are same,
+                     else it indicates the difference between the first two characters that these two 
+                     strings can't match.
+note：The two pointers shouldn't be null. The last argument shouldn't less than zero.
 date: 2022/8/2
+contact tel: 18720816902
 */
 s32 bbox_strncmp(const char* pszSrc, const char* pszTarget, s32 count)
 {
@@ -76,8 +79,20 @@ s32 bbox_strncmp(const char* pszSrc, const char* pszTarget, s32 count)
 }
 
 /*
- * compare string pszSrc and pszTarget
- */
+function name: bbox_strcmp
+description: compare two strings, the pointer pszSrc and pszTarget store their addresses.
+arguments: Two pointers of type const char*, pointing to two strings needed to be compared.
+				   An integer indicates the number of characters at the former of two strings that  
+                   will be compared.
+return value: Type s32, an interger.
+					 If it's zero, then the former substrings of string pszSrc and pszTarget are same,
+                     else if it's 1, then it indicates between first two characters that these two 
+                     strings can't match, the character of first string that pszSrc points is greater,
+                     else if it's -1, the character of second string that pszTarget points is greater.
+note：The two pointers shouldn't be null. The last argument shouldn't less than zero.
+date: 2022/8/2
+contact tel:same
+*/
 s32 bbox_strcmp(const char* pszSrc, const char* pszTarget)
 {
     unsigned char c1, c2;
@@ -98,8 +113,15 @@ s32 bbox_strcmp(const char* pszSrc, const char* pszTarget)
 }
 
 /*
- * get the length of string pszString
- */
+function name: bbox_strlen
+description: Calculate the length of string.
+arguments: An pointer that indicates the address of a string.
+return value: Type s32, an integer indicating the length of string.
+note: the length of string=(address of the last character not '\0'-address of the first character)/sizeof(char), and sizeof(char) 
+		 equals to 1, so the length of string=(address of the last character not '\0'-address of the first character).
+date: 2022/8/2
+contact tel:same
+*/
 s32 bbox_strlen(const char* pszString)
 {
     const char* pszTemp = NULL;
@@ -113,8 +135,16 @@ s32 bbox_strlen(const char* pszString)
 }
 
 /*
- * get the length of string pszString
- */
+function name: bbox_strnlen
+description: Calculate the length of string, but having some restrictive conditions.
+arguments: An pointer that indicates the address of a string.
+				   And an integer that indicates the maxlenth.
+return value: Type s32, an integer indicating the length of string.
+note: If the length of string exceed the argument count, then return the length of string,
+		 else return the argument count.
+date: 2022/8/2
+contact tel:same
+*/
 s32 bbox_strnlen(const char* pszString, s32 count)
 {
     const char* pszTemp = NULL;