Added doxygen comments
[people/mcb30/basetools.git] / Source / Python / Workspace / MetaDataTable.py
index 8ded75e..f2f83a6 100644 (file)
@@ -20,6 +20,7 @@ import Common.EdkLogger as EdkLogger
 from CommonDataClass import DataClass\r
 from CommonDataClass.DataClass import FileClass\r
 \r
+## Convert to SQL required string format\r
 def ConvertToSqlString(StringList):\r
     return map(lambda s: "'" + s.replace("'", "''") + "'", StringList)\r
 \r
@@ -209,6 +210,12 @@ class TableFile(Table):
             TimeStamp\r
             )\r
 \r
+    ## Get ID of a given file\r
+    #\r
+    #   @param  FilePath    Path of file\r
+    # \r
+    #   @retval ID          ID value of given file in the table\r
+    # \r
     def GetFileId(self, FilePath):\r
         QueryScript = "select ID from %s where FullPath = '%s'" % (self.Table, FilePath)\r
         RecordList = self.Exec(QueryScript)\r
@@ -216,6 +223,12 @@ class TableFile(Table):
             return None\r
         return RecordList[0][0]\r
 \r
+    ## Get type of a given file\r
+    #\r
+    #   @param  FileId      ID of a file\r
+    # \r
+    #   @retval file_type   Model value of given file in the table\r
+    # \r
     def GetFileType(self, FileId):\r
         QueryScript = "select Model from %s where ID = '%s'" % (self.Table, FileId)\r
         RecordList = self.Exec(QueryScript)\r
@@ -223,6 +236,12 @@ class TableFile(Table):
             return None\r
         return RecordList[0][0]\r
 \r
+    ## Get file timestamp of a given file\r
+    #\r
+    #   @param  FileId      ID of file\r
+    # \r
+    #   @retval timestamp   TimeStamp value of given file in the table\r
+    # \r
     def GetFileTimeStamp(self, FileId):\r
         QueryScript = "select TimeStamp from %s where ID = '%s'" % (self.Table, FileId)\r
         RecordList = self.Exec(QueryScript)\r
@@ -230,9 +249,20 @@ class TableFile(Table):
             return None\r
         return RecordList[0][0]\r
 \r
+    ## Update the timestamp of a given file\r
+    #\r
+    #   @param  FileId      ID of file\r
+    #   @param  TimeStamp   Time stamp of file\r
+    # \r
     def SetFileTimeStamp(self, FileId, TimeStamp):\r
         self.Exec("update %s set TimeStamp=%s where ID='%s'" % (self.Table, TimeStamp, FileId))\r
 \r
+    ## Get list of file with given type\r
+    #\r
+    #   @param  FileType    Type value of file\r
+    # \r
+    #   @retval file_list   List of files with the given type\r
+    # \r
     def GetFileList(self, FileType):\r
         RecordList = self.Exec("select FullPath from %s where Model=%s" % (self.Table, FileType))\r
         if len(RecordList) == 0:\r